功能介绍
查询job的执行状态。 对于创建保护组、删除保护组、创建保护实例、删除保护实例、创建复制对、删除复制对等异步API,命令下发后,会返回job_id,通过job_id可以查询任务的执行状态。
接口约束
无
调试
您可以在API Explorer中调试该接口。
URI
GET /v1/{project_id}/jobs/{job_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
job_id |
是 |
String |
job ID |
project_id |
是 |
String |
项目ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
status |
String |
Job的状态。 SUC CES S:成功。 RUNNING:运行中。 FAIL:失败。 INIT:正在初始化。 枚举值:
|
entities |
Job操作的对象。 |
|
job_id |
String |
Job ID。 |
job_type |
String |
Job的类型。createProtectionGroupNoCG:创建保护组。deleteProtectionGroupNoCG:删除保护组。startProtectionGroupNoCG :保护组开始保护。reprotectProtectionGroupNoCG :保护组重保护。stopProtectionGroupNoCG :保护组停止保护。failoverProtectionGroupNoCG :保护组故障切换。reverseProtectionGroupNoCG:保护组切换。createProtectedInstanceNoCG:创建保护实例。deleteProtectedInstanceNoCG:删除保护实例。attachReplicationPairNew:保护实例挂载复制对。detachReplicationPairNew:保护实例卸载复制对。addNicNew:保护实例添加网卡。deleteNicNew:保护实例删除网卡。resizeProtectedInstanceNew:保护实例变更规格。createReplicationPairNoCG:创建复制对。deleteReplicationPairNoCG:删除复制对。expandReplicationPairNew:复制对扩容。createDisasterRecoveryDrill:创建容灾演练。deleteDisasterRecoveryDrill:删除容灾演练。 |
begin_time |
String |
开始时间。默认格式为:"yyyy-MM-dd'T'HH:mm:ss.SSSZ",例:"2019-04-01T12:00:00.000Z"。 |
end_time |
String |
结束时间。默认格式为:"yyyy-MM-dd'T'HH:mm:ss.SSSZ",例:"2019-04-01T12:00:00.000Z"。 |
error_code |
String |
Job执行失败时的错误码。 |
fail_reason |
String |
Job执行失败时的错误原因。 |
参数 |
参数类型 |
描述 |
---|---|---|
replication_pair_id |
String |
复制对ID |
volume_ids |
String |
组成复制对的 云硬盘 ID |
server_group_id |
String |
保护组ID |
protected_instance_id |
String |
保护实例ID |
native_server_id |
String |
容灾站点服务器ID |
nic_id |
String |
网卡ID |
sub_jobs |
子Job信息 |
参数 |
参数类型 |
描述 |
---|---|---|
status |
String |
Job的状态。 SUCCESS:成功。 RUNNING:运行中。 FAIL:失败。 INIT:正在初始化。 枚举值:
|
entities |
Job操作的对象。 |
|
job_id |
String |
Job ID。 |
job_type |
String |
Job的类型。createProtectionGroupNoCG:创建保护组。deleteProtectionGroupNoCG:删除保护组。startProtectionGroupNoCG :保护组开始保护。reprotectProtectionGroupNoCG :保护组重保护。stopProtectionGroupNoCG :保护组停止保护。failoverProtectionGroupNoCG :保护组故障切换。reverseProtectionGroupNoCG:保护组切换。createProtectedInstanceNoCG:创建保护实例。deleteProtectedInstanceNoCG:删除保护实例。attachReplicationPairNew:保护实例挂载复制对。detachReplicationPairNew:保护实例卸载复制对。addNicNew:保护实例添加网卡。deleteNicNew:保护实例删除网卡。resizeProtectedInstanceNew:保护实例变更规格。createReplicationPairNoCG:创建复制对。deleteReplicationPairNoCG:删除复制对。expandReplicationPairNew:复制对扩容。createDisasterRecoveryDrill:创建容灾演练。deleteDisasterRecoveryDrill:删除容灾演练。 |
begin_time |
String |
开始时间。默认格式为:"yyyy-MM-dd'T'HH:mm:ss.SSSZ",例:"2019-04-01T12:00:00.000Z"。 |
end_time |
String |
结束时间。默认格式为:"yyyy-MM-dd'T'HH:mm:ss.SSSZ",例:"2019-04-01T12:00:00.000Z"。 |
error_code |
String |
Job执行失败时的错误码。 |
fail_reason |
String |
Job执行失败时的错误原因。 |
参数 |
参数类型 |
描述 |
---|---|---|
replication_pair_id |
String |
复制对ID |
volume_ids |
String |
组成复制对的云硬盘ID |
server_group_id |
String |
保护组ID |
protected_instance_id |
String |
保护实例ID |
native_server_id |
String |
容灾站点服务器ID |
nic_id |
String |
网卡ID |
状态码: 400
状态码: 401
状态码: 403
状态码: 405
状态码: 406
状态码: 407
状态码: 408
状态码: 409
状态码: 500
状态码: 501
状态码: 502
状态码: 503
状态码: 504
请求示例
GET https://{endpoint}/v1/{project_id}/jobs/0000000062db92d70162db9d200f000a
响应示例
状态码: 200
OK
{ "status" : "SUCCESS", "entities" : { "server_group_id" : "a59d008e-4bad-4bf3-9b17-6cc25e7da483" }, "job_id" : "0000000062db92d70162db9d200f000a", "job_type" : "createProtectionGroupNoCG", "begin_time" : "2018-04-19T01:55:30.443Z", "end_time" : "2018-04-19T01:55:45.493Z", "error_code" : null, "fail_reason" : null }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
405 |
Method Not Allowed |
406 |
Not Acceptable |
407 |
Proxy Authentication Required |
408 |
Request Timeout |
409 |
Conflict |
500 |
Internal Server Error |
501 |
Not Implemented |
502 |
Bad Gateway |
503 |
Service Unavailable |
504 |
Gateway Timeout |
错误码
请参见错误码。