获取任务信息

功能介绍

获取云数据库 GaussDB(for MySQL)任务中心的任务信息。

该接口计划于2025-03-31下线，建议及时切换到新接口获取指定ID的任务信息。

• 调用接口前，您需要了解API认证鉴权。
• 调用接口前，您需要提前获取到地区和终端节点，即下文中的Endpoint值。

URI

• URI格式

  GET https://{endpoint}/mysql/v3/{project_id}/jobs?id={id}

• URI样例

  GET https://{endpoint}/mysql/v3/0483b6b16e954cb88930a360d2c4e663/jobs?id=a9767ede-fe0f-4888-9003-e843a4c90514

• 参数说明

  表1 参数说明

  名称	是否必选	说明
  project_id	是	租户在某一Region下的project ID。 获取方法请参见获取项目ID。
  id	是	任务ID。

请求消息

无

响应消息

• 正常响应要素说明

  表2 参数说明

  名称	参数类型	说明
  job	Object	任务信息，请参见表3。

  表3 job字段数据结构说明

  名称	参数类型	说明
  id	String	任务ID。
  name	String	任务名称。
  status	String	任务执行状态。 取值： 值为“Running”，表示任务正在执行。 值为“Completed”，表示任务执行成功。 值为“Failed”，表示任务执行失败。
  created	String	创建时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。
  ended	String	结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。
  process	String	任务执行进度。
  instance	Object	执行任务的实例信息。 请参见表4。
  entities	Object	根据不同的任务，显示不同的内容。 请参见表5
  fail_reason	String	任务执行失败时的错误信息。

  表4 instances字段数据结构说明

  名称	参数类型	说明
  id	String	实例ID。
  name	String	实例名称。

  表5 entities字段数据结构说明

  名称	参数类型	说明
  instance	Object	任务想要实现的实例信息。 请参见表6。
  resource_ids	List<String>	任务涉及到的资源ID。

  表6 entities.instance字段数据结构说明

  名称	参数类型	说明
  endpoint	String	实例的连接地址。
  type	String	实例类型。
  datastore	Object	数据库信息，请参见表7。

  表7 datastore字段数据结构说明

  名称	参数类型	说明
  type	String	数据库引擎。
  version	String	数据库版本。

  表8 entities字段数据结构说明（绑定/解绑弹性IP）

  名称	参数类型	说明
  public_ip	String	任务实现的弹性公网IP。

  

  响应样例中取任务中心部分任务作为示例。

• 正常响应样例

  {
    "job": {
      "id": "31b8ae23-c687-4d80-b7b4-42a66c9bb886",
      "name": " RestartGaussDBInstance",
      "status": "Completed",
      "created": "2018-08-06T10:41:14+0000",
      "ended": "2018-08-06T16:41:14+0000",
      "process": "",
      "instance": {
        "id": "a48e43ff268f4c0e879652d65e63d0fbin01",
        "name": "DO-NOT-TOUCH-mgr2-gaussdb"
      },
      "entities": {}
      }
  }

状态码

请参见状态码。

错误码

请参见错误码。