手动创建快照 - CreateSnapshot
功能介绍
CSS服务的快照备份功能为Elasticsearch集群提供数据保护和恢复能力。通过快照备份,可以将集群的数据状态保存到OBS桶中,以便在需要时进行恢复。CSS集群快照分为两种方式:自动创建快照和手动创建快照。
-
自动创建快照:按照预设的时间策略自动执行快照备份操作,适合定期备份场景,例如每日或每周备份,以确保数据的持续保护。通过设置自动快照策略,用户可以减少手动操作,提高备份的可靠性和效率。
-
手动创建快照:用户根据需求手动触发快照备份操作,适合临时备份或特定场景,如在进行重大操作前(如集群升级)进行备份,以便在出现问题时能够快速恢复到之前的状态。手动快照提供了更高的灵活性,用户可以根据实际需求随时创建快照。
该接口用于手动创建一个快照。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
css:snapshot:create
Write
cluster *
-
g:EnterpriseProjectId
-
g:ResourceTag/<tag-key>
-
iam:agencies:pass
-
URI
POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
是 |
String |
参数解释: 快照名称。 约束限制: 不涉及 取值范围: 快照名称在4位到64位之间,必须以字母开头,可以包含字母、数字、中划线或者下划线,注意字母不能大写且不能包含其他特殊字符。 默认取值: 不涉及 |
|
description |
否 |
String |
参数解释: 快照描述。 约束限制: 不涉及 取值范围: 0~256个字符,不能包含!<>=&"'字符。 默认取值: 不涉及 |
|
indices |
否 |
String |
参数解释: 需要备份的索引名。
约束限制: enable为true时有效。 取值范围: 支持0~1024个字符,不能包含大写字母、空格以及字符:"<|>/? 默认取值: 默认为空,表示备份全部索引。 |
请求示例
创建快照。
POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/index_snapshot
{
"name" : "snapshot_001",
"indices" : "myindex1myindex2"
}
响应示例
状态码:201
创建类的请求已成功。
{
"backup" : {
"id" : "9dc4f5c9-33c0-45c7-9378-ae35ae350682",
"name" : "snapshot_101"
}
}
SDK代码示例
SDK代码示例如下。
创建快照。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.css.v1.region.CssRegion; import com.huaweicloud.sdk.css.v1.*; import com.huaweicloud.sdk.css.v1.model.*; public class CreateSnapshotSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); CssClient client = CssClient.newBuilder() .withCredential(auth) .withRegion(CssRegion.valueOf("<YOUR REGION>")) .build(); CreateSnapshotRequest request = new CreateSnapshotRequest(); request.withClusterId("{cluster_id}"); CreateSnapshotReq body = new CreateSnapshotReq(); body.withIndices("myindex1myindex2"); body.withName("snapshot_001"); request.withBody(body); try { CreateSnapshotResponse response = client.createSnapshot(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
创建快照。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcss.v1.region.css_region import CssRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcss.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = CssClient.new_builder() \ .with_credentials(credentials) \ .with_region(CssRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateSnapshotRequest() request.cluster_id = "{cluster_id}" request.body = CreateSnapshotReq( indices="myindex1myindex2", name="snapshot_001" ) response = client.create_snapshot(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
创建快照。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" css "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := css.NewCssClient( css.CssClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateSnapshotRequest{} request.ClusterId = "{cluster_id}" indicesCreateSnapshotReq:= "myindex1myindex2" request.Body = &model.CreateSnapshotReq{ Indices: &indicesCreateSnapshotReq, Name: "snapshot_001", } response, err := client.CreateSnapshot(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
|
状态码 |
描述 |
|---|---|
|
201 |
创建类的请求已成功。 |
|
400 |
非法请求。 建议直接修改该请求,不要重试该请求。 |
|
403 |
请求被拒绝访问。 返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 |
|
406 |
服务器无法根据客户端请求的内容特性完成请求。 |
|
500 |
表明服务端能被请求访问到,但是不能理解用户的请求。 |
|
501 |
服务器不支持请求的功能,无法完成请求。 |
错误码
请参见错误码。