使用GetJob获取任务的配置与运行时信息-人工智能平台 PAI-阿里云-人工智能平台 PAI(PAI)-阿里云帮助中心

获取一个任务的详细配置和运行时信息。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

paidlc:GetJob

get

*全部资源

*

无

请求语法

GET /api/v1/jobs/{JobId} HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
JobId	string	是	任务 ID。如何获取任务 ID，请参见 ListJobs 。	dlc*******

请求参数

名称	类型	必填	描述	示例值
NeedDetail	boolean	否	是否返回作业详情信息，默认为 true	true

返回参数

名称	类型	描述	示例值
	object	JSON 格式的字符串。
Accessibility	string	任务的可见性，取值如下： PUBLIC：在此工作空间中，对所有人可见。 PRIVATE（默认值）：在此工作空间中，仅对您和管理员可见。	PRIVATE
ClusterId	string	集群 ID。	a*****
CodeSource	object	代码源。
Branch	string	代码分支。	master
CodeSourceId	string	代码源 ID。	code******
Commit	string	代码 CommitID。	44da109b59f8596152987eaa8f3b2487xxxxxx
MountPath	string	本地挂载路径。	/mnt/data
CredentialConfig	CredentialConfig	访问凭证配置。
CustomEnvs	array<object>
	object
Key	string
Value	string
Visible	string
DataSources	array<object>	数据源列表。
	object	数据源。
DataSourceId	string	数据源 ID。	d*******
MountPath	string	本地挂载路径，可选参数，默认为空（表示使用数据源中挂载路径）。	/mnt/data/
Uri	string	数据源路径	oss://bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/
Description	string
DisplayName	string	任务名称。	tf-mnist-test
Duration	integer	任务运行时长，单位：秒。	3602
ElasticSpec	JobElasticSpec	弹性任务参数。
EnabledDebugger	boolean	是否开启 debugger 任务。	false
Envs	object	环境变量配置。
	string	环境变量 Key 和 Value。	ENABLE_DEBUG_MODE
GmtCreateTime	string	任务创建时间（UTC）。	2021-01-12T14:35:01Z
GmtFailedTime	string	任务运行失败的时间（UTC）。	2021-01-12T15:36:08Z
GmtFinishTime	string	任务结束时间（UTC）。	2021-01-12T15:36:08Z
GmtRunningTime	string	任务开始运行的时间（UTC）。	2021-01-12T14:36:21Z
GmtStoppedTime	string	任务停止的时间（UTC）。	2021-01-12T15:36:08Z
GmtSubmittedTime	string	任务提交到集群的时间（UTC）。	2021-01-12T14:36:01Z
GmtSuccessedTime	string	任务正常结束的时间（UTC）。	2021-01-12T15:36:08Z
JobId	string	任务 ID。	dlc*******
JobReplicaStatuses	array	作业副本状态
	JobReplicaStatus	作业副本状态
JobSpecs	array	任务中的节点配置，参考 CreateJob API 中的 JobSpecs。
	JobSpec	描述一种节点类型的详细配置。
JobType	string	任务类型。由 CreateJob API 中的 JobType 指定。	TFJob
Pods	array<object>	任务运行中的所有节点。
	array<object>	节点数组。
Duration	number	Pod 运行时长
GmtCreateTime	string	Pod 创建时间（UTC）。	2021-01-12T14:36:01Z
GmtFinishTime	string	节点结束时间（UTC）。	2021-01-12T15:36:05Z
GmtStartTime	string	节点启动时间（UTC）。	2021-01-12T14:36:01Z
HistoryPods	array<object>	历史 Pods。
	object	历史 Pod 数组。
Duration	number	Pod 运行时长
GmtCreateTime	string	Pod 创建时间（UTC）。	2021-01-12T14:36:01Z
GmtFinishTime	string	Pod 结束时间（UTC）。	2021-01-12T14:36:01Z
GmtStartTime	string	Pod 启动时间（UTC）。	2021-01-12T14:36:01Z
Ip	string	Pod IP。	10.0.1.3
NodeName	string	节点名称
PodId	string	Pod ID。	Worker
PodIps	array	Pod 的 IP 地址
	PodNetworkInterface	每张网卡对应的 IP 地址
PodUid	string	Pod UID。	fe846462-af2c-4521-bd6f-96787a57591d
ResourceType	string	Pod 资源使用类型。	Normal
Status	string	Pod 状态。	Failed
SubStatus	string	Pod 子状态，例如抢占状态。取值如下： Normal Evicted	Normal
Type	string	Pod 类型。	Worker
supportedProfilingTypes	string	支持的 Profiling 类型列表，逗号分隔，如 sysom。空串表示不支持。	sysom
Ip	string	节点的网络 IP 地址。	10.0.1.2
NodeName	string	节点名称
PodId	string	节点 ID，可用于 GetPodLogs 和 GetPodEvents API 获取节点的详细日志和事件。	Worker
PodIps	array	Pod 的 IP 地址
	PodNetworkInterface	每张网卡对应的 IP 地址
PodUid	string	Pod UID。	fe846462-af2c-4521-bd6f-96787a57591d
ResourceType	string	Pod 资源使用类型。	Normal
Status	string	节点状态。可能值： Pending Running Succeeded Failed Unknown	Running
SubStatus	string	Pod 子状态，例如抢占状态。取值如下： Normal Evicted	Normal
Type	string	节点类型，与 CreateJob 中的 JobSpecs 中的某个 JobSpec 对应。	Worker
supportedProfilingTypes	string	支持的 Profiling 类型列表，逗号分隔，如 sysom。空串表示不支持。	sysom
Priority	integer	任务的优先级。可能值为 1~9。	1
ReasonCode	string	状态详情码，对当前状态（Status）下的子状态的一个分类。	JobStoppedByUser
ReasonMessage	string	状态详情的详细描述。	Job is stopped by user.
RequestCPU	integer	job 所需的 CPU 资源量	10
RequestGPU	number	job 所需的 GPU 资源量	10
RequestId	string	请求 ID，用于诊断和答疑。	473469C7-AA6F-4DC5-B3DB-xxxxxxxx
RequestMemory	number	job 所需的内存资源量	10
ResourceId	string	任务运行所在的资源组 ID。	r******
ResourceLevel	string	任务运行时使用的资源级别。	L0
ResourceType	string	资源类型，可选值：ECS，Lingjun，ACS	ECS
RestartRecord	array<object>	作业重启记录
	array<object>	作业重启记录
DetailErrorInfoList	array<object>	错误信息列表
	object	错误信息
AddJobLevelBlacklist	boolean	作业黑名单
AddNodeToBlacklist	boolean	节点黑名单
DetailErrorMsg	string	详细错误信息
ErrorCode	string	错误码
ErrorMsg	string	错误信息
ErrorSource	string	错误源
Node	string	节点
Pod	string	实例
TriggerRestart	boolean	是否触发重启
JobRestartCount	integer	作业重启次数
OccurPhase	string	发生的阶段
OccurTime	string	发生的时间
Reason	string	原因
RestartDurationInSec	integer	重启时间
RestartFailReason	string	重启失败原因
RestartLevelType	string	重启级别（Pod 级别重启/Job 级别重启）
RestartStatus	string	重启状态
TriggerID	string	TriggerID
RestartTimes	string	作业已使用的重试次数和最大重试次数。	0/10
RoleSystemEnvs	object
	object
	string
SchedulingStrategy	string	调度策略配置	Auto
Settings	JobSettings	作业额外参数配置。
Status	string	任务运行状态，可能值： Creating Queuing Bidding (当前仅限灵骏 Spot 作业) EnvPreparing SanityChecking Running Restarting Stopping SucceededReserving FailedReserving Succeeded Failed Stopped	Stopped
StatusHistory	array	历史状态。
	StatusTransitionItem	历史状态。
SubStatus	string	作业子状态，例如抢占重试状态。	Restarting
TenantId	string	租户 ID。	GAR***W134
ThirdpartyLibDir	string	三方库（requirements.txt）文件所在文件夹。	/root/code/
ThirdpartyLibs	array	需要安装的 Python 三方库列表。
	string	第三方 Python 库。	numpy==1.16.1
UserCommand	string	每个节点的启动命令。	python /root/code/mnist.py
UserId	string	任务提交人的阿里云 UID。	12*********
UserVpc	object	用户 VPC
DefaultRoute	string	默认路由。此参数只在通用计算资源下有效，取值如下： eth0：表示使用默认网卡，通过公共网关访问外部网络。 eth1：表示使用用户弹性网卡，通过私有网关访问外部网络。
ExtendedCidrs	array	扩展网段，示例：192.168.0.1/24
	string	扩展网段	192.168.0.1/24
SecurityGroupId	string	用户安全组的 id	sg-abcdef****
SwitchId	string	用户交换机的 id	vs-abcdef****
VpcId	string	用户 VPC 的 id	vpc-abcdef****
WorkspaceId	string	任务所属工作空间 ID。	268
WorkspaceName	string	任务所属工作空间名称。	dlc-workspace
supportedProfilingTypes	string	支持的 Profiling 类型列表，逗号分隔，如 sysom。空串表示不支持。	sysom

示例

正常返回示例

JSON格式

{
  "Accessibility": "PRIVATE",
  "ClusterId": "a*****",
  "CodeSource": {
    "Branch": "master",
    "CodeSourceId": "code******",
    "Commit": "44da109b59f8596152987eaa8f3b2487xxxxxx",
    "MountPath": "/mnt/data"
  },
  "CredentialConfig": {
    "EnableCredentialInject": true,
    "AliyunEnvRoleKey": "",
    "CredentialConfigItems": [
      {
        "Key": "",
        "Type": "",
        "Roles": [
          {
            "RoleArn": "",
            "RoleType": "",
            "AssumeRoleFor": "",
            "Policy": "",
            "AssumeUserInfo": {
              "SecurityToken": "",
              "AccessKeyId": "",
              "Type": "",
              "Id": ""
            }
          }
        ]
      }
    ]
  },
  "CustomEnvs": [
    {
      "Key": "",
      "Value": "",
      "Visible": ""
    }
  ],
  "DataSources": [
    {
      "DataSourceId": "d*******",
      "MountPath": "/mnt/data/",
      "Uri": "oss://bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/"
    }
  ],
  "Description": "",
  "DisplayName": "tf-mnist-test",
  "Duration": 3602,
  "ElasticSpec": {
    "EnableElasticTraining": true,
    "MinParallelism": 1,
    "MaxParallelism": 8,
    "AIMasterType": "",
    "AIMasterDockerImage": "",
    "EnablePsJobElasticWorker": true,
    "EnableAIMaster": true,
    "EnablePsResourceEstimate": true,
    "EnablePsJobElasticPS": true,
    "PSMinParallelism": 4,
    "PSMaxParallelism": 10,
    "ElasticStrategy": "",
    "EnableEDP": true,
    "EDPMaxParallelism": 16,
    "EDPMinParallelism": 8
  },
  "EnabledDebugger": false,
  "Envs": {
    "key": "ENABLE_DEBUG_MODE"
  },
  "GmtCreateTime": "2021-01-12T14:35:01Z",
  "GmtFailedTime": "2021-01-12T15:36:08Z",
  "GmtFinishTime": "2021-01-12T15:36:08Z",
  "GmtRunningTime": "2021-01-12T14:36:21Z",
  "GmtStoppedTime": "2021-01-12T15:36:08Z",
  "GmtSubmittedTime": "2021-01-12T14:36:01Z",
  "GmtSuccessedTime": "2021-01-12T15:36:08Z",
  "JobId": "dlc*******",
  "JobReplicaStatuses": [
    {
      "Type": "",
      "Active": 0,
      "EstimatedPodCount": 0,
      "EstimatedAutoScalingSpec": {
        "ScalingStrategy": "",
        "MinReplicas": 0,
        "MaxReplicas": 0,
        "PodsToDelete": [
          ""
        ],
        "AutoscalingMetricSpec": {
          "MetricName": "",
          "TargetValue": 0,
          "StabilizationWindowSeconds": 0,
          "Tolerance": ""
        }
      },
      "EstimatedResourceConfig": {
        "CPU": "10",
        "GPU": "3",
        "Memory": "10Gi",
        "SharedMemory": "5Gi",
        "GPUType": "Tesla-V100-16G"
      },
      "Queuing": 0,
      "Dequeued": 0,
      "CurrentSpotInstanceType": ""
    }
  ],
  "JobSpecs": [
    {
      "Type": "Worker",
      "Image": "registry-vpc.cn-hangzhou.aliyuncs.com/cloud-dsw/tensorflow:1.12PAI-gpu-py36-cu101-ubuntu18.04",
      "ImageConfig": {
        "DockerRegistry": "docker****registry.com",
        "Username": " username",
        "Password": "password",
        "Auth": ""
      },
      "PodCount": 1,
      "ExtraPodSpec": {
        "SideCarContainers": [
          {
            "Name": "data-init",
            "Image": "registry.cn-hangzhou.aliyuncs.com/pai-dlc/curl:v1.0.0",
            "Command": [
              "curl www.aliyun.com"
            ],
            "Args": [
              "-v"
            ],
            "WorkingDir": "/root",
            "Env": [
              {
                "Name": "ENABLE_DEBUG",
                "Value": "true"
              }
            ],
            "Resources": {
              "Limits": {
                "key": "{'cpu': '1', 'memory': '1000Mi'}"
              },
              "Requests": {
                "key": "{'cpu': '1', 'memory': '1000Mi'}"
              }
            },
            "SecurityContext": {
              "RunAsUser": 1000,
              "RunAsGroup": 1000,
              "SeccompProfile": {
                "Type": "Unconfined",
                "LocalhostProfile": "my-profiles/profile-allow.json"
              },
              "Privileged": true,
              "Capabilities": {
                "Add": [
                  ""
                ],
                "Drop": [
                  ""
                ]
              }
            }
          }
        ],
        "InitContainers": [
          {
            "Name": "data-init",
            "Image": "registry.cn-hangzhou.aliyuncs.com/pai-dlc/curl:v1.0.0",
            "Command": [
              "curl www.aliyun.com"
            ],
            "Args": [
              "-v"
            ],
            "WorkingDir": "/root",
            "Env": [
              {
                "Name": "ENABLE_DEBUG",
                "Value": "true"
              }
            ],
            "Resources": {
              "Limits": {
                "key": "{'cpu': '1', 'memory': '1000Mi'}"
              },
              "Requests": {
                "key": "{'cpu': '1', 'memory': '1000Mi'}"
              }
            },
            "SecurityContext": {
              "RunAsUser": 1000,
              "RunAsGroup": 1000,
              "SeccompProfile": {
                "Type": "Unconfined",
                "LocalhostProfile": "my-profiles/profile-allow.json"
              },
              "Privileged": true,
              "Capabilities": {
                "Add": [
                  ""
                ],
                "Drop": [
                  ""
                ]
              }
            }
          }
        ],
        "PodLabels": {
          "key": "example-lable"
        },
        "PodAnnotations": {
          "key": "example-annotation"
        },
        "SharedVolumeMountPaths": [
          "/root/share/"
        ],
        "Lifecycle": {
          "PreStop": {
            "Exec": {
              "Command": [
                ""
              ]
            }
          },
          "PostStart": {
            "Exec": {
              "Command": [
                ""
              ]
            }
          }
        },
        "MainContainerSecurityContext": {
          "RunAsUser": 1000,
          "RunAsGroup": 1000,
          "SeccompProfile": {
            "Type": "Unconfined",
            "LocalhostProfile": "my-profiles/profile-allow.json"
          },
          "Privileged": true,
          "Capabilities": {
            "Add": [
              ""
            ],
            "Drop": [
              ""
            ]
          }
        }
      },
      "ResourceConfig": {
        "CPU": "10",
        "GPU": "3",
        "Memory": "10Gi",
        "SharedMemory": "5Gi",
        "GPUType": "Tesla-V100-16G"
      },
      "UseSpotInstance": false,
      "SpotSpec": {
        "SpotStrategy": "SpotWithPriceLimit",
        "SpotDiscountLimit": 0.8,
        "SpotPriceLimit": 0.4744
      },
      "AssignNodeSpec": {
        "EnableAssignNode": true,
        "NodeNames": "lingjxxxxxxxx",
        "AntiAffinityNodeNames": "lingjxxxxxxxx",
        "HyperNodes": [
          {
            "HyperNodeName": "",
            "NodeNames": ""
          }
        ],
        "AntiAffinityHyperNodes": [
          {
            "HyperNodeName": "",
            "NodeNames": ""
          }
        ]
      },
      "LocalMountSpecs": [
        {
          "MountMode": "",
          "LocalPath": "",
          "MountPath": ""
        }
      ],
      "AutoScalingSpec": {
        "ScalingStrategy": "",
        "MinReplicas": 0,
        "MaxReplicas": 0,
        "PodsToDelete": [
          ""
        ],
        "AutoscalingMetricSpec": {
          "MetricName": "",
          "TargetValue": 0,
          "StabilizationWindowSeconds": 0,
          "Tolerance": ""
        }
      },
      "ServiceSpec": {
        "DefaultPort": 8080,
        "ServiceMode": "PerRole",
        "ExtraPorts": [
          8081
        ]
      },
      "IsCheif": true,
      "IsChief": true,
      "RestartPolicy": "ExitCode",
      "SystemDisk": {
        "Size": 0,
        "Category": "",
        "PerformanceLevel": ""
      },
      "EcsSpec": "ecs.c6.large",
      "QuotaId": "",
      "ConsiderInSuccessPolicy": true,
      "OversoldType": "",
      "HyperNodeSchedulingConfig": {
        "MinAvailable": 0,
        "QualityPolicy": ""
      },
      "Driver": "",
      "UserCommand": "python train.py",
      "StartupDependencies": [
        {
          "Type": "",
          "OnPhase": "",
          "MinReplicas": ""
        }
      ],
      "ElasticSpotSpecs": [
        {
          "InstanceType": "",
          "SpotPriceLimit": 0,
          "SpotDiscountLimit": 0,
          "SpotStrategy": ""
        }
      ]
    }
  ],
  "JobType": "TFJob",
  "Pods": [
    {
      "Duration": 0,
      "GmtCreateTime": "2021-01-12T14:36:01Z",
      "GmtFinishTime": "2021-01-12T15:36:05Z",
      "GmtStartTime": "2021-01-12T14:36:01Z",
      "HistoryPods": [
        {
          "Duration": 0,
          "GmtCreateTime": "2021-01-12T14:36:01Z",
          "GmtFinishTime": "2021-01-12T14:36:01Z",
          "GmtStartTime": "2021-01-12T14:36:01Z",
          "Ip": "10.0.1.3",
          "NodeName": "",
          "PodId": "Worker",
          "PodIps": [
            {
              "InterfaceName": "",
              "Ip": ""
            }
          ],
          "PodUid": "fe846462-af2c-4521-bd6f-96787a57591d",
          "ResourceType": "Normal",
          "Status": "Failed",
          "SubStatus": "Normal",
          "Type": "Worker",
          "supportedProfilingTypes": "sysom"
        }
      ],
      "Ip": "10.0.1.2",
      "NodeName": "",
      "PodId": "Worker",
      "PodIps": [
        {
          "InterfaceName": "",
          "Ip": ""
        }
      ],
      "PodUid": "fe846462-af2c-4521-bd6f-96787a57591d",
      "ResourceType": "Normal",
      "Status": "Running",
      "SubStatus": "Normal",
      "Type": "Worker",
      "supportedProfilingTypes": "sysom"
    }
  ],
  "Priority": 1,
  "ReasonCode": "JobStoppedByUser",
  "ReasonMessage": "Job is stopped by user.",
  "RequestCPU": 10,
  "RequestGPU": 10,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-xxxxxxxx",
  "RequestMemory": 10,
  "ResourceId": "r******",
  "ResourceLevel": "L0",
  "ResourceType": "ECS",
  "RestartRecord": [
    {
      "DetailErrorInfoList": [
        {
          "AddJobLevelBlacklist": true,
          "AddNodeToBlacklist": true,
          "DetailErrorMsg": "",
          "ErrorCode": "",
          "ErrorMsg": "",
          "ErrorSource": "",
          "Node": "",
          "Pod": "",
          "TriggerRestart": true
        }
      ],
      "JobRestartCount": 0,
      "OccurPhase": "",
      "OccurTime": "",
      "Reason": "",
      "RestartDurationInSec": 0,
      "RestartFailReason": "",
      "RestartLevelType": "",
      "RestartStatus": "",
      "TriggerID": ""
    }
  ],
  "RestartTimes": "0/10",
  "RoleSystemEnvs": {
    "key": {
      "key": ""
    }
  },
  "SchedulingStrategy": "Auto",
  "Settings": {
    "BusinessUserId": "16****",
    "Caller": "SilkFlow",
    "Tags": {
      "key": "key:value"
    },
    "PipelineId": "pid-12****",
    "EnableTideResource": true,
    "EnableErrorMonitoringInAIMaster": false,
    "ErrorMonitoringArgs": "--enable-log-hang-detection true",
    "EnableRDMA": true,
    "EnableOssAppend": true,
    "OversoldType": "AcceptQuotaOverSold",
    "AdvancedSettings": {
      "test": "test",
      "test2": 1
    },
    "Driver": "535.54.03",
    "EnableSanityCheck": true,
    "SanityCheckArgs": "--sanity-check-timing=AfterJobFaultTolerant --sanity-check-timeout-ops=MarkJobFail",
    "JobReservedMinutes": 30,
    "JobReservedPolicy": "Always",
    "EnableCPUAffinity": true,
    "DisableEcsStockCheck": false,
    "AllocateAllRDMADevices": true,
    "EnableDSWDev": true,
    "DataJuicerConfig": {
      "ExecutionMode": "standalone",
      "CommandType": "config",
      "EnableResourceEstimation": true,
      "ResourceLimit": {
        "CPU": "2",
        "Memory": "10Gi",
        "GPU": "20"
      }
    },
    "ModelConfig": {
      "ModelName": "",
      "ModelTemplate": {
        "ModelName": "",
        "Provider": "",
        "Collections": ""
      }
    },
    "AllowUnschedulableNodes": true,
    "Shell": "/bin/bash",
    "TerminationGracePeriodSeconds": 0,
    "ElasticSpotJobMaxRestartTimes": 0
  },
  "Status": "Stopped",
  "StatusHistory": [
    {
      "Status": "",
      "StartTime": "",
      "EndTime": "",
      "ReasonCode": "",
      "ReasonMessage": ""
    }
  ],
  "SubStatus": "Restarting",
  "TenantId": "GAR***W134",
  "ThirdpartyLibDir": "/root/code/",
  "ThirdpartyLibs": [
    "numpy==1.16.1"
  ],
  "UserCommand": "python /root/code/mnist.py",
  "UserId": "12*********",
  "UserVpc": {
    "DefaultRoute": "",
    "ExtendedCidrs": [
      "192.168.0.1/24"
    ],
    "SecurityGroupId": "sg-abcdef****",
    "SwitchId": "vs-abcdef****",
    "VpcId": "vpc-abcdef****"
  },
  "WorkspaceId": "268",
  "WorkspaceName": "dlc-workspace",
  "supportedProfilingTypes": "sysom"
}

错误码

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

变更历史

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