更新时间:2025-08-15 GMT+08:00

恢复快照

功能介绍

该接口用于手动恢复一个快照。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID。获取方法请参见获取项目ID和名称

约束限制

不涉及

取值范围

账户的项目ID。

默认取值

不涉及

cluster_id

String

参数解释

恢复快照所属的集群ID。获取方法请参见获取集群ID

约束限制

不涉及

取值范围

集群ID。

默认取值

不涉及

snapshot_id

String

参数解释

快照ID。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

target_cluster

String

参数解释

快照要恢复到的集群的ID。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

indices

String

参数解释

指定需要进行恢复的索引名称,支持使用“*”匹配多个索引,比如index*,表示恢复快照中名称前缀是index的所有索引。也可恢复指定的索引,比如”index1,index2,index3“。使用“*”匹配索引时,默认会过滤掉“.opendistro_security”或以“.kibana”为前缀的系统索引。“.opendistro_security”索引不允许恢复,恢复以“.kibana”为前缀的索引时需要指定索引名称。

约束限制

不涉及

取值范围

0~1024个字符,不能包含大写字母、空格以及字符:"\<|>/?

默认取值

默认为空。

如果索引不填写,默认为恢复快照中的所有数据索引。

rename_pattern

String

参数解释

匹配要恢复的索引规则,最大支持1024个字符。根据此处定义的过滤条件去恢复符合条件的索引,过滤条件请使用正则表达式。renamePattern参数与renameReplacement参数必须同时设置才能生效。

约束限制

不涉及

取值范围

0~1024个字符,不能包含空格和大写字母,且不能包含"\<|>/?,特殊字符。

默认取值

不涉及

rename_replacement

String

参数解释

索引重命名的规则。

约束限制

不涉及

取值范围

0~1024个字符,不能包含空格和大写字母,且不能包含"\<|>/?,特殊字符。例如,“restored_index_$1”表示在所有恢复的索引名称前面加上“restored_”。

renamePattern参数与renameReplacement参数必须同时设置才能生效。

默认取值

不涉及

replace_exist_indices

Boolean

参数解释

是否替换已存在的索引。

约束限制

不涉及

取值范围

  • false:不替换已存在的索引

  • true:替换已存在的索引

默认取值

false

响应参数

状态码:201

创建类的请求已成功。

请求示例

恢复快照。

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"
}

响应示例

SDK代码示例

SDK代码示例如下。

Java

恢复快照。

 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

恢复快照。

 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

恢复快照。

 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)
    }
}

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

201

创建类的请求已成功。

400

非法请求。

建议直接修改该请求,不要重试该请求。

403

请求被拒绝访问。

返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。

错误码

请参见错误码