查询跨区域备份实例列表 - ListOffSiteInstances
调试
您可以在API Explorer中调试该接口。
授权信息
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
|
授权项 |
访问级别 |
资源类型（*为必须） |
条件键 |
别名 |
依赖的授权项 |
|---|---|---|---|---|---|
|
rds:instance:listAll |
read |
- |
- |
rds:instance:list |
- |
URI
- URI格式
GET /v3/backups/offsite-backup-instance?offset={offset}&limit={limit}
- 参数说明
表1 参数说明 名称
参数类型
是否必选
说明
offset
Integer
否
参数解释：
索引位置，偏移量。
约束限制：
从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。
取值范围：
大于等于0的整数。
默认取值：
0
limit
Integer
否
参数解释：
查询记录数。
约束限制：
不能为负数。
取值范围：
最小值为1，最大值为100。
默认取值：
100
请求消息
响应消息
- 正常响应要素说明
表2 参数说明 名称
参数类型
说明
offsite_backup_instances
Array of objects
参数解释：
跨区域备份实例信息。
详情请参见表3。
total_count
Integer
参数解释：
总记录数。
取值范围：
不涉及。
表3 offsite_backup_instances字段数据结构说明 名称
参数类型
说明
id
String
参数解释：
实例ID。
取值范围：
不涉及。
name
String
参数解释：
创建的实例名称。
取值范围：
不涉及。
source_region
String
参数解释：
源区域。
取值范围：
不涉及。
source_project_id
String
参数解释：
租户在源区域下的project ID。
取值范围：
不涉及。
datastore
Object
参数解释：
数据库信息。
详情请参见表4。
destination_region
String
参数解释：
跨区域备份所在区域。
取值范围：
不涉及。
destination_project_id
String
参数解释：
租户在目标区域下的project ID。
取值范围：
不涉及。
keep_days
Integer
参数解释：
跨区域备份保留天数。
取值范围：
不涉及。
- 正常响应样例
{ "total_count": 1, "offsite_backup_instances": [{ "id": "ed7cc6166ec24360a5ed5c5c9c2ed726in01", "name": "rds-instance-rep2", "source_region": "aaa", "source_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c", "datastore": { "type": "MySQLPostgreSQL", "version": "5.711" }, "destination_region": "bbb", "destination_project_id": "0503fd7f7580d3262fc5c001170fbab9", "keep_days": 7 } ] }
- 查询所有实例列表：
{ "total_count": 1, "offsite_backup_instances": [{ "id": "ed7cc6166ec24360a5ed5c5c9c2ed726in01", "name": "rds-instance-rep2", "source_region": "aaa", "source_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c", "datastore": { "type": "MySQLPostgreSQL", "version": "5.711" }, "destination_region": "bbb", "destination_project_id": "0503fd7f7580d3262fc5c001170fbab9", "keep_days": 7 } ] } - 异常响应
请参见异常请求结果。
状态码
- 正常
- 异常
请参见状态码。
错误码
请参见错误码。
