接口约束
4.9 备份与恢复
4.9.7 查询跨区域备份列表
"total_count": 1 }
Microsoft SQL Server样例：
{ "backups": [{
"id ": "43e4feaab48f11e89039fa163ebaa7e4br04", "name": "xxxx.xxx",
"type": "manual", "size": 2803,
"status": "COMPLETED",
"begin_time": "2018-08-06T12:41:14+0800", "end_time": "2018-08-06T12:43:14+0800", "datastore": {
"type": "SQLServer", "version": "2014_WEB"
},
"databases": [{
"name": "user01"
}, {
"name": "user02"
}],
"instance_id": "a48e43ff268f4c0e879652d65e63d0fbin04", "associated_with_ddm": false
}],
"total_count": 1 }
● 异常响应
请参见异常请求结果。
状态码
● 正常 200
● 异常
请参见状态码。
错误码
请参见错误码。
4.9.7 查询跨区域备份列表
功能介绍
在备份目标区域获取实例的跨区域备份列表。
● 调用接口前，您需要了解API 认证鉴权。
调试
您可以在API Explorer中调试该接口。
接口约束
SQL Server仅支持查询备份类型为自动全量备份和手动备份的备份列表。
URI
● URI格式
GET /v3/{project_id}/offsite-backups?
instance_id={instance_id}&backup_id={backup_id}&backup_type={backup_type }&offset={offset}&limit={limit}&begin_time={begin
_time}&end_time={end_time}
● URI样例
https://rds.cn-north-1.myhuaweicloud.com/
v3/0483b6b16e954cb88930a360d2c4e663/offsite-backups?
instance_id=43e4feaab48f11e89039fa163ebaa7e4br01&backup_id=c0c9f155c7 b7423a9d30f0175998b63bbr01&backup_type=auto&offset=0&limit=10&begin _time=2018-08-06T10:41:14+0800&end_time=2018-08-16T10:41:14+0800
● 参数说明
表4-163 参数说明
名称 是否必选 说明
project_id 是 租户在某一region下的project ID。
获取方法请参见获取项目ID。
instance_id 是 实例ID。
backup_id 否 备份ID。
backup_type 是 备份类型，取值如下：
● auto：自动全量备份和手动备份。SQL Server仅支持查询备份类型为“auto”的备 份列表。
● incremental：自动增量备份。
offset 否 索引位置，偏移量。从第一条数据偏移offset条 数据后开始查询，默认为0（偏移0条数据，表 示从第一条数据开始查询），必须为数字，不 能为负数。
limit 否 查询记录数。默认为100，不能为负数，最小值
为1，最大值为100。
begin_time 否 查询开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。
其中，T指某个时间的开始；Z指时区偏移量，
例如北京时间偏移显示为+0800。
说明“begin_time”有值时，“end_time”必选。
名称 是否必选 说明
end_time 否 查询结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”，且大于查询开始时间。
其中，T指某个时间的开始；Z指时区偏移量，
例如北京时间偏移显示为+0800。
说明“end_time”有值时，“begin_time”必选。
请求消息
无。
响应消息
● 正常响应要素说明
表4-164 要素说明
名称 参数类型 说明
backups Array of objects 备份列表。
详情请参见表4-165。
total_count Integer 总记录数。
表4-165 backups 字段数据结构说明
名称 参数类型 说明
id String 备份ID。
name String 备份名称。
type String 备份类型，仅MySQL和
PostgreSQL返回该字段。
取值如下：
● auto：自动全量备份。
● incremental：自动增量备份。
size Long 备份大小（单位：KB）。
status String 备份状态，取值如下：
● BUILDING: 备份中。
● COMPLETED: 备份完成。
● FAILED：备份失败。
● DELETING：备份删除中。
名称 参数类型 说明
databases Array of objects 用户自建库，仅Microsoft SQL Server返回该字段。
详情请参见表4-166。
begin_time String 备份开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。
其中，T指某个时间的开始；Z指 时区偏移量，例如北京时间偏移显 示为+0800。
end_time String 备份结束时间。
● 全量备份类型下，指备份结束 时间。
● MySQL增量备份类型，指备份 文件中最后一个事务的提交时 间。
格式为“yyyy-mm-ddThh:mm:ssZ”，其中，T指某 个时间的开始；Z指时区偏移量，
例如北京时间偏移显示为+0800。
datastore Object 数据库版本信息。
详情请参见表4-167。
instance_id String 备份所在实例ID。
associated_with
_ddm Boolean 是否关联DDM 标志。仅MySQL返 回该字段。
表4-166 databases 字段数据结构说明
名称 参数类型 说明
name String 用户自建数据库名。
表4-167 datastore 字段数据结构说明
名称 参数类型 说明
type String 数据库引擎，当前仅支持MySQL
和SQL Server。
version String 数据库版本。
● 正常响应样例 MySQL：
{ "backups": [{
"id": "43e4feaab48f11e89039fa163ebaa7e4br01", "name": "xxxx.xxx",
"type": "auto", "size": 2803,
"status": "COMPLETED",
"begin_time": "2018-08-06T12:41:14+0800", "end_time": "2018-08-06T12:43:14+0800", "datastore": {
"type": "MySQL", "version": "5.6"
},
"instance_id": "a48e43ff268f4c0e879652d65e63d0fbin01", "associated_with_ddm": false
"id": "43e4feaab48f11e89039fa163ebaa7e4br01", "name": "xxxx.xxx",
"type": "auto", "size": 2803,
"status": "COMPLETED",
"begin_time": "2018-08-06T12:41:14+0800", "end_time": "2018-08-06T12:43:14+0800", "datastore": {
"type": "PostgreSQL", "version": "9.6"
},
"instance_id": "a48e43ff268f4c0e879652d65e63d0fbin01"
}],
"total_count": 1 }
SQL Server：
{ "backups": [{
"id": "43e4feaab48f11e89039fa163ebaa7e4br01", "name": "xxxx.xxx",
"begin_time": "2018-08-06T12:41:14+0800", "end_time": "2018-08-06T12:43:14+0800", "datastore": {
"type": "SQLServer", "version": "2016_WEB"
},
"instance_id": "a48e43ff268f4c0e879652d65e63d0fbin01"
}], "total_count": 1 }
● 异常响应
请参见异常请求结果。
状态码
● 正常 200
● 异常
请参见状态码。
错误码
请参见错误码。