ListResourceInstanceWorker - Platform For AI - Alibaba Cloud Documentation Center

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

eas:ListResourceInstanceWorker

get

*Resource

acs:eas:{#regionId}:{#accountId}:resource/{#ResourceId}

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The ID of the cluster where the resource group is located.	cn-shanghai
ResourceId	string	Yes	The ID of the resource group. For more information, see ListResources.	eas-r-adfabas
InstanceName	string	Yes	The name of the instance in the resource group. For more information, see ListResourceInstances. The instance name is the value of the HostName parameter in the response.	cne10

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number. The value starts from 1. The default value is 1.	1
PageSize	integer	No	The number of entries to return on each page. The default value is 100.	20
WorkerName	string	No	The name of the worker instance.	test-fd95xxxxx-xxxxxx
Status	string	No	The status of the worker instance. Valid values: Terminating : Terminating Stopped : Stopped Failed : Failed Running : Running Waiting : Waiting	Running
Order	string	No	The sort order. Asc: ascending order. Desc: descending order. Valid values: Asc : Asc Desc : Desc	Desc
Sort	string	No	The field to sort by. Valid values: Status : Status MemoryLimit : MemoryLimit Ready : Ready CpuLimit : CpuLimit ServiceName : ServiceName Restarts : Restarts StartTime : StartTime MemoryRequest : MemoryRequest GpuLimit : GpuLimit GpuRequest : GpuRequest CpuRequest : CpuRequest Name : Name	CreateTime
ServiceName	string	No	The service name.	echo
Ready	boolean	No	Indicates whether the health check passed. Valid values: true : true false : false	true

Response elements

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

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.