查询备份列表
功能介绍
根据指定条件查询备份列表。
目前仅支持GeminiDB Cassandra查看数据备份的增量备份和差异备份文件大小和记录。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET https://{Endpoint}/v3/{project_id}/backups
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
用户在某一region下的project ID。获取方法请参见获取项目ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
offset |
是 |
Integer |
分页页码。 最小值：1 |
limit |
是 |
Integer |
每页条数。 最小值：1 最大值：100 |
datastore_type |
否 |
String |
接口类型不传该参数时则查询所有的接口。 枚举值：
|
type |
否 |
String |
备份策略类型。可取值：
|
instance_id |
否 |
String |
实例ID。不传该参数则查询所有备份列表。 |
backup_id |
否 |
String |
备份ID。 |
backup_type |
否 |
String |
备份类型。 枚举值：
|
begin_time |
否 |
String |
查询备份开始的时间，格式为“yyyy-mm-dd hh:mm:ss”。该时间为UTC时间。 |
end_time |
否 |
String |
查询备份开始的结束时间，格式为“yyyy-mm-dd hh:mm:ss”。该时间为UTC时间。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
total_count |
Long |
总记录数。 |
backups |
Array of objects |
备份信息列表。详情请参考表5。 |
参数 |
参数类型 |
描述 |
|---|---|---|
id |
String |
备份ID。 |
name |
String |
备份名称。 |
description |
String |
备份描述信息。 |
begin_time |
String |
备份开始时间，格式为“yyyy-mm-dd hh:mm:ss”。该时间为UTC时间。 |
end_time |
String |
备份结束时间，格式为“yyyy-mm-dd hh:mm:ss”。该时间为UTC时间。 |
status |
String |
备份状态。 枚举值：
|
size |
Double |
备份大小，单位：KB。 |
type |
String |
备份类型。 枚举值：
|
instance_id |
String |
实例ID。 |
instance_name |
String |
实例名称。 |
datastore |
object |
数据库信息。详情请参考表6。 |
请求示例
- URI样例
GET https://gaussdb-nosql.cn-north-7.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",
} ]
}
状态码
请参见状态码。
错误码
请参见错误码。
