文档首页/ 文档数据库服务 DDS/ API参考/ API v3（推荐）/ 任务管理/ 查询任务列表和详情
更新时间：2023-11-08 GMT+08:00
查看PDF
分享

查询任务列表和详情

接口说明

根据指定条件查询任务中心中的任务列表和详情。

约束说明

  • 目前只支持查询DDS社区版任务中心一个月内的异步任务。

调试

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

URI

  • URI格式

    GET https://{Endpoint}/v3.1/{project_id}/jobs

  • URI样例

    https://dds.cn-north-1.myhuaweicloud.com/v3.1/0549b4a43100d4f32f51c01c2fe4acdb/jobs

表1 请求参数

名称

类型

IN

是否必选

描述

X-Auth-Token

string

header

是

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

project_id

string

path

是

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

名称

是否必选

参数类型

说明

start_time

是

String

查询开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。

其中，T指某个时间的开始，Z指时区偏移量

end_time

是

String

查询结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”，且大于查询开始时间，时间跨度不超过30天。

其中，T指某个时间的开始，Z指时区偏移量。

status

否

String

任务状态：取值为“Running”为执行中；取值为“Completed”为完成；取值为“Failed”为失败。

id

否

String

任务ID。

name

否

String

任务名称。对应取值如下：

  • CreateMongoDB：创建集群实例。
  • CreateMongoDBReplica：创建副本集实例。
  • CreateMongoDBReplicaSingle：创建单节点实例。
  • EnlargeMongoDBVolume：磁盘扩容。
  • ResizeMongoDBInstance：社区版实例规格变更。
  • ResizeDfvMongoDBInstance：社区增强版实例规格变更。
  • EnlargeMongoDBGroup：添加节点。
  • ReplicaSetEnlargeNode：副本集添加备节点。
  • AddReadonlyNode：添加只读节点。
  • RestartInstance：重启集群实例。
  • RestartGroup：重启集群节点组。
  • RestartNode：重启集群节点。
  • RestartReplicaSetInstance：重启副本集实例。
  • RestartReplicaSingleInstance：重启单节点实例。
  • SwitchPrimary：主备切换。
  • ModifyIp：修改内网地址。
  • ModifySecurityGroup：修改安全组。
  • ModifyPort：修改数据库端口。
  • BindPublicIP：绑定弹性IP。
  • UnbindPublicIP：解绑弹性IP。
  • SwitchInstanceSSL：切换SSL。
  • AzMigrate：迁移可用区。
  • CreateIp：显示shard/config IP。
  • ModifyOpLogSize：修改oplog大小。
  • RestoreMongoDB：集群恢复到新实例。
  • RestoreMongoDB_Replica：副本集恢复到新实例。
  • RestoreMongoDB_Replica_Single：单节点恢复到新实例。
  • RestoreMongoDB_Replica_PITR：副本集恢复到指定时间点。
  • MongodbSnapshotBackup：创建物理备份。
  • MongodbSnapshotEBackup：创建快照备份。
  • MongodbRestoreData2CurrentInstance：备份恢复到当前实例。
  • MongodbRestoreData2NewInstance：备份恢复到新实例。
  • MongodbPitr2CurrentInstance：备份恢复到当前实例指定时间点。
  • MongodbPitr2NewInstance：备份恢复到新实例指定时间点。
  • MongodbRecycleBackup：备份回收。
  • MongodbRestoreTable：库表级时间点恢复。
  • UpgradeDatabaseVersion：升级数据库补丁。

offset

否

Integer

索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。

limit

否

Integer

查询记录数。默认为100，不能为负数，最小值为1，最大值为100。

请求消息

无。

响应消息

  • 参数说明
    表3 响应Body参数

    参数

    参数类型

    说明

    jobs

    Array of 表5-5 objects

    任务列表。

    total_count

    Integer

    任务列表总数。
    表4 job

    参数

    参数类型

    说明

    id

    String

    任务ID。

    name

    String

    任务名称。

    instance_id

    String

    实例ID。

    instance_name

    String

    实例名称。

    status

    String

    任务状态。取值为“Running”为执行中；取值为“Completed”为完成；取值为“Failed”为失败。

    progress

    String

    任务执行进度。

    说明：

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

    fail_reason

    String

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

    created_at

    String

    创建时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。

    ended_at

    String

    结束时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。
  • 响应示例 
    {
    "jobs": [
        {
            "id": "2f406db7-bdc4-402f-9dc4-2c1b094a5f93",
            "name": "RestartReplicaSetInstance",
            "status": "Completed",
            "created_at": "2022-09-05T06:24:14+0000",
            "ended_at": "2022-09-05T06:25:43+0000",
            "progress": "",
            "instance_id": "1f311e6a299345d7bbc878874844e233in02",
            "instance_name": "dds-6be2-fwyrestore",
            "fail_reason": ""
        }
    ]
}

SDK

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

状态码

详情请参见状态码。

错误码

详情请参见错误码。

父主题： 任务管理

相关文档