GetGpuClusterArgsOptions - Alibaba Cloud Linux - Alibaba Cloud Documentation Center

Operation description

After you install the component for the target ACK cluster:

When the cluster is managed for the first time, the component is installed on all ECS instances currently in the cluster. If the cluster has more than 50 nodes, only 50 nodes are installed in the first batch.
The operating system console periodically checks the scaling status of the managed cluster. When a new ECS instance is added to the cluster, the operating system console automatically installs the component on the instance without user intervention.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

sysom:GetGpuClusterArgsOptions

get

*All Resource

*

None

Request syntax

GET /api/v1/aiTopology/topology/listClusterTopologyOptions HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
filterType	string	Yes	Query cluster machine list scenario: Set the retrieval type to comm_instance_id_list or instance_id_list. comm_instance_id_list: Retrieves only the list of machines in the specified cluster that participate in collective communication. instance_id_list: Retrieves the list of all machines in the specified cluster. Query cluster AI task list scenario: Set the retrieval type to comm_task_id_list or task_id_list. comm_task_id_list: Retrieves only the list of tasks in the specified cluster that involve collective communication. task_id_list: Retrieves the list of all tasks in the specified cluster. Query cluster AI job pod list scenario: Set the retrieval type to comm_pod_list or pod_list. comm_pod_list: Retrieves only the list of pods in the specified cluster that participate in collective communication. pod_list: Retrieves the list of all pods in the specified cluster. Query collective communication topology scenario: communication: Retrieves all communication group IDs. channel: Retrieves the channel list under the specified communication group ID. topoType: Retrieves the topology type under the specified channel of the specified communication group ID.	instance_id_list
filterValues	any	No	The filter conditions, which is a JSON object. The cluster_id field is required. Other filter conditions support the following values: instance_id_list comm_instance_id_list pod_list comm_pod_list communication task_id_list comm_task_id_list channel topoType	{ "cluster_id": "cluster1" }

Response elements

Element	Type	Description	Example
	object	Schema of Response
code	string	The response code, which is Success or Sysom.ServerError.	Success Fail
data	any	The result of the parameter retrieval.	["instance1", "instance2"]
message	string	The error message returned when the code is not Success.	some error msg while fail，“” if success
requestId	string	Id of the request	return real request id
total	integer	The total number of returned items.	10

Examples

Success response

JSON format

{
  "code": "Success  Fail",
  "data": "[\"instance1\", \"instance2\"]",
  "message": "some error msg while fail，“” if success",
  "requestId": "return real request id",
  "total": 10
}

Error codes

HTTP status code	Error code	Error message	Description
400	Sysom.ServerError	Server error, please correct the code according to the error message. %s.	Server error, please correct the code according to the error message

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.