查询备份列表
功能介绍
根据指定条件查询备份列表。
调试
您可以在API Explorer中调试该接口。
URI
名称 |
是否必选 |
类型 |
描述 |
---|---|---|---|
project_id |
是 |
string |
参数解释: 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
instance_id |
否 |
string |
参数解释: 实例ID,可以调用“查询实例列表和详情”接口获取。如果未申请实例,可以调用“创建实例”接口创建。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
backup_id |
否 |
string |
参数解释: 备份ID。 约束限制: 当该字段传入的备份ID归属为自动增量备份时,实例ID必传。 取值范围: 不涉及。 默认取值: 不涉及。 |
backup_type |
否 |
string |
参数解释: 备份类型。 约束限制: 当该字段取值为“Incremental”时,实例ID必传。 取值范围:
默认取值: 不涉及。 |
offset |
否 |
Integer |
参数解释: 索引位置偏移量,表示从指定project ID下最新的备份创建时间开始,按时间的先后顺序偏移offset条数据后查询对应的备份信息。 约束限制: 不涉及。 取值范围: 大于或等于0。 默认取值: 0,表示从最新的备份创建时间对应的备份开始查询。 |
limit |
否 |
Integer |
参数解释: 查询备份个数上限值。 约束限制: 不涉及。 取值范围: 1~100。 默认取值: 100。不传该参数时,默认查询前100条实例信息。 |
begin_time |
否 |
string |
参数解释: 查询备份开始的时间,格式为“yyyy-mm-dd hh:mm:ss”。该时间为UTC时间。 约束限制: “end_time”有值时,“begin_time”必选。 取值范围: 不涉及。 默认取值: 不涉及。 |
end_time |
否 |
string |
参数解释: 查询备份开始的结束时间,格式为“yyyy-mm-dd hh:mm:ss”。该时间为UTC时间。 约束限制: “begin_time”有值时,“end_time”必选。 取值范围: 不涉及。 默认取值: 不涉及。 |
mode |
否 |
string |
参数解释: 实例模式。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
请求参数
名称 |
是否必选 |
类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
string |
参数解释: 从IAM服务获取的用户Token。请参考认证鉴权。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
名称 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
backups |
是 |
Array of objects |
参数解释: 备份列表。详情请参见表4。 取值范围: 不涉及。 |
total_count |
是 |
Integer |
参数解释: 总记录数。 取值范围: 不涉及。 |
名称 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
是 |
String |
参数解释: 备份ID。 取值范围: 不涉及。 |
name |
是 |
String |
参数解释: 备份名称。 取值范围: 不涉及。 |
instance_id |
是 |
String |
参数解释: 备份所属的实例ID,可以调用“查询实例列表”接口获取。如果未申请实例,可以调用“创建实例”接口创建。 取值范围: 不涉及。 |
instance_name |
是 |
String |
参数解释: 备份所属的实例名称。 取值范围: 不涉及。 |
datastore |
是 |
Object |
参数解释: 数据库版本信息。详情请参见表5。 取值范围: 不涉及。 |
type |
是 |
String |
参数解释: 备份类型。 取值范围:
|
begin_time |
是 |
String |
参数解释: 备份开始时间,格式为“yyyy-mm-dd hh:mm:ss”。该时间为UTC时间。 取值范围: 不涉及。 |
end_time |
是 |
String |
参数解释: 备份结束时间,格式为“yyyy-mm-dd hh:mm:ss”。该时间为UTC时间。 取值范围: 不涉及。 |
status |
是 |
String |
参数解释: 备份状态。 取值范围:
|
size |
是 |
Long |
参数解释: 备份大小,单位:KB。 取值范围: 不涉及。 |
description |
是 |
String |
参数解释: 备份描述。 取值范围: 不涉及。 |
请求示例
GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/backups?instance_id=a48e43ff268f4c0e879652d65e63d0fbin02
响应示例
{ "backups": [ { "id": "43e4feaab48f11e89039fa163ebaa7e4br01", "name": "backup-test", "instance_id": "43e4feaab48f11e89039fa163ebaa7e4br01", "instance_name": "cluster-test", "datastore" : { "type" : "DDS-Community", "version" : "3.4" }, "type": "auto", "begin_time": "2018-08-06 12:41:14", "end_time": "2018-08-06 12:43:14", "status": "COMPLETED", "size": 2803, "description": "backup description" } ], "total_count":1 }
SDK
单击文档数据库服务 DDS SDK,下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。
状态码
详情请参见状态码。
错误码
详情请参见错误码。