Updated on 2026-08-24 GMT+08:00

Manually Creating a Snapshot

Function

The snapshot backup function of CSS provides data protection and restoration capabilities for Elasticsearch/OpenSearch clusters. Through snapshot backup, the data status of a cluster can be saved to an OBS bucket for restoration when needed. CSS cluster snapshots are classified into two types: automatic snapshots and manual snapshots.

  • Automatic snapshot: Automatically executes snapshot backup operations based on preset time policies, suitable for periodic backup scenarios, such as daily or weekly backups, to ensure continuous data protection. By configuring automatic snapshot policies, you can reduce manual operations and improve backup reliability and efficiency.

  • Manual snapshot: Manually triggers snapshot backup operations based on user requirements, suitable for temporary backups or specific scenarios, such as backing up before major operations (for example, cluster upgrade) so that you can quickly restore to the previous state if a problem occurs. Manual snapshots provide higher flexibility, allowing you to create snapshots at any time as needed.

This API is used to manually create a snapshot.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    css:snapshot:create

    Write

    cluster *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    -

    -

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

Constraints

N/A

Range

Project ID of an account. The value contains 32 characters, consisting of lowercase letters and digits.

Default Value

N/A

cluster_id

Yes

String

Definition

ID of the cluster for which you want to create a snapshot. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

Constraints

N/A

Range

The value is a UUID containing 36 characters.

Default Value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Definition

Snapshot name.

Constraints

N/A

Range

Snapshot name. Enter 4 to 64 characters. Only lowercase letters, digits, hyphens (-), and underscores (_) are allowed. The value must start with a letter.

Default Value

N/A

description

No

String

Definition:

Snapshot description.

Constraints:

N/A

Value range:

The value contains 0 to 256 characters and cannot contain !<>=&"'

Default value:

N/A

indices

No

String

Definition

Names of the indexes to be backed up.

  • You can specify indices, separated by commas (,), for example, index1,index2,index3.

  • You can use an asterisk () to match multiple indexes. For example, index indicates that all indexes with the prefix index will be restored.

Constraints

N/A

Range

0 to 1024 characters. Uppercase letters, spaces, or the following special characters are not allowed: "<|>/?

Default Value

Empty by default, indicating that all indexes are backed up.

Response Parameters

Status code: 201

Table 3 Response body parameters

Parameter

Type

Description

backup

backupRsp object

Definition:

The snapshot information.

Value range:

N/A

Table 4 backupRsp

Parameter

Type

Description

id

String

Definition:

Snapshot ID.

Value range:

N/A

name

String

Definition:

Snapshot name.

Value range:

Snapshot name. Enter 4 to 64 characters. Only lowercase letters, digits, hyphens (-), and underscores (_) are allowed. The value must start with a letter.

Example Requests

Create a snapshot.

POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/index_snapshot

{
  "name" : "snapshot_001",
  "indices" : "myindex1,myindex2"
}

Example Responses

Status code: 201

Resource created.

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

SDK Sample Code

The SDK sample code is as follows.

Java

Create a snapshot.

 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("myindex1,myindex2");
        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());
        }
    }
}

Python

Create a snapshot.

 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="myindex1,myindex2",
            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)

Go

Create a snapshot.

 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
53
54
55
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, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := css.CssClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := css.NewCssClient(hcClient)

    request := &model.CreateSnapshotRequest{}
	request.ClusterId = "{cluster_id}"
	indicesCreateSnapshotReq:= "myindex1,myindex2"
	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)
    }
}

More

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

201

Resource created.

400

Invalid request.

Modify the request before retry.

403

Request rejected.

The server has received the request and understood it, but refused to respond to it. The client should not repeat the request without modifications.

406

The server could not fulfill the request according to the content characteristics of the request.

500

The server has received the request but could not understand it.

501

The server does not support the function required to fulfill the request.

Error Codes

See Error Codes.