DescribeDetachedBackups - 查询已被释放的集群中备份集详情

调用DescribeDetachedBackups接口查看已删除实例的备份集列表。

接口说明

本接口适用于RDS MySQL的本地盘实例。关于如何在实例释放后保留备份，请参见自动备份。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
rds:DescribeDetachedBackups	READ	RDS acs:rds::{#accountId}:dbinstance/	无	无

请求参数

名称	类型	必填	描述	示例值
DBInstanceId	string	否	实例ID。	rm-uf6wjk5xxxxxxx
BackupId	string	否	备份集ID。	327xxxxx3
BackupStatus	string	否	备份集状态，取值： Success：已完成备份 Failed：备份失败	Success
BackupMode	string	否	备份模式，取值： Automated：系统自动备份 Manual：手动备份	Automated
StartTime	string	否	查询开始时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。	2021-03-01T16:00Z
EndTime	string	否	查询结束时间，需要大于查询开始时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。	2021-03-15T16:00Z
PageSize	integer	否	每页记录数，取值： 30 50 100 说明默认值：30。	30
PageNumber	integer	否	页码，取值：大于0且不超过Integer的最大值。说明默认值：1。	1
Region	string	是	实例所在的地域。	cn-hangzhou
ResourceGroupId	string	否	资源组ID。	rg-acfmy*****

返回参数

名称	类型	描述	示例值
	object	返回值说明。
PageNumber	string	页码。	1
RequestId	string	请求ID。	1A6D328C-84B8-40DC-BF49-6C73984D7494
PageRecordCount	string	本页备份集个数。	30
TotalRecordCount	string	总记录数。	100
Items	object []	备份集列表。
ConsistentTime	long	备份集的一致性时间点。返回值为时间戳。说明仅MySQL 5.6返回本参数，其他版本返回0。	1576506856
StoreStatus	string	该数据备份是否可删除，返回值： Enabled：可删除 Disabled：不可删除	Disabled
BackupStatus	string	备份集状态，返回值： Success：已完成备份 Failed：备份失败	Success
BackupType	string	备份类型，返回值： FullBackup：全量备份 IncrementalBackup：增量备份	FullBackup
BackupStartTime	string	本次备份开始时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。	2019-02-03T12:20:00Z
BackupDownloadURL	string	公网下载地址，若当前不可下载，则为空串。	http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/xxxxx
IsAvail	integer	备份集是否可用，返回值： 0：不可用 1：可用	1
MetaStatus	string	库表恢复的备份集状态，返回值： OK：正常。 LARGE：表数量过多，不能用于库表恢复。 EMPTY：备份失败的备份集。	OK
BackupEndTime	string	本次备份结束时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。	2019-02-13T12:20:00Z
BackupId	string	备份集ID。	321020562
HostInstanceID	string	产生备份集的实例编号，用于区分该备份集产生于主实例或备实例。	5882781
BackupIntranetDownloadURL	string	内网下载地址，若当前不可下载，则为空串。	http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/xxxxx
BackupSize	long	备份文件大小，单位：Byte。	2167808
BackupMode	string	备份模式，返回值： Automated：系统自动备份 Manual：手动备份	Automated
DBInstanceId	string	实例ID。	rm-uf6wjk5xxxxxxx
DBInstanceComment	string	实例备注。	test
BackupMethod	string	备份方式，返回值： Logical：逻辑备份 Physical：物理备份	Physical

示例

正常返回示例

JSON格式

{
  "PageNumber": "1",
  "RequestId": "1A6D328C-84B8-40DC-BF49-6C73984D7494",
  "PageRecordCount": "30",
  "TotalRecordCount": "100",
  "Items": {
    "Backup": [
      {
        "ConsistentTime": 1576506856,
        "StoreStatus": "Disabled",
        "BackupStatus": "Success",
        "BackupType": "FullBackup",
        "BackupStartTime": "2019-02-03T12:20:00Z",
        "BackupDownloadURL": "http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/xxxxx",
        "IsAvail": 1,
        "MetaStatus": "OK",
        "BackupEndTime": "2019-02-13T12:20:00Z",
        "BackupId": "321020562",
        "HostInstanceID": "5882781",
        "BackupIntranetDownloadURL": "http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/xxxxx",
        "BackupSize": 2167808,
        "BackupMode": "Automated",
        "DBInstanceId": "rm-uf6wjk5xxxxxxx",
        "DBInstanceComment": "test",
        "BackupMethod": "Physical"
      }
    ]
  }
}

错误码

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

变更历史

变更时间

变更内容概要

操作

2022-08-04

OpenAPI 入参发生变更

变更项	变更内容
入参	OpenAPI 入参发生变更
	新增入参：ResourceGroupId