UnlinkLlmClusters

Applicability

Product	Supported (√/x)
Atlas 350 Accelerator Card	x
Atlas A3 training product/Atlas A3 inference product	√
Atlas A2 training product/Atlas A2 inference product	√
Atlas 200I/500 A2 inference product	x
Atlas inference product	x
Atlas training product	x

Note: For Atlas A2 training product/Atlas A2 inference product, only the Atlas 800I A2 inference server and A200I A2 Box heterogeneous subrack are supported.

Function Description

Disconnects a link between LLM-DataDist clusters.

Prototype

Status UnlinkLlmClusters(const std::vector<ClusterInfo> &clusters, std::vector<Status> &rets, int32_t timeout_in_millis = 1000, bool force_flag = false)

Parameters

Parameter	Input/Output	Description
clusters	Input	Information about the clusters whose links are to be disconnected. The type is ClusterInfo.
rets	Output	Link disconnection result of each cluster.
timeout_in_millis	Input	Link disconnection timeout interval, in milliseconds.
force_flag	Input	Indicates whether to perform forcible disconnection. By default, this feature is disabled. For forcible link disconnection, only the local link is forcibly disconnected; therefore, this API must be called on both ends. Non-forcible link disconnection is initiated by the client. If no link fault occurs, the link is disconnected on both ends. However, if a link fault occurs, forcible link disconnection must be initiated on the server, which is time-consuming.

Example

Click Gitee, download the sample package of the matching version based on the tag name, and obtain the sample from the cplusplus/level1_single_api/11_llm_data_dist directory.

Returns

SUCCESS: A success message is returned only when links are successfully disconnected for all clusters.
Other values: Link disconnection fails. Check the link disconnection result of each cluster in rets.

Exception Handling

LLM_UNLINK_FAILED: Link disconnection fails.

Restrictions

Before calling this API, call the Initialize API to complete initialization.

Parent topic: LLM-DataDist APIs