查询快照列表
功能介绍
该接口用于查询集群的所有快照。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。
URI
GET /v1.0/{project_id}/clusters/{cluster_id}/index_snapshots
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
项目ID。获取方法请参见获取项目ID和名称。 |
cluster_id |
是 |
String |
指定需查询的快照所属的集群的ID。 |
请求参数
无
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
backups |
Array of ListSnapshotBackupsResp objects |
快照列表。 |
参数 |
参数类型 |
描述 |
|---|---|---|
created |
String |
快照创建时间。 |
datastore |
数据搜索引擎类型。 |
|
description |
String |
快照描述信息。 |
id |
String |
快照ID。 |
clusterId |
String |
集群ID。 |
clusterName |
String |
集群名字。 |
name |
String |
快照名称。 |
status |
String |
快照状态。 |
updated |
String |
快照更新时间，格式为ISO8601：CCYY-MM-DDThh:mm:ss。 |
backupType |
String |
快照创建类型：
|
backupMethod |
String |
创建快照方式。 |
backupExpectedStartTime |
String |
快照开始执行时间。 |
backupKeepDay |
Integer |
快照保留时间。 |
backupPeriod |
String |
快照每天执行的时间点。 |
indices |
String |
要备份的索引。 |
totalShards |
Integer |
要备份的索引的总shard数。 |
failedShards |
Integer |
备份失败的shard数。 |
version |
String |
快照的版本。 |
restoreStatus |
String |
快照恢复的状态。 |
startTime |
Long |
快照开始执行的时间戳。 |
endTime |
Long |
快照执行结束的时间戳。 |
bucketName |
String |
保存快照数据的桶名。 |
参数 |
参数类型 |
描述 |
|---|---|---|
type |
String |
引擎类型，目前只支持elasticsearch。 |
version |
String |
Esasticsearch引擎版本号。详细请参考CSS支持的集群版本。 |
请求示例
无
响应示例
状态码： 200
请求已成功。
{
"backups" : [ {
"created" : "2018-03-07T07:34:47",
"datastore" : {
"type" : "elasticsearch",
"version" : "x.x.x"
},
"description" : "",
"id" : "e29d99c1-3d19-4ea4-ae8d-f252df76cbe9",
"clusterId" : "37cb1075-c38e-4cd8-81df-442d52df3786",
"clusterName" : "Es-xfx",
"name" : "snapshot-002",
"status" : "COMPLETED",
"updated" : "2018-03-07T07:40:12",
"backupType" : "1",
"backupMethod" : "manual",
"backupExpectedStartTime" : null,
"backupKeepDay" : null,
"backupPeriod" : null,
"indices" : ".kibanawebsite2",
"totalShards" : 6,
"failedShards" : 0,
"version" : "x.x.x",
"restoreStatus" : "success",
"startTime" : 1520408087099,
"endTime" : 1520408412219,
"bucketName" : "obs-b8ed"
}, {
"created" : "2018-03-06T15:42:37",
"datastore" : {
"type" : "elasticsearch",
"version" : "x.x.x"
},
"description" : "",
"id" : "29a2254e-947f-4463-b65a-5f0b17515fae",
"clusterId" : "37cb1075-c38e-4cd8-81df-442d52df3786",
"clusterName" : "Es-xfx",
"name" : "snapshot-001",
"status" : "COMPLETED",
"updated" : "2018-03-06T15:48:04",
"backupType" : "1",
"backupMethod" : "manual",
"backupExpectedStartTime" : null,
"backupKeepDay" : null,
"backupPeriod" : null,
"indices" : ".kibana",
"totalShards" : 1,
"failedShards" : 0,
"version" : "x.x.x",
"restoreStatus" : "none",
"startTime" : 1520350957275,
"endTime" : 1520351284357,
"bucketName" : "obs-b8ed"
} ]
}
状态码
状态码 |
描述 |
|---|---|
200 |
请求已成功。 |
406 |
服务器无法根据客户端请求的内容特性完成请求。 |
错误码
请参见错误码。
