AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 云数据库 MongoDB 版 开发参考 API参考指南 API目录 备份与恢复 DescribeClusterBackups - 查询集群备份集列表

DescribeClusterBackups - 查询集群备份集列表

更新时间：
产品详情
我的收藏

查询云数据库 MongoDB 版云盘版分片集群的集群备份集列表。

接口说明

2023 年 10 月 19 日前新建的云盘版分片集群实例，在调用前本接口前，需要调用 TransferClusterBackup 接口，完成分片备份到集群备份的转换。

2023 年 10 月 19 日之后新建的云盘版分片集群实例，默认使用集群备份。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dds:DescribeClusterBackups

get

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}

 无 无

请求参数

名称

类型

必填

描述

示例值
DBInstanceId

string

是

实例 ID。

dds-bp16cb162771****
BackupId

string

否

集群备份 ID。

5664****
PageNo

integer

否

分页页号。默认值为 1，取值范围为正整数。

1
PageSize

integer

否

每页记录数，取值：

  • 30（默认值）

  • 50

  • 100

30
StartTime

string

否

查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC 时间）。

说明

当传入 BackupId 时，此参数无效。

2019-03-13T12:11Z
EndTime

string

否

查询结束时间，必须晚于查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC 时间）。

说明

当传入 BackupId 时，此参数无效。

2019-03-14T13:10Z
IsOnlyGetClusterBackUp

boolean

否

是否查询集群备份下的子节点信息。取值说明：

  • true：只返回集群备份基本信息，不返回全量的子节点的备份信息。

  • false（默认 ）：返回全量的子节点的备份信息。

true
SrcRegion

string

否

实例所在地域。

说明

  • 查询已释放实例的备份集列表式，该参数必填。

  • 查询异地备份时，该参数必填。

cn-hangzhou
DestRegion

string

否

异地备份所在地域。

说明

查询异地备份时，该参数必填。

cn-shanghai

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

请求 ID。

2F42BB4E-461F-5B55-A37C-53B1141C****
MaxResults

integer

本次请求所返回的最大记录条数。

10
PageNumber

integer

页码。

1
PageSize

integer

每页最大记录数量。

30
ClusterBackups

array<object>

集群备份集列表，一个集群备份里面包含各个节点的备份集。

object

集群备份集列表，一个集群备份里面包含各个节点的备份集。

IsAvail

integer

集群备份集是否有效，取值说明：

  • 1：集群的备份集有效。

  • 0：子节点的备份集未完成或者失败。

1
ClusterBackupId

string

集群备份集 ID。

cb-o8c2ugnxo26kx***
ClusterBackupStatus

string

集群备份集状态。

OK
ClusterBackupStartTime

string

集群备份开始时间。

2023-10-16T19:33:20Z
ClusterBackupSize

string

集群备份集大小，单位为 Byte。

107374182400
ClusterBackupEndTime

string

集群备份结束时间。

2023-10-16T19:33:20Z
ClusterBackupMode

string

集群备份模式。

Automated
ExtraInfo

object

补充信息，为 JSON 格式。

RegistryFromHistory

string

是否来自于历史备份集，为 1 则表示是从历史备份集迁移过来的。

1
Backups

array<object>

单个集群备份集下，各个子节点的备份集集合。

object

单个集群备份集下，各个子节点的备份集集合。

BackupId

string

备份 ID。

738025367
InstanceName

string

MongoDB 分片名称。

d-bp16cb162771****

BackupDownloadURL

string

备份文件的外网下载地址，若当前不可下载，则返回为空字符串。

http://oss.com/xxx
BackupIntranetDownloadURL

string

内网下载地址，若当前不可下载，则返回空值。

http://oss.com/xxx
BackupStartTime

string

本次备份开始时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

2023-10-16T19:33:20Z
BackupEndTime

string

本次备份结束时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

2023-10-16T19:33:20Z
BackupSize

string

备份文件大小，单位为 Byte。

77544597650
IsAvail

string

备份集是否可用，取值说明：

  • 0：不可用。

  • 1：可用。

1
BackupStatus

string

备份状态，取值说明：

  • Success：备份成功。

  • Failed：备份失败。

Success
BackupName

string

备份名称。

12345678.tar.gz
ExtraInfo

object

备份关联的实例节点信息。

NodeId

string

节点 ID。

d-2ze75ab1fa5d****
StorageSize

string

节点的存储空间大小，单位为 MB。

20480
InstanceClass

string

节点规格。

mdb.shard.4x.large.d
NodeType

string

节点类型。

db
Progress

string

备份进度，单位为%。 仅正在运行的备份才会显示进度。

50
AttachLogStatus

string

备份的状态，取值如下：

  • Init：初始化。

  • No_Need：无附加日志备份。

  • Running：附加日志备份中。

  • Ready：附加日志备份完成。

  • Failed：附加日志备份失败。

说明

当 ClusterBackupStatus 参数（集群备份集的状态）的值为 OK 时，仅表示全量备份阶段执行成功了，对于开启了日志备份的集群实例，想要使用按时间点恢复或满足一致性恢复的效果时，需要附加日志备份完成。

Ready
EngineVersion

string

备份时的实例版本号，取值：

  • 7.0

  • 6.0

  • 5.0

  • 4.4

  • 4.2

  • 4.0

  • 3.4

4.2
BackupExpireTime

string

备份过期时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

重要

"9999-01-01T00:00:00Z"表示长期保留。

2025-03-29T03:47:12Z

示例

正常返回示例

JSON格式

{
  "RequestId": "2F42BB4E-461F-5B55-A37C-53B1141C****",
  "MaxResults": 10,
  "PageNumber": 1,
  "PageSize": 30,
  "ClusterBackups": [
    {
      "IsAvail": 1,
      "ClusterBackupId": "cb-o8c2ugnxo26kx***",
      "ClusterBackupStatus": "OK",
      "ClusterBackupStartTime": "2023-10-16T19:33:20Z",
      "ClusterBackupSize": "107374182400",
      "ClusterBackupEndTime": "2023-10-16T19:33:20Z",
      "ClusterBackupMode": "Automated",
      "ExtraInfo": {
        "RegistryFromHistory": "1"
      },
      "Backups": [
        {
          "BackupId": "738025367",
          "InstanceName": "d-bp16cb162771****\n",
          "BackupDownloadURL": "http://oss.com/xxx",
          "BackupIntranetDownloadURL": "http://oss.com/xxx",
          "BackupStartTime": "2023-10-16T19:33:20Z",
          "BackupEndTime": "2023-10-16T19:33:20Z",
          "BackupSize": "77544597650",
          "IsAvail": "1",
          "BackupStatus": "Success",
          "BackupName": "12345678.tar.gz",
          "ExtraInfo": {
            "NodeId": "d-2ze75ab1fa5d****",
            "StorageSize": "20480",
            "InstanceClass": "mdb.shard.4x.large.d",
            "NodeType": "db"
          }
        }
      ],
      "Progress": "50",
      "AttachLogStatus": "Ready",
      "EngineVersion": "4.2",
      "BackupExpireTime": "2025-03-29T03:47:12Z"
    }
  ]
}

错误码

HTTP status code

错误码

错误信息

描述
400 InvalidStartTime.Malformed The Specified parameter StartTime is not valid.
400 InvalidEndTime.Malformed The Specified parameter EndTime is not valid.
400 InvalidStartTimeAndEndTime.Malformed The Specified parameter StartTime or EndTime is not valid.
400 InvalidPageSize.Malformed The specified parameter PageSize is not valid.

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。

上一篇：TransferClusterBackup - 切换至集群备份模式下一篇：DescribeClusterRecoverTime - 查询分片集群可恢复时间段