文档首页/ 云数据库 GaussDB/ API参考/ API（推荐）/ 任务管理/ 获取任务信息
更新时间：2024-08-20 GMT+08:00
查看PDF
分享

获取任务信息

功能介绍

获取指定任务ID的任务信息。

调试

您可以在API Explorer中调试该接口。

URI

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

表1 请求参数

名称

类型

是否必选

描述

project_id

String

是

参数解释：

租户在某一Region下的项目ID。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

id

String

是

参数解释：

任务ID。支持通过API接口（除“应用参数模板”、“创建手动备份”以外的）返回的异步任务ID查询任务结果。

约束限制：

不涉及

取值范围：

UUID形式。

默认取值：

不涉及。

请求参数

无。

响应参数

表2 参数说明

名称

参数类型

描述

job

Object

参数解释：

任务信息，请参见表job字段数据结构说明。
表3 job字段数据结构说明

名称

参数类型

描述

id

String

参数解释：

任务ID。

取值范围：

UUID形式。

name

String

参数解释：

任务名称。

取值范围：

不涉及。

status

String

参数解释：

任务执行状态。

取值范围：
  • 值为“Running”，表示任务正在执行。
  • 值为“Completed”，表示任务执行成功。
  • 值为“Failed”，表示任务执行失败。

created

String

参数解释：

创建时间，格式为“yyyy-mm-ddThh:mm:ssZ”。

其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。示例2021-07-12T09:22:04+0800。

取值范围：

不涉及。

ended

String

参数解释：

结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。

其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。示例2021-07-12T09:22:04+0800。

取值范围：

不涉及。

progress

String

参数解释：

任务执行进度。

取值范围：

不涉及。

说明：

执行中状态才返回执行进度，例如“60%”，表示任务执行进度为60%，否则返回“”。

instance

Object

参数解释：

执行任务的实例信息。

请参见表4。

fail_reason

String

参数解释：

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

取值范围：

不涉及。
表4 instance字段数据结构说明

名称

参数类型

描述

id

String

参数解释：

实例ID。标识实例的唯一标识。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

name

String

参数解释：

实例名称。

取值范围：

实例名称长度在4个到64个字符之间，以字母开头，可以包含字母、数字、中划线或下划线，不能包含其他特殊字符。

请求示例

获取GaussDB指定ID的任务信息。

GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/jobs?id=5cbb8a90-2253-4cff-8a13-49aa8f31dfb5

响应示例

获取任务信息成功。

{ 
  "job" : { 
    "id" : "5cbb8a90-2253-4cff-8a13-49aa8f31dfb5", 
    "name" : "CreateGaussDBV5Instance", 
    "status" : "Completed", 
    "created" : "2021-07-12T09:22:04+0800", 
    "ended" : "2021-07-12T10:10:13+0800", 
    "progress" : "", 
    "instance" : { 
      "id" : "b34f8c791f2643578510c093aa2351a8in14", 
      "name" : "gauss-c1a3" 
    }, 
    "fail_reason" : null 
  } 
}

状态码

错误码

请参见错误码。

父主题： 任务管理

相关文档