调用DescribeBackups查询实例的备份列表_云数据库 MongoDB 版(MongoDB)-阿里云帮助中心

查询MongoDB实例的备份列表。

调试

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

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
dds:DescribeBackups	get	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	无	无

请求参数

名称	类型	必填	描述	示例值
DBInstanceId	string	是	实例 ID。说明当本参数传入的是分片集群实例 ID 时，还需要传入 NodeId 参数。	dds-bp1a7009eb24****
NodeId	string	否	分片集群实例中 Shard 节点的 ID。说明当 DBInstanceId 参数传入的是分片集群实例 ID 时，本参数必填。	d-bp128a003436****
BackupId	string	否	备份 ID。当 DBInstanceId 参数传入的是分片集群实例 ID 时，备份 ID 个数与 Shard 节点个数相同，中间用英文逗号（,）间隔。	2072**,2072,2072**
PageNumber	integer	否	页码，取值为大于 0 且不超过 Integer 数据类型的最大值，默认值为 1。	1
PageSize	integer	否	每页记录数，取值： 30（默认值） 50 100	30
StartTime	string	否	查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC 时间）。	2022-01-13T13:00Z
EndTime	string	否	查询结束时间，必须晚于查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC 时间）。	2022-01-14T13:00Z
SrcRegion	string	否	实例所在地域。说明已删除实例恢复必填异地备份必填	cn-beijing
DestRegion	string	否	备份所在地域。说明异地备份必填	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object	实例备份信息。
TotalCount	integer	备份总数。	1
RequestId	string	请求 ID。	275D43C3-F12F-5224-B375-0C6BF453BD56
PageSize	integer	每页记录数，取值： 30（默认值） 50 100	30
PageNumber	integer	页码。	1
Backups	array<object>	备份文件详情列表。
Backup	object	备份文件详情列表。
BackupStatus	string	备份状态，取值说明： Success：备份成功。 Failed：备份失败。	Success
BackupType	string	备份类型，取值说明： FullBackup：全量备份。 IncrementalBackup：增量备份。	FullBackup
BackupStartTime	string	本次备份开始时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2022-01-14T03:56:17Z
BackupIntranetDownloadURL	string	备份文件的内网下载地址。说明您可以通过该地址在 ECS 服务器（与云数据库 MongoDB 实例在同一网络）上下载目标备份文件。	http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/custins5559***/hins1936_data_2022052504_qp.xb?Expires=165361&OSSAccessKeyId=LTAI4G2wxd32KLGARfi&Signature=lkFPjOY%2F8adB18vnOCbtmT7ii**&Region=cn-hangzhou
BackupSize	long	备份文件大小，单位：Byte。	6168576
BackupDownloadURL	string	备份文件的外网下载地址，若当前不可下载，则返回为空字符串。	http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/custins5559**/hins1936_data_2022052504_qp.xb?Expires=165361&OSSAccessKeyId=LTAI4G2wxd32KLGARf&Signature=lkFPjOY%2F8adB18vnOCbtmT7**&Region=cn-hangzhou
BackupMode	string	备份模式，取值说明： Automated：系统自动备份。 Manual：手动备份。	Automated
BackupEndTime	string	本次备份结束时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2022-01-14T03:57:34Z
BackupId	string	备份 ID。	32102****
BackupDBNames	string	备份的数据库名。	database
BackupMethod	string	备份方式，取值说明： Snapshot：快照备份。 Physical：物理备份。 Logical：逻辑备份。	Physical
BackupJobId	string	备份集任务 ID。	1123xxxx
BackupName	string	备份集名称(当前无效)。	12345678.tar.gz
BackupScale	string	备份粒度(当前无效)。	DBInstance
IsAvail	boolean	备份集是否可用，取值说明： 0：不可用。 1：可用。	1
EngineVersion	string	备份时的实例版本号，取值： 7.0 6.0 5.0 4.4 4.2 4.0 3.4	4.2

示例

正常返回示例

JSON格式

{
  "TotalCount": 1,
  "RequestId": "275D43C3-F12F-5224-B375-0C6BF453BD56",
  "PageSize": 30,
  "PageNumber": 1,
  "Backups": {
    "Backup": [
      {
        "BackupStatus": "Success",
        "BackupType": "FullBackup",
        "BackupStartTime": "2022-01-14T03:56:17Z",
        "BackupIntranetDownloadURL": "http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/custins5559*****/hins1936****_data_2022052504****_qp.xb?Expires=165361****&OSSAccessKeyId=LTAI4G2wxd32KLGARfi****&Signature=lkFPjOY%2F8adB18vnOCbtmT7ii****&Region=cn-hangzhou",
        "BackupSize": 6168576,
        "BackupDownloadURL": "http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/custins5559****/hins1936****_data_2022052504****_qp.xb?Expires=165361****&OSSAccessKeyId=LTAI4G2wxd32KLGARf****&Signature=lkFPjOY%2F8adB18vnOCbtmT7****&Region=cn-hangzhou",
        "BackupMode": "Automated",
        "BackupEndTime": "2022-01-14T03:57:34Z",
        "BackupId": "32102****",
        "BackupDBNames": "database",
        "BackupMethod": "Physical",
        "BackupJobId": "1123xxxx",
        "BackupName": "12345678.tar.gz",
        "BackupScale": "DBInstance",
        "IsAvail": true,
        "EngineVersion": "4.2"
      }
    ]
  }
}

错误码

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.

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

变更历史

变更时间	变更内容概要	操作
2024-10-29	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-04-12	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-03-25	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-02-22	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-12-07	OpenAPI 错误码发生变更	查看变更详情