Updated on 2025-11-17 GMT+08:00

Restoring a Snapshot

Function

This API is used to restore a specified snapshot. Use a snapshot to restore a point-in-time copy of a cluster to the original cluster or to another eligible cluster.

Constraints

  • Before snapshot restoration is completed, the indexes being restored to the destination cluster cannot be queried.

  • If the two clusters have indexes with the same names but different shard structures, such indexes cannot be restored.

Calling Method

For details, see Calling APIs.

URI

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

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

Value range:

Project ID of the account.

Default value:

N/A

cluster_id

Yes

String

Definition:

Cluster ID. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

Constraints:

N/A

Value range:

Cluster ID.

Default value:

N/A

snapshot_id

Yes

String

Definition:

The snapshot ID. For details, see Querying Snapshots.

Constraints:

The snapshot status is Available.

Value range:

N/A

Default value:

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

target_cluster

Yes

String

Definition:

ID of the destination cluster to which the snapshot is restored.

Constraints:

  • If the current cluster is available, snapshots are restored to the current cluster by default. Alternatively, you can choose to restore them to another specified cluster.

  • The destination cluster must be in the same region as the current cluster, and must have a later version than the current cluster.

Value range:

N/A

Default value:

N/A

indices

No

String

Definition:

Specify the name of the index you want to restore.

Constraints:

The value is a string of 0 to 1024 characters that cannot contain uppercase letters, spaces, or the following special characters: "<|>/?.

  • When restoring an index whose name is prefixed with .kibana, the index name must be specified.

  • The .opendistro_security index cannot be restored.

Value range:

  • You can use an asterisk () to match multiple indexes. For example, index indicates that all indexes with the prefix index will be restored. When an asterisk (*) is used for index matching, the .opendistro_security index and any system indexes whose name is prefixed with .kibana are filtered out by default.

  • You can restore indexes by specifying their names, for example, index1,index2,index3.

Default value:

By default, this parameter is left blank. That is, no index name is specified, and all indexes will be restored.

rename_pattern

No

String

Definition:

Rule for defining the indexes to be restored.

Constraints:

  • Indexes that match this rule will be restored. The filtering condition must be a regular expression.

  • The renamePattern and renameReplacement parameters must be set at the same time in order for them to take effect.

Value range:

The value can contain 0 to 1,024 characters. Uppercase letters, spaces, and the following special characters are not allowed: "\<|>/?

Default value:

N/A

rename_replacement

No

String

Definition:

Rule for renaming an index.

Constraints:

The renamePattern and renameReplacement parameters must be set at the same time in order for them to take effect.

Value range:

The value can contain 0 to 1,024 characters. Uppercase letters, spaces, and the following special characters are not allowed: "\<|>/? For example, restored_index_$1 indicates adding the restored_ prefix to the names of all the restored indexes.

Default value:

N/A

replace_exist_indices

No

Boolean

Definition:

Whether to overwrite same-name indexes in the destination cluster. Restoring a snapshot will overwrite existing data in the destination cluster. When there are same-name indexes in the destination cluster, you need to select this option in order to restore same-name, same-shard structure indexes. Indexes with a different shard structure cannot be restored.

Constraints:

N/A

Value range:

  • false: Do not replace existing indexes.

  • true: Replace existing indexes.

Default value:

false

Response Parameters

Status code: 201

Resource created.

None

Example Requests

Restore a snapshot.

POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/index_snapshot/653c086f-ebe7-4383-b902-c031b354f1dd/restore

{
  "target_cluster" : "ea244205-d641-45d9-9dcb-ab2236bcd07e",
  "indices" : "myindex1,myindex2",
  "rename_pattern" : "index",
  "rename_replacement" : "restored_index_$1"
}

Example Responses

None

SDK Sample Code

The SDK sample code is as follows.

Java

Restore 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 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 RestoreSnapshotSolution {

    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();
        RestoreSnapshotRequest request = new RestoreSnapshotRequest();
        request.withClusterId("{cluster_id}");
        request.withSnapshotId("{snapshot_id}");
        RestoreSnapshotReq body = new RestoreSnapshotReq();
        body.withRenameReplacement("restored_index_$1");
        body.withRenamePattern("index");
        body.withIndices("myindex1,myindex2");
        body.withTargetCluster("ea244205-d641-45d9-9dcb-ab2236bcd07e");
        request.withBody(body);
        try {
            RestoreSnapshotResponse response = client.restoreSnapshot(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

Restore 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
# 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 = RestoreSnapshotRequest()
        request.cluster_id = "{cluster_id}"
        request.snapshot_id = "{snapshot_id}"
        request.body = RestoreSnapshotReq(
            rename_replacement="restored_index_$1",
            rename_pattern="index",
            indices="myindex1,myindex2",
            target_cluster="ea244205-d641-45d9-9dcb-ab2236bcd07e"
        )
        response = client.restore_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

Restore 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
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.RestoreSnapshotRequest{}
	request.ClusterId = "{cluster_id}"
	request.SnapshotId = "{snapshot_id}"
	renameReplacementRestoreSnapshotReq:= "restored_index_$1"
	renamePatternRestoreSnapshotReq:= "index"
	indicesRestoreSnapshotReq:= "myindex1,myindex2"
	request.Body = &model.RestoreSnapshotReq{
		RenameReplacement: &renameReplacementRestoreSnapshotReq,
		RenamePattern: &renamePatternRestoreSnapshotReq,
		Indices: &indicesRestoreSnapshotReq,
		TargetCluster: "ea244205-d641-45d9-9dcb-ab2236bcd07e",
	}
	response, err := client.RestoreSnapshot(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.

Error Codes

See Error Codes.