ListResourceInstanceWorker - Platform For AI - Alibaba Cloud Documentation Center

Queries a list of workers in a resource group.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
eas:ListResourceInstanceWorker	get	*Resource `acs:eas:{#regionId}:{#accountId}:resource/{#ResourceId}`	none	none

Request syntax

GET /api/v2/resources/{ClusterId}/{ResourceId}/instance/{InstanceName}/workers HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The ID of the cluster to which the resource group belongs.	cn-shanghai
ResourceId	string	Yes	The ID of the resource group. For more information about how to query the ID of a resource group, see ListResources .	eas-r-adfabas
InstanceName	string	Yes	The name of the instance in a resource group. For more information about how to query the instance name, see ListResourceInstances .	cne10
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 100.	20

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	40325405-579C-4D82****
Pods	array	The workers.
	ResourceInstanceWorker	The information about the worker.
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	20
TotalCount	integer	The total number of entries returned.	1

Examples

Sample success responses

JSONformat

{
  "RequestId": "40325405-579C-4D82****",
  "Pods": [
    {
      "Name": "test-india-5bbbfdbc98-****",
      "ServiceName": "test-in****",
      "Status": "Running",
      "Ready": true,
      "CpuRequest": 1,
      "GpuRequest": 0,
      "MemoryRquest": 200,
      "CpuLimit": 2,
      "GpuLimit": 0,
      "MemoryLimit": 400,
      "RestartCount": 3,
      "StartTime": "2021-05-09T09:56:19Z"
    }
  ],
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 1
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-01-04	The internal configuration of the API is changed, but the call is not affected	View Change Details