调用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

页码，取值为大于0且不超过Integer数据类型的最大值，默认值为1。

PageSize Integer 否 30

每页记录数，取值： 30、50、100，默认值为30。

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

每页记录数。
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/custins5739****/hins2012****_data_2022011411****.tar.gz?Expires=1642305980&OSSAccessKeyId=STS.NUKQKxJ4tD5GDas7tAbNzjtDv&Signature=ugC4Ayeu%2FtvnUoiZ44tbdYuk%2Fhw%3D&Region=cn-hangzhou&security-token=CAISrAJ1q6Ft5B2yfSjIr5b%2BGvHMp%2BtV8%2FesRkfC03QUbsFWhbHvlDz2IHpNfXZuAuEctvo%2BnGtR5%2F8clqBZQpRGWFTtdcooORnXTIzmMeT7oMWQweEun%2F%2FMQBqBaXPS2MvVfJ%2B2Lrf0ceusbFbpjzJ6xaCAGxypQ12iN%2B%2Fu6%2Ftgdc9FcQSkSjBECdxKXCsAzvUXLnzML%2F2gHwf3i27LdipStxF7lHl05Nb7oI%2BV4QGMi0bhmK1H5dbrLoOuZsopPIU6TYzy1%2FFtaqvHy3MPsEkWqfopy%2B5mgW6X4ozGUwgIuETfb7eEo4JVQVUnNvRgKcltt%2BPhkPB0gOvXmrnsxgxFVeMvCH6GHd%2F%2Bm5qeQL34bo1gJO%2BlIRPWzsvKLIawtBg%2FJGgcMA5aulu44uXTwncagAGHr6cxrs3IqdZKz4Th934nmKfWPSMgpOznI%2FsrG7ALpNEsfl2SvzXAGL9pefuxmV2x%2BpEUFDjuvEEfNgjGw%2BZExTp%2FSLJpbGjMiHwmMJIrqv7IVmfT2X%2BasGq6A9ukU3x361%2FxC1Ayq8i8YfjKMoKtrJMKu9lC2Bc925x9QwkMUQ%3D%3D

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

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

备份文件大小，单位为Byte。
BackupDownloadURL String http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/custins5739****/hins2012****_data_2022011411****.tar.gz?Expires=1642305980&OSSAccessKeyId=STS.NUKQKxJ4tD5GDas7tAbNzjtDv&Signature=ugC4Ayeu%2FtvnUoiZ44tbdYuk%2Fhw%3D&Region=cn-hangzhou&security-token=CAISrAJ1q6Ft5B2yfSjIr5b%2BGvHMp%2BtV8%2FesRkfC03QUbsFWhbHvlDz2IHpNfXZuAuEctvo%2BnGtR5%2F8clqBZQpRGWFTtdcooORnXTIzmMeT7oMWQweEun%2F%2FMQBqBaXPS2MvVfJ%2B2Lrf0ceusbFbpjzJ6xaCAGxypQ12iN%2B%2Fu6%2Ftgdc9FcQSkSjBECdxKXCsAzvUXLnzML%2F2gHwf3i27LdipStxF7lHl05Nb7oI%2BV4QGMi0bhmK1H5dbrLoOuZsopPIU6TYzy1%2FFtaqvHy3MPsEkWqfopy%2B5mgW6X4ozGUwgIuETfb7eEo4JVQVUnNvRgKcltt%2BPhkPB0gOvXmrnsxgxFVeMvCH6GHd%2F%2Bm5qeQL34bo1gJO%2BlIRPWzsvKLIawtBg%2FJGgcMA5aulu44uXTwncagAGHr6cxrs3IqdZKz4Th934nmKfWPSMgpOznI%2FsrG7ALpNEsfl2SvzXAGL9pefuxmV2x%2BpEUFDjuvEEfNgjGw%2BZExTp%2FSLJpbGjMiHwmMJIrqv7IVmfT2X%2BasGq6A9ukU3x361%2FxC1Ayq8i8YfjKMoKtrJMKu9lC2Bc925x9QwkMUQ%3D%3D

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

备份模式。

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

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

BackupId Integer 1111111111

备份ID。
BackupDBNames String config,myNewDB

备份的数据库名。
BackupMethod String Physical

备份方式。

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

示例

请求示例

http(s)://mongodb.aliyuncs.com/?Action=DescribeBackups
&DBInstanceId=dds-bp1a7009eb24****
&NodeId=d-bp128a00****
&BackupId=2072****
&StartTime=2022-01-13T13:00Z
&EndTime=2022-01-14T13:00Z
&<公共请求参数>

正常返回示例

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>
        <Backup>
            <BackupMethod>Physical</BackupMethod>
            <BackupDownloadURL>http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/custins5739****/hins2012****_data_2022011411****.tar.gz?Expires=1642305980&amp;OSSAccessKeyId=STS.NUKQKxJ4tD5GDas7tAbNzjtDv&amp;Signature=ugC4Ayeu%2FtvnUoiZ44tbdYuk%2Fhw%3D&amp;Region=cn-hangzhou&amp;security-token=CAISrAJ1q6Ft5B2yfSjIr5b%2BGvHMp%2BtV8%2FesRkfC03QUbsFWhbHvlDz2IHpNfXZuAuEctvo%2BnGtR5%2F8clqBZQpRGWFTtdcooORnXTIzmMeT7oMWQweEun%2F%2FMQBqBaXPS2MvVfJ%2B2Lrf0ceusbFbpjzJ6xaCAGxypQ12iN%2B%2Fu6%2Ftgdc9FcQSkSjBECdxKXCsAzvUXLnzML%2F2gHwf3i27LdipStxF7lHl05Nb7oI%2BV4QGMi0bhmK1H5dbrLoOuZsopPIU6TYzy1%2FFtaqvHy3MPsEkWqfopy%2B5mgW6X4ozGUwgIuETfb7eEo4JVQVUnNvRgKcltt%2BPhkPB0gOvXmrnsxgxFVeMvCH6GHd%2F%2Bm5qeQL34bo1gJO%2BlIRPWzsvKLIawtBg%2FJGgcMA5aulu44uXTwncagAGHr6cxrs3IqdZKz4Th934nmKfWPSMgpOznI%2FsrG7ALpNEsfl2SvzXAGL9pefuxmV2x%2BpEUFDjuvEEfNgjGw%2BZExTp%2FSLJpbGjMiHwmMJIrqv7IVmfT2X%2BasGq6A9ukU3x361%2FxC1Ayq8i8YfjKMoKtrJMKu9lC2Bc925x9QwkMUQ%3D%3D</BackupDownloadURL>
            <BackupIntranetDownloadURL>http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/custins5739****/hins2012****_data_2022011411****.tar.gz?Expires=1642305980&amp;OSSAccessKeyId=STS.NUKQKxJ4tD5GDas7tAbNzjtDv&amp;Signature=ugC4Ayeu%2FtvnUoiZ44tbdYuk%2Fhw%3D&amp;Region=cn-hangzhou&amp;security-token=CAISrAJ1q6Ft5B2yfSjIr5b%2BGvHMp%2BtV8%2FesRkfC03QUbsFWhbHvlDz2IHpNfXZuAuEctvo%2BnGtR5%2F8clqBZQpRGWFTtdcooORnXTIzmMeT7oMWQweEun%2F%2FMQBqBaXPS2MvVfJ%2B2Lrf0ceusbFbpjzJ6xaCAGxypQ12iN%2B%2Fu6%2Ftgdc9FcQSkSjBECdxKXCsAzvUXLnzML%2F2gHwf3i27LdipStxF7lHl05Nb7oI%2BV4QGMi0bhmK1H5dbrLoOuZsopPIU6TYzy1%2FFtaqvHy3MPsEkWqfopy%2B5mgW6X4ozGUwgIuETfb7eEo4JVQVUnNvRgKcltt%2BPhkPB0gOvXmrnsxgxFVeMvCH6GHd%2F%2Bm5qeQL34bo1gJO%2BlIRPWzsvKLIawtBg%2FJGgcMA5aulu44uXTwncagAGHr6cxrs3IqdZKz4Th934nmKfWPSMgpOznI%2FsrG7ALpNEsfl2SvzXAGL9pefuxmV2x%2BpEUFDjuvEEfNgjGw%2BZExTp%2FSLJpbGjMiHwmMJIrqv7IVmfT2X%2BasGq6A9ukU3x361%2FxC1Ayq8i8YfjKMoKtrJMKu9lC2Bc925x9QwkMUQ%3D%3D</BackupIntranetDownloadURL>
            <BackupSize>6168576</BackupSize>
            <BackupMode>Manual</BackupMode>
            <BackupEndTime>2022-01-14T03:57:34Z</BackupEndTime>
            <BackupStartTime>2022-01-14T03:56:17Z</BackupStartTime>
            <BackupType>FullBackup</BackupType>
            <BackupId>1111111111</BackupId>
            <BackupDBNames>config,myNewDB</BackupDBNames>
            <BackupStatus>Success</BackupStatus>
        </Backup>
    </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" : {
    "Backup" : [ {
      "BackupMethod" : "Physical",
      "BackupDownloadURL" : "http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/custins5739****/hins2012****_data_2022011411****.tar.gz?Expires=1642305980&OSSAccessKeyId=STS.NUKQKxJ4tD5GDas7tAbNzjtDv&Signature=ugC4Ayeu%2FtvnUoiZ44tbdYuk%2Fhw%3D&Region=cn-hangzhou&security-token=CAISrAJ1q6Ft5B2yfSjIr5b%2BGvHMp%2BtV8%2FesRkfC03QUbsFWhbHvlDz2IHpNfXZuAuEctvo%2BnGtR5%2F8clqBZQpRGWFTtdcooORnXTIzmMeT7oMWQweEun%2F%2FMQBqBaXPS2MvVfJ%2B2Lrf0ceusbFbpjzJ6xaCAGxypQ12iN%2B%2Fu6%2Ftgdc9FcQSkSjBECdxKXCsAzvUXLnzML%2F2gHwf3i27LdipStxF7lHl05Nb7oI%2BV4QGMi0bhmK1H5dbrLoOuZsopPIU6TYzy1%2FFtaqvHy3MPsEkWqfopy%2B5mgW6X4ozGUwgIuETfb7eEo4JVQVUnNvRgKcltt%2BPhkPB0gOvXmrnsxgxFVeMvCH6GHd%2F%2Bm5qeQL34bo1gJO%2BlIRPWzsvKLIawtBg%2FJGgcMA5aulu44uXTwncagAGHr6cxrs3IqdZKz4Th934nmKfWPSMgpOznI%2FsrG7ALpNEsfl2SvzXAGL9pefuxmV2x%2BpEUFDjuvEEfNgjGw%2BZExTp%2FSLJpbGjMiHwmMJIrqv7IVmfT2X%2BasGq6A9ukU3x361%2FxC1Ayq8i8YfjKMoKtrJMKu9lC2Bc925x9QwkMUQ%3D%3D",
      "BackupIntranetDownloadURL" : "http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/custins5739****/hins2012****_data_2022011411****.tar.gz?Expires=1642305980&OSSAccessKeyId=STS.NUKQKxJ4tD5GDas7tAbNzjtDv&Signature=ugC4Ayeu%2FtvnUoiZ44tbdYuk%2Fhw%3D&Region=cn-hangzhou&security-token=CAISrAJ1q6Ft5B2yfSjIr5b%2BGvHMp%2BtV8%2FesRkfC03QUbsFWhbHvlDz2IHpNfXZuAuEctvo%2BnGtR5%2F8clqBZQpRGWFTtdcooORnXTIzmMeT7oMWQweEun%2F%2FMQBqBaXPS2MvVfJ%2B2Lrf0ceusbFbpjzJ6xaCAGxypQ12iN%2B%2Fu6%2Ftgdc9FcQSkSjBECdxKXCsAzvUXLnzML%2F2gHwf3i27LdipStxF7lHl05Nb7oI%2BV4QGMi0bhmK1H5dbrLoOuZsopPIU6TYzy1%2FFtaqvHy3MPsEkWqfopy%2B5mgW6X4ozGUwgIuETfb7eEo4JVQVUnNvRgKcltt%2BPhkPB0gOvXmrnsxgxFVeMvCH6GHd%2F%2Bm5qeQL34bo1gJO%2BlIRPWzsvKLIawtBg%2FJGgcMA5aulu44uXTwncagAGHr6cxrs3IqdZKz4Th934nmKfWPSMgpOznI%2FsrG7ALpNEsfl2SvzXAGL9pefuxmV2x%2BpEUFDjuvEEfNgjGw%2BZExTp%2FSLJpbGjMiHwmMJIrqv7IVmfT2X%2BasGq6A9ukU3x361%2FxC1Ayq8i8YfjKMoKtrJMKu9lC2Bc925x9QwkMUQ%3D%3D",
      "BackupSize" : 6168576,
      "BackupMode" : "Manual",
      "BackupEndTime" : "2022-01-14T03:57:34Z",
      "BackupStartTime" : "2022-01-14T03:56:17Z",
      "BackupType" : "FullBackup",
      "BackupId" : 1111111111,
      "BackupDBNames" : "config,myNewDB",
      "BackupStatus" : "Success"
    } ]
  }
}

错误码

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