调用ListExecutors API查询全局Executor信息-弹性高性能计算-阿里云

查询全局Executor信息

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ehpc:ListExecutors

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
Filter	object	否	查询 Executor 过滤条件。
JobName	string	否	作业名称，支持模糊查询。	testJob
ExecutorIds	array	否	Executor ID 列表，最大支持 100 条。
	string	否	Executor ID。格式为 JobId-TaskName-ArrayIndex。	job-xxxx-task0-1
IpAddresses	array	否	内网 IP 地址列表，最大支持 100 条。
	string	否	内网 IP 地址。	192.168.0.1
Status	array	否	Executor 状态列表。
	string	否	Executor 状态。取值范围： Pending：排队中 Initing：初始化中 Succeeded：运行成功 Failed：运行失败 Running：运行中 Exception：调度异常 Retrying：重试中 Expired：超时 Suspended：作业休眠 Restarting：作业重启中 Deleted：删除完成枚举值： 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	否	在此时间之前提交的作业，以所在地域的时间转化为（国内站为东八区）Unix 时间戳。	1703820113
TimeCreatedAfter	integer	否	在此时间之后提交的作业，以所在地域的时间转化为（国内站为东八区）Unix 时间戳。	1703819914
VswitchId	string	否	交换机 ID。	vsw-xxx
Image	string	否	Executor 镜像。	m-f8z0dfa96luxxxxx
VpcId	string	否	专有网络 ID。	vpc-xxx
PageSize	integer	否	分页查询时设置的本页条数。默认 50，最大 100。	50
PageNumber	integer	否	当前页码。起始值：1 默认值：1	1

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	896D338C-E4F4-41EC-A154-D605E5DE****
PageSize	integer	分页查询时设置的本页条数。	50
PageNumber	integer	当前页码。	1
TotalCount	string	列表条目总数。	40
Executors	array<object>	Executor 列表。
	array<object>	Executor 属性。
ExecutorId	string	Executor ID。格式为 JobId-TaskName-ArrayIndex。	job-xxxx-Task0-1
JobId	string	作业 ID。	job-hy1nggvyukuvkr******
JobName	string	作业名称。	testJob
TaskName	string	任务名称。	Task0
ArrayIndex	integer	Executor 编号。	0
IpAddress	array	内网 IP 地址列表。
	string	内网 IP 地址。	192.168.0.1
ExternalIpAddress	array	节点公网 IP 地址列表。
	string	节点公网 IP 地址列表。	116.62.100.6
HostName	array	主机名列表。
	string	主机名。	testJob-0
Image	string	Executor 镜像。	m-f8z0dfa96luxxxxx
CreateTime	string	创建时间。	2024-02-20 10:04:10
ExpirationTime	string	过期时间。
StartTime	string	开始时间。	2024-02-20 10:04:13
EndTime	string	结束时间。	2024-02-20 10:04:18
Status	string	Executor 状态。可能值： Pending：排队中 Initing：初始化中 Succeeded：运行成功 Failed：运行失败 Running：运行中 Exception：调度异常 Retrying：重试中 Expired：运行超时 Suspended：作业休眠 Restarting：作业重启中 Deleted：删除完成	Running
StatusReason	string	状态原因描述。	ExecutorReady
Resource	object	资源信息。
Cores	number	运行的 CPU 个数。	1
Memory	number	内存资源总量。单位：GiB。	4
Disks	array<object>	云盘数组。
	object	云盘属性。
Type	string	云盘类型。支持以下类型： System：系统盘。 Data：数据盘。	System
Size	integer	云盘大小。	10
InstanceType	string	运行环境的实例规格。	ecs.c7a.8xlarge
VswitchId	string	交换机 ID。	vsw-xxx
ResourceType	string	资源类型。	ECI
TaskSustainable	boolean	是否是长时间运行的作业。	true
Tags	array<object>	Executor 标签列表。
	object	Executor 标签列表。
TagKey	string	Executor 标签键。	TestKey
TagValue	string	Executor 标签值。	TestValue
AppName	string	应用名称。	Alphafold3
BlockDuration	integer	计算资源保留时长。	24
Preemptible	boolean
AllocationSpec	string	资源类型。 Standard：标准型。 Dedicated：专属型，需开通白名单使用。 Economic：经济型，需开通白名单使用。	Standard
VpcId	string	专有网络 ID。	vpc-xxx

示例

正常返回示例

JSON格式

{
  "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": true,
      "AllocationSpec": "Standard",
      "VpcId": "vpc-xxx"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParams	The specified parameter %s is invalid.	无效的参数：%s
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.	请求失败，服务暂时不可用
406	DbError	A database error occurred.	数据库错误

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。