ListExecutors - 查询全局Executor信息

查询全局Executor信息

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
Filterobject

查询 Executor 过滤条件。

JobNamestring

作业名称。精确过滤,不支持模糊查询。

testJob
ExecutorIdsarray

Executor ID 列表,最大支持 100 条。

string

Executor ID。格式为 JobId-TaskName-ArrayIndex。

job-xxxx-task0-1
IpAddressesarray

内网 IP 地址列表,最大支持 100 条。

string

内网 IP 地址。

192.168.0.1
Statusarray

Executor 状态列表。

string

Executor 状态。取值范围:

  • Pending:排队中
  • Initing:初始化中
  • Succeed:运行成功
  • Failed:运行失败
  • Running:运行中
  • Exception:调度异常
  • Retrying:重试中
  • Expired:超时
  • Deleted:删除完成
Running
TimeCreatedBeforeinteger

在此时间之前提交的作业,以所在地域的时间转化为(国内站为东八区)Unix 时间戳。

1703820113
TimeCreatedAfterinteger

在此时间之后提交的作业,以所在地域的时间转化为(国内站为东八区)Unix 时间戳。

1703819914
VswitchIdstring

交换机 ID。

vsw-xxx
Imagestring

Executor 镜像。

m-f8z0dfa96luxxxxx
PageSizeinteger

分页查询时设置的本页条数。 默认 50,最大 100。

50
PageNumberinteger

当前页码。
起始值:1
默认值:1

1

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

896D338C-E4F4-41EC-A154-D605E5DE****
PageSizeinteger

分页查询时设置的本页条数。

50
PageNumberinteger

当前页码。

1
TotalCountstring

列表条目总数。

40
Executorsarray<object>

Executor 列表。

Executorobject

Executor 属性。

ExecutorIdstring

Executor ID。格式为 JobId-TaskName-ArrayIndex。

job-xxxx-task0-1
JobIdstring

作业 ID。

job-hy1nggvyukuvkr******
JobNamestring

作业名称。

testJob
TaskNamestring

任务名称。

task0
ArrayIndexinteger

Executor 编号。

0
IpAddressarray

内网 IP 地址列表。

IpAddressstring

内网 IP 地址。

192.168.0.1
ExternalIpAddressarray

节点公网 IP 地址列表。

EipAddressstring

节点公网 IP 地址列表。

116.62.100.6
HostNamearray

主机名列表。

HostNamestring

主机名。

testJob-0
Imagestring

Executor 镜像。

m-f8z0dfa96luxxxxx
CreateTimestring

创建时间。

2024-02-20 10:04:10
StartTimestring

开始时间。

2024-02-20 10:04:13
EndTimestring

结束时间。

2024-02-20 10:04:18
Statusstring

Executor 状态。可能值:

  • Pending:排队中
  • Initing:初始化中
  • Succeed:运行成功
  • Failed:运行失败
  • Running:运行中
  • Unknown:状态未知
  • Exception:调度异常
  • Retrying:重试中
  • Expired:运行超时
  • Deleted:删除完成
Running
StatusReasonstring

状态原因描述。

Succeeded to release executor resource
Resourceobject

资源信息。

Coresfloat

运行的 CPU 个数。

1
Memoryfloat

内存资源总量。单位:GiB。

4
Disksarray<object>

云盘数组。

Disksobject
Typestring

云盘类型。支持以下类型:

  • System:系统盘。
  • Data:数据盘。
System
Sizeinteger

云盘大小。

10
VswitchIdstring

交换机 ID。

vsw-xxx
ResourceTypestring

资源类型。

ECI
TaskSustainableboolean

是否是长时间运行的作业。

true
Tagsarray<object>

Executor 标签列表。

Tagobject

Executor 标签列表。

TagKeystring

Executor 标签键。

TestKey
TagValuestring

Executor 标签值。

TestValue

示例

正常返回示例

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": "Succeeded to release executor resource",
      "Resource": {
        "Cores": 1,
        "Memory": 4,
        "Disks": [
          {
            "Type": "System",
            "Size": 10
          }
        ],
        "InstanceType": ""
      },
      "VswitchId": "vsw-xxx",
      "ResourceType": "ECI",
      "TaskSustainable": true,
      "Tags": [
        {
          "TagKey": "TestKey\n",
          "TagValue": "TestValue"
        }
      ],
      "AppName": "",
      "BlockDuration": 0,
      "Preemptible": true
    }
  ]
}

错误码

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

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

变更历史

变更时间变更内容概要操作
2024-12-30OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2024-11-11OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2024-09-19OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2024-08-14OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情