查询备份列表
功能介绍
根据指定条件查询备份列表。
目前仅支持GeminiDB Cassandra查看数据备份的增量备份和差异备份文件大小和记录。
URI
GET /v3/{project_id}/backups
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 租户在某一region下的project ID。获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
是 |
Integer |
参数解释: 分页页码。 约束限制: 不涉及。 取值范围: 取值大于等于1。 默认取值: 不涉及。 |
|
limit |
是 |
Integer |
参数解释: 每页条数。 约束限制: 不涉及。 取值范围: 1-100。 默认取值: 不涉及。 |
|
datastore_type |
否 |
String |
参数解释: 接口类型。 取值范围:
默认取值: 不传该参数时则查询所有的接口。 |
|
type |
否 |
String |
参数解释: 备份策略类型。 取值范围:
默认取值: “Instance”。 |
|
instance_id |
否 |
String |
参数解释: 实例ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不传该参数则查询所有备份列表。 |
|
backup_id |
否 |
String |
参数解释: 备份ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不传该参数则查询所有备份列表。 |
|
backup_type |
否 |
String |
参数解释: 备份类型。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
|
begin_time |
否 |
String |
参数解释: 查询备份开始的时间。 约束限制: 该时间为UTC时间。 取值范围: 格式为“yyyy-mm-dd hh:mm:ss”。 默认取值: 不涉及。 |
|
end_time |
否 |
String |
参数解释: 查询备份开始的结束时间。 约束限制: 该时间为UTC时间。 取值范围: 格式为“yyyy-mm-dd hh:mm:ss”。 默认取值: 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码: 202
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_count |
Long |
参数解释: 总记录数。 取值范围: 不涉及。 |
|
backups |
Array of objects |
参数解释: 备份信息列表。详情请参考表5。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: 备份ID。 取值范围: 不涉及。 |
|
name |
String |
参数解释: 备份名称。 取值范围: 不涉及。 |
|
description |
String |
参数解释: 备份描述信息。 取值范围: 不涉及。 |
|
begin_time |
String |
参数解释: 备份开始时间。 约束限制: 该时间为UTC时间,格式为“yyyy-mm-dd hh:mm:ss”。 |
|
end_time |
String |
参数解释: 备份结束时间。 约束限制: 该时间为UTC时间,格式为“yyyy-mm-dd hh:mm:ss”。 |
|
status |
String |
参数解释: 备份状态。 取值范围:
|
|
size |
Double |
参数解释: 备份大小,单位:KB。 取值范围: 不涉及。 |
|
type |
String |
参数解释: 备份类型。 取值范围:
|
|
instance_id |
String |
参数解释: 实例ID。 取值范围: 不涉及。 |
|
instance_name |
String |
参数解释: 实例名称。 取值范围: 不涉及。 |
|
datastore |
object |
参数解释: 数据库信息。详情请参考表6。 |
请求示例
- URI样例
GET https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/054b61972980d4552f0bc00ac8d3f5cd/backups?instance_id=c0c9f155c7b7423a9d30f0175998b63bin01&offset=2&limit=2&begin_time=2018-07-06 10:41:14&end_time=2018-08-16 10:41:14&type=DatabaseTable
- 数据备份的增量备份文件大小和记录
GET https://{Endpoint}/v3/2900b7b8d03e4619b8db8d43bc6234ee/backups?offset=1&limit=5&backup_type=Incremental&instance_id=3149aee486d748f68db1ee81e95b9f56in06 - 数据备份的差异备份文件大小和记录
GET https://{Endpoint}/v3/2900b7b8d03e4619b8db8d43bc6234ee/backups?offset=1&limit=5&backup_type=Differential&instance_id=3149aee486d748f68db1ee81e95b9f56in06 - 请求体样例
响应示例
状态码: 200
Success
{
"total_count" : 4,
"backups" : [ {
"id" : "43e4feaab48f11e89039fa163ebaa7e4br01",
"name" : "backup-test",
"instance_id" : "43e4feaab48f11e89039fa163ebaa7e4br01",
"instance_name" : "cluster-test",
"datastore" : {
"type" : "cassandra",
"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",
}, {
"id" : "43e4feaab48f11e89039fa163ebaa7e4br02",
"name" : "backup-test-2",
"instance_id" : "43e4feaab48f11e89039fa163ebaa7e4br02",
"instance_name" : "cluster-test",
"datastore" : {
"type" : "cassandra",
"version" : "3.4"
},
"type" : "Manual",
"begin_time" : "2018-08-06 12:41:14",
"end_time" : "2018-08-06 12:43:14",
"status" : "COMPLETED",
"size" : 2803,
"description" : "backup description",
} ]
}
状态码
请参见状态码。
错误码
请参见错误码。