文档首页> 云数据库 GaussDB(for MySQL)> API参考> API（推荐）> 任务中心> 获取指定ID的任务信息
更新时间：2023-10-23 GMT+08:00
在线调试
CLI示例
查看PDF

获取指定ID的任务信息

功能介绍

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

接口约束

  • 该接口只可查询任务中心一个月内的异步任务。
  • job生成后，通常需要数秒之后才能查询到job ID。

URI

GET /v3/{project_id}/jobs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的project ID。

获取方法请参见获取项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

id

是

String

任务ID。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

否

String

请求语言类型。默认en-us。

取值范围：

  • en-us
  • zh-cn

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

job

GetJobInfoDetail object

任务信息。
表5 GetJobInfoDetail

参数

参数类型

描述

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

任务执行进度。执行中状态才返回执行进度，例如60%，否则返回""。

instance

GetJobInstanceInfoDetail object

指定ID任务的实例信息。

entities

Object

根据不同的任务，显示不同的内容。

fail_reason

String

任务执行失败时的错误信息。
表6 GetJobInstanceInfoDetail

参数

参数类型

描述

id

String

实例ID。

name

String

实例名称。

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

获取指定ID的任务信息。

GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/jobs?id=a9767ede-fe0f-4888-9003-e843a4c90514

响应示例

状态码： 200

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

Success.

{
  "job" : {
    "id" : "31b8ae23-c687-4d80-b7b4-42a66c9bb886",
    "name" : "CreateGaussDBforMySQLInstance",
    "status" : "Completed",
    "created" : "2018-08-06T10:41:14+0800",
    "ended" : "2018-08-06T16:41:14+0000",
    "process" : "",
    "instance" : {
      "id" : "a48e43ff268f4c0e879652d65e63d0fbin07",
      "name" : "DO-NOT-TOUCH-mgr2-mysql-single"
    },
    "entities" : {
      "instance" : {
        "endpoint" : "192.168.1.203:3306",
        "type" : "Cluster",
        "datastore" : {
          "type" : "gaussdb-mysql",
          "version" : "8.0"
        }
      },
      "resource_ids" : [ "a48e43ff268f4c0e879652d65e63d0fbin07.vm", "a48e43ff268f4c0e879652d65e63d0fbin07.volume" ]
    }
  }
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 任务中心