ListInstancesByNcd-阿里云帮助中心

Queries the GPU node list of a specified GPU node whose communication distance does not exceed the specified NCD.

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

eflo:ListInstancesByNcd

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-wulanchabu
InstanceId	string	Yes	The instance ID.	lni-1234****
InstanceType	string	Yes	The parameter that specifies the instance type. Valid value: node: Lingjun node. lni: lingjun network interface controller. Valid values: node : lni :	lni
MaxNcd	integer	Yes	Maximum network communication distance	2

Response elements

Element	Type	Description	Example
	object	AjaxResult
Code	integer	The response status code.	0
Message	string	The returned message.	成功
RequestId	string	Request ID of the current request	AC8C713A-A9F4-5984-A5E1-76496DF35153
Content	object	The response parameters.
MaxNcd	integer	Maximum communication distance between nodes	3
InstanceType	string	Instance Type Valid value: node: Lingjun node. lni: lingjun network interface controller. Valid values: node : lni :	lni
SourceInstanceId	string	The ID of the source instance.	lni-1234****
InstanceInfos	array<object>	A collection of instances whose network communication distance from the source instance ID does not exceed maxNcd
	object	The information about the savings plan.
InstanceId	string	The instance ID.	lni-1235****
Ncd	integer	network communication distance	2
AccessDeniedDetail	string	The details about the access denial.	None

Examples

Success response

JSON format

{
  "Code": 0,
  "Message": "成功",
  "RequestId": "AC8C713A-A9F4-5984-A5E1-76496DF35153",
  "Content": {
    "MaxNcd": 3,
    "InstanceType": "lni",
    "SourceInstanceId": "lni-1234****",
    "InstanceInfos": [
      {
        "InstanceId": "lni-1235****",
        "Ncd": 2
      }
    ]
  },
  "AccessDeniedDetail": "None"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.