ListJobExecutors - 查询作业Executor信息

查询作业Executor信息。

接口说明

查询作业 Executor 信息。

调试

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

授权信息

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

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

请求参数

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

作业 ID。

job-xxx
TaskNamestring

作业名称。

task0
PageSizeinteger

每页显示条数。

10
PageNumberinteger

分页查询的页码。

1

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

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

作业 ID。

job-xxxx
TaskNamestring

作业名称。

task0
PageSizeinteger

每页条数。

10
PageNumberinteger

当前页码。

1
TotalCountstring

列表条目总数。

50
Executorsarray<object>

Executor 列表。

Executorobject

Executor 属性。

ExecutorIdstring

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

job-xxxx-Task0-1
ArrayIndexinteger

Executor 索引号。

0
IpAddressarray

节点 IP 地址列表。

IpAddressstring

节点 IP 地址。

192.168.10.11
ExternalIpAddressarray

节点公网 IP 地址列表。

EipAddressstring

节点公网 IP 地址。

116.62.100.6
HostNamearray

节点主机名数组。

HostNamestring

主机名。

host0
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

状态原因描述。

Creating executor
Tagsarray<object>

Executor 标签列表。

Tagobject

Executor 标签列表。

TagKeystring

Executor 标签键。

TestKey
TagValuestring

Executor 标签值。

TestValue
ExecutorStatusobject

Executor 状态统计。

Pendinginteger

排队状态的 Executor 数量。

1
Initinginteger

初始化状态的 Executor 数量。

1
Runninginteger

运行中状态的 Executor 数量。

1
Succeededinteger

运行成功状态的 Executor 数量。

1
Failedinteger

运行失败状态的 Executor 数量。

1
Deletedinteger

删除状态的 Executor 数量。

1
Exceptioninteger

异常状态的 Executor 数量。

1

示例

正常返回示例

JSON格式

{
  "RequestId": "896D338C-E4F4-41EC-A154-D605E5DE****",
  "JobId": "job-xxxx",
  "TaskName": "task0",
  "PageSize": 10,
  "PageNumber": 1,
  "TotalCount": 50,
  "Executors": [
    {
      "ExecutorId": "job-xxxx-Task0-1\n",
      "ArrayIndex": 0,
      "IpAddress": [
        "192.168.10.11"
      ],
      "ExternalIpAddress": [
        "116.62.100.6"
      ],
      "HostName": [
        "host0"
      ],
      "CreateTime": "2024-02-20 10:04:10",
      "StartTime": "2024-02-20 10:04:13",
      "EndTime": "2024-02-20 10:04:18",
      "Status": "Running",
      "StatusReason": "Creating executor",
      "Tags": [
        {
          "TagKey": "TestKey\n",
          "TagValue": "TestValue"
        }
      ],
      "ExpirationTime": "",
      "BlockDuration": 0,
      "Preemptible": true
    }
  ],
  "ExecutorStatus": {
    "Pending": 1,
    "Initing": 1,
    "Running": 1,
    "Succeeded": 1,
    "Failed": 1,
    "Deleted": 1,
    "Exception": 1,
    "Suspended": 0,
    "Restarting": 0
  }
}

错误码

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

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

变更历史

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