手动创建快照

功能介绍

该接口用于手动创建一个快照。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID。获取方法请参见获取项目ID和名称。
cluster_id	是	String	指定要创建快照的集群ID。

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
name	是	String	快照名称，快照名称在4位到64位之间，必须以字母开头，可以包含字母、数字、中划线或者下划线，注意字母不能大写且不能包含其他特殊字符。
description	否	String	快照描述，0～256个字符，不能包含!<>=&"'字符。
indices	否	String	指定要备份的索引名称，多个索引用逗号隔开，默认备份所有索引。支持使用“”匹配多个索引，例如：2018-06，表示备份名称前缀是2018-06的所有索引的数据。0～1024个字符，不能包含空格和大写字母，且不能包含"\<\|>/?特殊字符。

响应参数

状态码： 201

表3 响应Body参数
参数	参数类型	描述
backup	backupRsp object	快照信息。

表4 backupRsp
参数	参数类型	描述
id	String	快照id。
name	String	快照名称。

请求示例

创建快照。

POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/index_snapshot

{
  "name" : "snapshot_001",
  "indices" : "myindex1myindex2"
}

响应示例

状态码： 201

创建类的请求已成功。

{
  "backup" : {
    "id" : "9dc4f5c9-33c0-45c7-9378-ae35ae350682",
    "name" : "snapshot_101"
  }
}

状态码

状态码	描述
201	创建类的请求已成功。
400	非法请求。建议直接修改该请求，不要重试该请求。
403	请求被拒绝访问。返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。
406	服务器无法根据客户端请求的内容特性完成请求。
500	表明服务端能被请求访问到，但是不能理解用户的请求。
501	服务器不支持请求的功能，无法完成请求。