ListExecutors-阿里云帮助中心

Queries information about global executors.

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

ehpc:ListExecutors

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Filter	object	No	The filter conditions for querying executors.
JobName	string	No	The job name. Fuzzy queries are supported.	testJob
ExecutorIds	array	No	A list of executor IDs. You can specify up to 100 IDs.
	string	No	The executor ID. The format is JobId-TaskName-ArrayIndex.	job-xxxx-task0-1
IpAddresses	array	No	A list of private IP addresses. You can specify up to 100 IP addresses.
	string	No	The private IP address.	192.168.0.1
Status	array	No	A list of executor statuses.
	string	No	The status of the executor. Valid values: Pending: The executor is waiting in a queue. Initing: The executor is being initialized. Succeeded: The executor ran successfully. Failed: The executor failed to run. Running: The executor is running. Exception: A scheduling error occurred. Retrying: The system is retrying the executor. Expired: The executor timed out. Suspended: The job is in hibernation. Restarting: The job is restarting. Deleted: The executor is deleted. Valid values: Succeeded : Succeeded Restarting : Restarting Failed : Failed Running : Running Expired : Expired Initing : Initing Deleted : Deleted Retrying : Retrying Suspended : Suspended Pending : Pending Deleting : Deleting Exception : Exception	Running
TimeCreatedBefore	integer	No	The jobs submitted before this time. This is a UNIX timestamp that is converted from the time in the region where the job is located. For sites in mainland China, the time is in the UTC+8 time zone.	1703820113
TimeCreatedAfter	integer	No	The jobs submitted after this time. This is a UNIX timestamp that is converted from the time in the region where the job is located. For sites in mainland China, the time is in the UTC+8 time zone.	1703819914
VswitchId	string	No	The vSwitch ID.	vsw-xxx
Image	string	No	The executor image.	m-f8z0dfa96luxxxxx
VpcId	string	No	The virtual private cloud (VPC) ID.	vpc-xxx
PageSize	integer	No	The number of entries to return on each page for a paged query. Default value: 50. Maximum value: 100.	50
PageNumber	integer	No	The current page number. Start value: 1 Default value: 1	1

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	896D338C-E4F4-41EC-A154-D605E5DE****
PageSize	integer	The number of entries returned per page.	50
PageNumber	integer	The current page number.	1
TotalCount	string	The total number of entries in the list.	40
Executors	array<object>	The list of executors.
	array<object>	The properties of the executor.
ExecutorId	string	The executor ID. The format is JobId-TaskName-ArrayIndex.	job-xxxx-Task0-1
JobId	string	The job ID.	job-hy1nggvyukuvkr******
JobName	string	The job name.	testJob
TaskName	string	The task name.	Task0
ArrayIndex	integer	The executor number.	0
IpAddress	array	A list of private IP addresses.
	string	The private IP address.	192.168.0.1
ExternalIpAddress	array	A list of public IP addresses of the node.
	string	The list of public IP addresses for the node.	116.62.100.6
HostName	array	A list of hostnames.
	string	The hostname.	testJob-0
Image	string	The executor image.	m-f8z0dfa96luxxxxx
CreateTime	string	The creation time.	2024-02-20 10:04:10
ExpirationTime	string	The expiration time.
StartTime	string	The start time.	2024-02-20 10:04:13
EndTime	string	The end time.	2024-02-20 10:04:18
Status	string	The status of the executor. Possible values: Pending: The executor is waiting in a queue. Initing: The executor is being initialized. Succeeded: The executor ran successfully. Failed: The executor failed to run. Running: The executor is running. Exception: A scheduling error occurred. Retrying: The system is retrying the executor. Expired: The executor timed out. Suspended: The job is in hibernation. Restarting: The job is restarting. Deleted: The executor is deleted.	Running
StatusReason	string	The description of the status reason.	ExecutorReady
Resource	object	The resource information.
Cores	number	The number of CPU cores.	1
Memory	number	The total amount of memory resources. Unit: GiB.	4
Disks	array<object>	An array of cloud disks.
	object	The properties of the cloud disk.
Type	string	The type of the cloud disk. The following types are supported: System: The system disk. Data: The data disk.	System
Size	integer	The size of the cloud disk.	10
InstanceType	string	The instance type of the runtime environment.	ecs.c7a.8xlarge
VswitchId	string	The vSwitch ID.	vsw-xxx
ResourceType	string	The resource type.	ECI
TaskSustainable	boolean	Indicates whether the job is a long-running job.	true
Tags	array<object>	A list of executor tags.
	object	A list of executor tags.
TagKey	string	The tag key of the executor.	TestKey
TagValue	string	The tag value of the executor.	TestValue
AppName	string	The application name.	Alphafold3
BlockDuration	integer	The duration for which the compute resources are reserved.	24
Preemptible	boolean
AllocationSpec	string	The resource type. Standard: Standard. Dedicated: Dedicated. This type requires whitelisting. Economic: Economy. This type requires whitelisting.	Standard
VpcId	string	The virtual private cloud (VPC) ID.	vpc-xxx

Examples

Success response

JSON format

{
  "RequestId": "896D338C-E4F4-41EC-A154-D605E5DE****",
  "PageSize": 50,
  "PageNumber": 1,
  "TotalCount": "40",
  "Executors": [
    {
      "ExecutorId": "job-xxxx-Task0-1",
      "JobId": "job-hy1nggvyukuvkr******",
      "JobName": "testJob",
      "TaskName": "Task0",
      "ArrayIndex": 0,
      "IpAddress": [
        "192.168.0.1"
      ],
      "ExternalIpAddress": [
        "116.62.100.6\n"
      ],
      "HostName": [
        "testJob-0"
      ],
      "Image": "m-f8z0dfa96luxxxxx",
      "CreateTime": "2024-02-20 10:04:10",
      "ExpirationTime": "",
      "StartTime": "2024-02-20 10:04:13",
      "EndTime": "2024-02-20 10:04:18",
      "Status": "Running",
      "StatusReason": "ExecutorReady",
      "Resource": {
        "Cores": 1,
        "Memory": 4,
        "Disks": [
          {
            "Type": "System",
            "Size": 10
          }
        ],
        "InstanceType": "ecs.c7a.8xlarge"
      },
      "VswitchId": "vsw-xxx",
      "ResourceType": "ECI",
      "TaskSustainable": true,
      "Tags": [
        {
          "TagKey": "TestKey\n",
          "TagValue": "TestValue"
        }
      ],
      "AppName": "Alphafold3",
      "BlockDuration": 24,
      "Preemptible": false,
      "AllocationSpec": "Standard",
      "VpcId": "vpc-xxx"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParams	The specified parameter %s is invalid.	The specified parameter %s is invalid.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.	The request has failed due to a temporary failure of the server.
406	DbError	A database error occurred.	A database error occurred.

See for a complete list.

Release notes

See Release Notes for a complete list.