调用DescribeBackups接口查询云数据库MongoDB实例的备份列表。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeBackups

系统规定参数。取值:DescribeBackups。

RegionId String cn-hangzhou

实例所属的地域ID,您可以通过调用DescribeRegions接口查询。

DBInstanceId String dds-bp1a7009eb24****

实例ID。

说明 当本参数传入的是分片集群实例ID时,还需要传入NodeId参数。
NodeId String d-bp128a003436****

分片集群实例中Shard节点的ID。

说明DBInstanceId参数传入的是分片集群实例ID时,本参数才可用。
BackupId String 2072****,2072****,2072****

备份ID,您可以通过调用CreateBackup接口查询。

DBInstanceId参数传入的是分片集群实例ID时,备份ID个数与Shard节点个数相同,中间用英文逗号(,)间隔。

PageNumber Integer 1

页码。

PageSize Integer 30

每页记录数,取值:

  • 30(默认值)
  • 50
  • 100
StartTime String 2022-01-13T13:00Z

查询开始时间,格式为yyyy-MM-ddTHH:mmZ(UTC时间)。

EndTime String 2022-01-14T13:00Z

查询结束时间,必须晚于查询开始时间,格式为yyyy-MM-ddTHH:mmZ(UTC时间)。

返回数据

名称 类型 示例值 描述
TotalCount Integer 1

备份总数。

RequestId String 275D43C3-F12F-5224-B375-0C6BF453BD56

请求ID。

PageSize Integer 30

每页记录数,取值:

  • 30(默认值)
  • 50
  • 100
PageNumber Integer 1

页码。

Backups Array of Backup

备份文件详情列表。

Backup
BackupStatus String Success

备份状态,取值说明:

  • Success:备份成功。
  • Failed:备份失败。
BackupType String FullBackup

备份类型,取值说明:

  • FullBackup:全量备份。
  • IncrementalBackup:增量备份。
BackupStartTime String 2022-01-14T03:56:17Z

本次备份开始时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

BackupIntranetDownloadURL String 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

备份文件的内网下载地址。

说明 您可以通过该地址在ECS服务器(与云数据库MongoDB实例在同一网络)上下载目标备份文件。
BackupSize Long 6168576

备份文件大小,单位:Byte。

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

备份模式,取值说明:

  • Automated:系统自动备份。
  • Manual:手动备份。
BackupEndTime String 2022-01-14T03:57:34Z

本次备份结束时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

BackupId Integer 32102****

备份ID。

BackupDBNames String database

备份的数据库名。

BackupMethod String Physical

备份方式,取值说明:

  • Snapshot:快照备份。
  • Physical:物理备份。
  • Logical:逻辑备份。

示例

请求示例

http(s)://mongodb.aliyuncs.com/?Action=DescribeBackups
&DBInstanceId=dds-bp1a7009eb24****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeBackupsResponse>
    <TotalCount>1</TotalCount>
    <RequestId>275D43C3-F12F-5224-B375-0C6BF453BD56</RequestId>
    <PageSize>30</PageSize>
    <PageNumber>1</PageNumber>
    <Backups>
        <BackupStatus>Success</BackupStatus>
        <BackupType>FullBackup</BackupType>
        <BackupStartTime>2022-01-14T03:56:17Z</BackupStartTime>
        <BackupIntranetDownloadURL>http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/custins5559*****/hins1936****_data_2022052504****_qp.xb?Expires=165361****&amp;OSSAccessKeyId=LTAI4G2wxd32KLGARfi****&amp;Signature=lkFPjOY%2F8adB18vnOCbtmT7ii****&amp;Region=cn-hangzhou</BackupIntranetDownloadURL>
        <BackupSize>6168576</BackupSize>
        <BackupDownloadURL>http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/custins5559****/hins1936****_data_2022052504****_qp.xb?Expires=165361****&amp;OSSAccessKeyId=LTAI4G2wxd32KLGARf****&amp;Signature=lkFPjOY%2F8adB18vnOCbtmT7****&amp;Region=cn-hangzhou</BackupDownloadURL>
        <BackupMode>Automated</BackupMode>
        <BackupEndTime>2022-01-14T03:57:34Z</BackupEndTime>
        <BackupDBNames>database</BackupDBNames>
        <BackupMethod>Physical</BackupMethod>
    </Backups>
</DescribeBackupsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 1,
  "RequestId" : "275D43C3-F12F-5224-B375-0C6BF453BD56",
  "PageSize" : 30,
  "PageNumber" : 1,
  "Backups" : {
    "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****&amp;OSSAccessKeyId=LTAI4G2wxd32KLGARfi****&amp;Signature=lkFPjOY%2F8adB18vnOCbtmT7ii****&amp;Region=cn-hangzhou",
    "BackupSize" : 6168576,
    "BackupDownloadURL" : "http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/custins5559****/hins1936****_data_2022052504****_qp.xb?Expires=165361****&amp;OSSAccessKeyId=LTAI4G2wxd32KLGARf****&amp;Signature=lkFPjOY%2F8adB18vnOCbtmT7****&amp;Region=cn-hangzhou",
    "BackupMode" : "Automated",
    "BackupEndTime" : "2022-01-14T03:57:34Z",
    "BackupDBNames" : "database",
    "BackupMethod" : "Physical"
  }
}

错误码

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