文档首页/ 文档数据库服务 DDS/ API参考/ API v3（推荐）/ 任务管理/ 获取指定ID的任务信息
更新时间：2024-04-01 GMT+08:00
查看PDF
分享

获取指定ID的任务信息

接口说明

获取DDS任务中心指定ID的任务信息。

约束说明

  • 目前只支持查询DDS社区版任务中心一个月内的异步任务。
  • job生成后，通常需要数秒之后才能查询到job ID。
  • 目前支持查询的主要异步任务：创建实例（单节点/副本集/集群）、存储扩容、规格变更、节点扩容、重启、主备切换、修改内网地址、修改安全组、修改数据库端口、绑定/解绑弹性IP、切换SSL、迁移可用区、显示shard/config IP、创建物理备份/快照备份、备份恢复新实例、备份恢复到指定时间点、库表级时间点恢复、添加只读节点。

调试

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

URI

  • URI格式

    GET /v3/{project_id}/jobs?id={id}

  • URI样例

    https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/jobs?id=a9767ede-fe0f-4888-9003-e843a4c90514

请求消息

参数说明

表1 请求参数

名称

类型

IN

是否必选

描述

X-Auth-Token

string

header

是

从IAM服务获取的用户Token。请参考认证鉴权。

project_id

string

path

是

租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。

id

string

query

是

任务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。

    progress

    String

    是

    任务执行进度。

    说明：

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

    instance

    Object

    是

    执行任务的实例信息。

    请参见表4。

    fail_reason

    String

    是

    任务执行失败时的错误信息。
    表4 instance字段数据结构说明

    名称

    参数类型

    是否必选

    说明

    id

    String

    是

    实例ID。

    name

    String

    是

    实例名称。

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

  • 正常响应示例

    任务执行成功：

    {
  "job": {
    "id": "f85104b5-4a9c-4e0f-9505-fc5409d8f7ae",
    "name": "Create_MongoDB",
    "status": "Completed",
    "created": "2021-07-12T09:22:04+0000",
    "ended": "2021-07-12T10:10:13+0000",
    "progress": "",
    "instance": {
      "id": "d87f5b33049144ec95f0cab0a5f22cfbin02",
      "name": "dds-5ff4-sh"
    },
    "fail_reason": null
  }
}

    任务执行中：

    {
  "job": {
    "id": "9d10bfd1-affb-49c3-b977-298950a8d6fa",
    "name": "Create_MongoDB",
    "status": "Running",
    "created": "2021-07-13T07:28:43+0000",
    "ended": "2021-07-13T07:28:53+0000",
    "progress": "9%",
    "instance": {
      "id": "cf538a2dd8ec4b26860b27060902712fin02",
      "name": "dds-3a98-wcc"
    },
    "fail_reason": null
  }
}

    任务执行失败：

    {
  "job": {
    "id": "a03b1b8a-b756-467c-8a49-38720c3d23ec",
    "name": "Restore_MongoDB_Replica",
    "status": "Failed",
    "created": "2021-07-13T04:55:58+0000",
    "ended": "2021-07-13T05:20:04+0000",
    "progress": "",
    "instance": {
      "id": "7beb15d5db9c4742b7c817789244844ein02",
      "name": "lenn-v3-restore-4"
    },
    "fail_reason": "升级DB Agent失败。"
  }
}

SDK

单击文档数据库服务 DDS SDK，下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。

状态码

详情请参见状态码。

错误码

详情请参见错误码。

父主题： 任务管理

相关文档