华为云服务器查询任务的执行状态_云淘科技
功能介绍
查询一个异步请求任务（Job）的执行状态。
对于创建云服务器、删除云服务器、云服务器批量操作和网卡操作等异步API，命令下发后，会返回任务ID（Job_id），通过Job_id可以查询本次异步请求任务的执行状态。
如何获取job_id，请参考响应（任务类）。
调试
您可以在API Explorer中调试该接口。
URI
GET /v1/{project_id}/jobs/{job_id}
参数说明请参见表1。
|
参数 |
是否必选 |
描述 |
|---|---|---|
|
project_id |
是 |
项目ID。 获取方法请参见获取项目ID。 |
|
job_id |
是 |
异步请求的任务ID。 |
请求消息
无
响应消息
响应参数如表2所示。
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
status |
String |
Job的状态。 SUCCESS：成功。 说明： PENDING_PAYMENT 状态为创建或者变更包年/包月的弹性云服务器提交订单完成后待支付状态。如果订单取消，该状态不会自动刷新，待14天后job会自动清理。 |
|
entities |
Object |
Job操作的对象。 根据不同Job类型，显示不同的内容，云服务器相关操作显示server_id，网卡相关操作显示nic_id。有子Job时为子job的详情。 详情请参见表3 |
|
job_id |
String |
异步请求的任务ID。 |
|
job_type |
String |
异步请求的任务类型。 |
|
begin_time |
String |
开始时间。 |
|
end_time |
String |
结束时间。 |
|
error_code |
String |
Job执行失败时的错误码。 Job执行成功后，该值为null。 |
|
fail_reason |
String |
Job执行失败时的错误原因。 Job执行成功后，该值为null。 |
|
message |
String |
查询Job的API请求出现错误时，返回的错误消息。 |
|
code |
String |
查询Job的API请求出现错误时，返回的错误码。 错误码和其对应的含义请参考通用请求返回值。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
server_id |
String |
云服务器相关操作显示server_id。 |
|
nic_id |
String |
网卡相关操作显示nic_id。 |
|
sub_jobs_total |
Integer |
子任务数量。 |
|
sub_jobs |
Array of objects |
每个子任务的执行信息。 详情请参见表4 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
status |
String |
Job的状态。 SUCCESS：成功。 |
|
entities |
Object |
Job操作的对象。根据不同Job类型，显示不同的内容，云服务器相关操作显示server_id，网卡相关操作显示nic_id。更多字段描述请参见表5。 |
|
job_id |
String |
子任务的ID。 |
|
job_type |
String |
子任务的类型。 |
|
begin_time |
String |
开始时间。 |
|
end_time |
String |
结束时间。 |
|
error_code |
String |
Job执行失败时的错误码。 Job执行成功后，该值为null。 |
|
fail_reason |
String |
Job执行失败时的错误原因。 Job执行成功后，该值为null。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
server_id |
String |
云服务器相关操作显示server_id。 |
|
nic_id |
String |
网卡相关操作显示nic_id。 |
|
errorcode_message |
String |
子任务执行失败的具体原因。 |
请求示例
查询一个异步请求任务（Job）的执行状态。
GET https://{endpoint}/v1/{project_id}/jobs/{job_id}
响应示例
{
"status": "SUCCESS",
"entities": {
"sub_jobs_total": 1,
"sub_jobs": [
{
"status": "SUCCESS",
"entities": {
"server_id": "bae51750-0089-41a1-9b18-5c777978ff6d"
},
"job_id": "2c9eb2c5544cbf6101544f0635672b60",
"job_type": "createSingleServer",
"begin_time": "2016-04-25T20:04:47.591Z",
"end_time": "2016-04-25T20:08:21.328Z",
"error_code": null,
"fail_reason": null
}
]
},
"job_id": "2c9eb2c5544cbf6101544f0602af2b4f",
"job_type": "createServer",
"begin_time": "2016-04-25T20:04:34.604Z",
"end_time": "2016-04-25T20:08:41.593Z",
"error_code": null,
"fail_reason": null
}
返回值
请参考通用请求返回值。
错误码
请参考错误码。
父主题： 查询Job状态
内容没看懂？ 不太想学习？想快速解决？ 有偿解决： 联系专家
