更新时间:2025-09-29 GMT+08:00
分享

获取异步任务详情

功能介绍

获取异步任务详情。

调用方法

请参见如何调用API

URI

GET /v3/{project_id}/instances/{instance_id}/task-center-detail

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

租户在某一Region下的project ID。

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

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

instance_id

String

参数解释

实例ID,此参数是实例的唯一标识。

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,后缀为in07,长度为36个字符。

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

job_id

String

参数解释

任务ID。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

job_name

String

参数解释

任务名称。

约束限制

不涉及。

取值范围

  • "RestoreTaurusInInstanceToExisted"表示恢复到已有实例。

  • "RestoreTaurusInInstanceToCurrent"表示恢复到当前实例。

  • "RestoreGaussDBforMySQLNewInstance"表示恢复新实例。

  • "RestoreTableTaurus"表示表级时间点实例。

默认取值

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。

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

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

X-Language

String

参数解释

请求语言类型。

约束限制

不涉及。

取值范围

  • en-us

  • zh-cn

默认取值

en-us。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

instance_id

String

参数解释

实例ID。

取值范围

不涉及。

instance_name

String

参数解释

实例名称。

取值范围

不涉及。

job_id

String

参数解释

任务ID。

取值范围

不涉及。

job_name

String

参数解释

任务名称。

取值范围

不涉及。

status

String

参数解释

任务状态。

取值范围

  • Pending:表示待执行。

  • Running:表示运行中。

  • Completed:表示已完成。

sub_task_list

Array of SubTaskInfo objects

参数解释

任务详情列表。

取值范围

不涉及。

表5 SubTaskInfo

参数

参数类型

描述

sub_task_name

String

参数解释

子任务名。

取值范围

不涉及。

percent

String

参数解释

子任务进度百分比。

取值范围

0-100。

remaining_time

String

参数解释

剩余时间,单位为秒。

取值范围

不涉及。

请求示例

获取Taurus异步任务详情。

GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/a23fb62bd61e4e9e9636fd2225f395bein07/task-center-detail

响应示例

状态码:200

Success.

{
  "instance_id" : "a23fb62bd61e4e9e9636fd2225f395bein07",
  "instance_name" : "taurusdb-12cd",
  "job_id" : "866b2273-f5ce-44bd-bc10-949baeb22163",
  "job_name" : "RestoreTaurusInInstanceToExisted",
  "sub_task_list" : [ {
    "sub_task_name" : "INIT",
    "percent" : 19,
    "status" : "complete",
    "remaining_time" : 66
  } ]
}

状态码

状态码

描述

200

Success.

错误码

请参见错误码

相关文档