GetJob - 获取作业详情

获取执行作业详情。

调试

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

授权信息

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

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

请求参数

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

作业 ID。

job-xxxx

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

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

作业详细信息。

JobIdstring

作业 ID。

job-xxxx
JobNamestring

作业名称。

testJob
JobDescriptionstring

作业描述。

Demo
Tasksarray<object>

任务列表,当前仅支持 1 个任务。

Taskobject

任务列表,当前仅支持 1 个任务。

TaskNamestring

任务名称。

task0
TaskSpecobject

任务规格详情。

TaskExecutorarray<object>

任务执行配置。

TaskExecutorobject

任务执行配置。

VMobject

使用 ECS 实例。

Imagestring

镜像 ID。

m-xxxx
PrologScriptstring

前处理脚本。需 Base64 编码。

ZWNobyAiMTIzNCIgPiBgZGF0ZSArJXNg
Scriptstring

运行作业脚本。需 Base64 编码。

ZWNobyAiMTIzNCIgPiBgZGF0ZSArJXNg
Resourceobject

资源信息。

Coresfloat

运行作业的 CPU 个数。

1
Memoryinteger

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

4
Disksarray<object>

云盘数组。

Diskobject

云盘数组。

Typestring

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

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

云盘大小。

100
ExecutorPolicyobject

任务执行策略。

MaxCountinteger

作业运行最大节点数。

10
ArraySpecobject

数组作业详情。

IndexStartinteger

数组作业索引的起始值。取值范围:0~4999。

0
IndexEndinteger

数组作业索引的结束值。取值范围:0~4999,且大于等于 IndexStart。

9
IndexStepinteger

数组作业索引的间隔。

说明 若数组作业属性为 IndexStart=1,IndexEnd=5,IndexStep=2,则该数组作业包含三个子任务,子任务索引分别为 1,3,5。
1
TaskSustainableboolean

是否是长期运行的作业。

true
ExecutorStatusarray<object>

任务执行状态。

ExecutorStatusobject

任务执行状态。

ArrayIdinteger

子作业 ID

0
Statusstring

作业状态。

Running
StatusReasonstring

状态原因描述。

Creating executor
CreateTimestring

作业创建时间。

2024-02-04 13:54:10
StartTimestring

作业开始时间。

2024-02-04 13:54:10
EndTimestring

作业结束时间。

2024-02-04 13:54:10
DeploymentPolicyobject

资源部署策略。

AllocationSpecstring

资源类型。当前仅支持 Dedicated,需开通白名单使用。

Dedicated
Networkobject

网络配置信息。

Vswitcharray

交换机数组。

Vswitchstring

交换机 ID。

vsw-xxx
EnableExternalIpAddressboolean

是否创建公网 IP。

枚举值:
  • falsefalse
  • truetrue
false
EnableENIMappingboolean

资源是否创建在传入交换机参数对应的可用区下。

  • true:资源创建在传入交换机参数对应的可用区下。

  • false:资源创建在任何有资源的可用区下。

false
Tagsarray<object>

作业标签列表。

Tagobject

作业标签列表。

TagKeystring

作业标签键。

TestKey
TagValuestring

作业标签值。

TestValue
Levelstring

算力等级。支持以下类型:

  • General:通用型。
  • Performance:性能型。

默认值:General

General
JobSchedulerstring

作业调度器类型。

HPC
CreateTimestring

作业提交时间。

2024-03-05 20:00:46
StartTimestring

作业开始时间。

2024-03-05 20:00:48
EndTimestring

作业结束时间。

2024-03-05 20:01:48
Statusstring

作业状态。取值范围:

  • Pending:作业排队中
  • Initing:作业初始化中
  • Succeed:作业运行成功
  • Failed:作业运行失败
  • Running:作业运行中
  • Exception:调度异常
  • Retrying:作业重试中
  • Expired:作业超时
  • Deleted:作业删除完成
  • Suspended:作业休眠
  • Restarting:作业重启中
Succeeded
AppExtraInfostring

应用附加信息。

{\"xxx\": \"xxxxx\"}

示例

正常返回示例

JSON格式

{
  "RequestId": "896D338C-E4F4-41EC-A154-D605E5DE****",
  "JobInfo": {
    "JobId": "job-xxxx",
    "JobName": "testJob",
    "JobDescription": "Demo",
    "Tasks": [
      {
        "TaskName": "task0",
        "TaskSpec": {
          "TaskExecutor": [
            {
              "VM": {
                "Image": "m-xxxx",
                "PrologScript": "ZWNobyAiMTIzNCIgPiBgZGF0ZSArJXNg",
                "Script": "ZWNobyAiMTIzNCIgPiBgZGF0ZSArJXNg"
              }
            }
          ],
          "Resource": {
            "Cores": 1,
            "Memory": 4,
            "Disks": [
              {
                "Type": "System",
                "Size": 100
              }
            ],
            "InstanceTypes": [
              ""
            ]
          },
          "RetryPolicy": {
            "RetryCount": 0,
            "ExitCodeActions": [
              {
                "Action": "",
                "ExitCode": 0
              }
            ]
          }
        },
        "ExecutorPolicy": {
          "MaxCount": 10,
          "ArraySpec": {
            "IndexStart": 0,
            "IndexEnd": 9,
            "IndexStep": 1
          }
        },
        "TaskSustainable": true,
        "ExecutorStatus": [
          {
            "ArrayId": 0,
            "Status": "Running",
            "StatusReason": "Creating executor",
            "CreateTime": "2024-02-04 13:54:10",
            "StartTime": "2024-02-04 13:54:10",
            "EndTime": "2024-02-04 13:54:10"
          }
        ]
      }
    ],
    "DeploymentPolicy": {
      "AllocationSpec": "Dedicated",
      "Network": {
        "Vswitch": [
          "vsw-xxx"
        ],
        "EnableExternalIpAddress": false,
        "EnableENIMapping": false
      },
      "Tags": [
        {
          "TagKey": "TestKey",
          "TagValue": "TestValue"
        }
      ],
      "Level": "General"
    },
    "DependencyPolicy": {
      "JobDependency": [
        {
          "JobId": "",
          "Type": ""
        }
      ]
    },
    "JobScheduler": "HPC",
    "CreateTime": "2024-03-05 20:00:46",
    "StartTime": "2024-03-05 20:00:48",
    "EndTime": "2024-03-05 20:01:48",
    "Status": "Succeeded",
    "AppExtraInfo": "{\\\"xxx\\\": \\\"xxxxx\\\"}"
  }
}

错误码

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-05-09OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2025-03-13OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2025-02-20OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2024-11-13OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2024-09-18OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情