查询job状态

功能介绍

查询job的执行状态。

对于创建保护组、删除保护组、创建保护实例、删除保护实例、创建复制对、删除复制对等异步API，命令下发后，会返回job_id，通过job_id可以查询任务的执行状态。

URI

• URI格式

  GET /v1/{project_id}/jobs/{job_id}

• 参数说明

  参数名称	是否必选	参数类型	说明
  project_id	是	String	项目ID。 获取方法请参见获取项目ID。
  job_id	是	String	job ID。 执行异步API命令下发后的返回参数，详见功能介绍说明部分。

请求消息

• 请求参数

  无

• 请求样例

  GET https://{endpoint}/v1/{project_id}/jobs/0000000062db92d70162db9d200f000a

响应消息

• 要素说明

  参数名称	参数类型	说明
  status	String	Job的状态。 SUCCESS：成功。 RUNNING：运行中。 FAIL：失败。 INIT：正在初始化。
  entities	Object	Job操作的对象。 根据不同Job类型，显示不同的内容，保护组相关操作显示server_group_id，有子Job时为子job的详情。 详情请参见表1。
  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执行失败时的错误原因。 详见错误码。
  message	String	出现错误时，返回的错误信息。 详见返回值异常码。
  code	String	出现错误时，返回的错误码。 详见返回值异常码。

  表1 entities字段说明

  参数名称	参数类型	说明
  server_group_id	String	保护组相关操作显示保护组ID。
  sub_jobs	Array of objects	每个子job的执行信息。没有子job时为空列表。每个子job的结构与父job类似。

• 响应样例

  {  
        "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  
    }

  或

  {
      "job_id": "ff8080826b45d4a5016b5036242c0025",
      "job_type": "stopProtectionGroupNoCG",
      "begin_time": "2019-06-13T09:40:53.930Z",
      "end_time": "2019-06-13T09:41:01.946Z",
      "status": "SUCCESS",
      "error_code": null,
      "fail_reason": null,
      "entities": {
          "sub_jobs": [
              {
                  "job_id": "ff8080826b45d4a5016b50362868002a",
                  "job_type": "stopProtectionGroupRepNoCG",
                  "begin_time": "2019-06-13T09:40:55.015Z",
                  "end_time": "2019-06-13T09:40:58.951Z",
                  "status": "SUCCESS",
                  "error_code": null,
                  "fail_reason": null,
                  "entities": {
                      "server_group_id": "1fd6903c-48f9-4772-8974-112dfbd74427"
                  }
              },
              {
                  "job_id": "ff8080826b45d4a5016b50362870002b",
                  "job_type": "stopProtectionGroupRepNoCG",
                  "begin_time": "2019-06-13T09:40:55.022Z",
                  "end_time": "2019-06-13T09:40:58.952Z",
                  "status": "SUCCESS",
                  "error_code": null,
                  "fail_reason": null,
                  "entities": {
                      "server_group_id": "1fd6903c-48f9-4772-8974-112dfbd74427"
                  }
              }
          ]
      }
  }
  { 
       "error": { 
           "message": "XXXX",  
           "code": "XXX" 
       } 
   }

返回值

• 正常

  返回值	说明
  200	服务器已接受请求。

• 异常

  返回值	说明
  400 Bad Request	服务器未能处理请求。
  401 Unauthorized	被请求的页面需要用户名和密码。
  403 Forbidden	对被请求页面的访问被禁止。
  404 Not Found	服务器无法找到被请求的页面。
  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	网关超时。