查询备份列表（推荐）
功能介绍
根据指定条件查询备份列表。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET https://{Endpoint}/v3.1/{project_id}/backups
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
租户在某一region下的project ID。获取方法请参见获取项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
instance_id |
否 |
String |
实例ID，可以调用“查询实例列表”接口获取。如果未申请实例，可以调用“创建实例”接口创建。 |
|
datastore_type |
否 |
String |
数据库类型。
|
|
backup_id |
否 |
String |
备份ID。 |
|
backup_type |
否 |
String |
备份类型，大小写敏感。
|
|
type |
否 |
String |
备份策略类型。可取值:
|
|
limit |
否 |
Integer |
查询备份个数上限值。取值范围：1~100。不传该参数时，默认查询前100条实例信息。 最小值：1 最大值：100 |
|
offset |
否 |
Integer |
索引位置偏移量，表示从指定project ID下最新的备份创建时间开始，按时间的先后顺序偏移offset条数据后查询对应的备份信息。取值大于或等于0。不传该参数时，查询偏移量默认为0，表示从最新的备份创建时间对应的备份开始查询。 最小值：0 |
|
begin_time |
否 |
String |
查询备份开始的时间，为yyyy-mm-ddThh:mm:ssZ字符串格式，T指某个时间的开始，Z指时区偏移量，默认为空。
|
|
end_time |
否 |
String |
查询备份开始的结束时间，为yyyy-mm-ddThh:mm:ssZ字符串格式，T指某个时间的开始，Z指时区偏移量，默认为空。
|
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户认证token。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_count |
Integer |
备份总数量。 |
|
backups |
Array of objects |
备份详情列表。详情请参考表5。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
备份ID。 |
|
description |
String |
备份描述信息。 |
|
instance_id |
String |
备份所属的实例ID。 |
|
instance_name |
String |
备份所属的实例名称。 |
|
datastore |
object |
数据库版本信息。详情请参考表6。 |
|
name |
String |
备份名称。 |
|
type |
String |
|
|
size |
Double |
备份大小，单位：KB。 |
|
status |
String |
备份状态。取值：
|
|
begin_time |
String |
备份开始时间，为yyyy-mm-ddThh:mm:ssZ字符串格式，T指某个时间的开始，Z指时区偏移量。 |
|
end_time |
String |
备份结束时间，为yyyy-mm-ddThh:mm:ssZ字符串格式，T指某个时间的开始，Z指时区偏移量。 |
|
database_tables |
Array of objects |
备份里的库表信息。详情前参考表7。
|
请求示例
响应示例
状态码： 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" : "2019-05-27T03:38:51+0000",
"end_time" : "2019-05-27T03:39:51+0000",
"status" : "COMPLETED",
"size" : 2803,
"description" : "backup description",
"database_tables" : [ {
"database_name" : "DATABASE_X",
"table_names" : [ "TABLE_A", "TABLE_B", "TABLE_C" ]
}, {
"database_name" : "DATABASE_Y",
"table_names" : null
} ]
}, {
"id" : "43e4feaab48f11e89039fa163ebaa7e4br02",
"name" : "backup-test-2",
"instance_id" : "43e4feaab48f11e89039fa163ebaa7e4br02",
"instance_name" : "cluster-test",
"datastore" : {
"type" : "cassandra",
"version" : "3.4"
},
"type" : "Manual",
"begin_time" : "2019-05-27T03:38:51+0000",
"end_time" : "2019-05-27T03:39:51+0000",
"status" : "COMPLETED",
"size" : 2803,
"description" : "backup description",
"database_tables" : [ {
"database_name" : "DATABASE_X",
"table_names" : [ "TABLE_A", "TABLE_B", "TABLE_C" ]
}, {
"database_name" : "DATABASE_Y",
"table_names" : null
} ]
} ]
}
状态码
请参见状态码。
错误码
请参见错误码。
