文档首页/ 云搜索服务 CSS/ API参考/ API V1/ 快照管理/ 修改集群快照的基础配置
更新时间:2025-08-22 GMT+08:00
分享

修改集群快照的基础配置

功能介绍

该接口用于修改集群快照的基础配置,可修改OBS桶和IAM委托。

  • OBS桶:快照存储的OBS桶位置。

  • 备份路径:快照在OBS桶中的存放路径。

  • IAM委托:由于需要将快照保存在OBS中,所以需要在IAM中设置对应的委托获取对OBS服务的授权。

可以使用该接口开启快照功能。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

不涉及

取值范围

账户的项目ID。

默认取值

不涉及

cluster_id

String

参数解释

指定待操作的集群ID。获取方法请参见获取集群ID

约束限制

不涉及

取值范围

集群ID。

默认取值

不涉及

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

bucket

String

参数解释

备份使用的OBS桶的桶名。

约束限制

  • 存储类别:为标准存储。

  • 区域:须与创建的集群所在区域相同。

取值范围

不涉及

默认取值

不涉及

agency

String

参数解释

委托名称,委托给CSS,允许CSS调用您的其他云服务。

约束限制

无法配置含特殊字符和中文字符的委托,允许使用的委托名称仅可包含a-zA-Z0-9-_字符。

取值范围

不涉及

默认取值

不涉及

base_path

String

参数解释

快照在OBS桶中的存放路径。

约束限制

不涉及

取值范围

  • 备份路径不能包括下列符号 :\:*?"<>|'{}

  • 备份路径不能以“/”开头

  • 备份路径不能以“.”开头或结尾

  • 备份路径不能包含两个以上连续的斜杆(/)或点(.)

  • 备份路径的总长度不能超过512字符

默认取值

不涉及

max_snapshot_bytes_per_seconds

String

参数解释

配置每个节点的最大备份速率(每秒),即当备份的速率超过该值时会被限流,避免速率太大导致资源占用过高,影响系统稳定性。实际备份速率不一定能达到该值,会受OBS、磁盘等影响。

约束限制

不涉及

取值范围

有以下3种填写规则:

  • 数字+单位

    数字部分支持0~9999。

    单位部分支持k、kb、m、mb、g、gb、t、tb、p、pb、b,且不区分大小写。

    当填写0mb时,表示不限速,当备份速率过大时,可能导致备份占用资源过高,影响系统稳定性,请谨慎配置该值。

  • 0

    表示不限速,当备份速率过大时,可能导致备份占用资源过高,影响系统稳定性,请谨慎配置该值。

  • -1

    表示不限速,当备份速率过大时,可能导致备份占用资源过高,影响系统稳定性,请谨慎配置该值。

默认取值

默认值是40mb,不填写时表示使用默认值。

max_restore_bytes_per_seconds

String

参数解释

配置每个节点的最大恢复速率(每秒),即当恢复的速率超过该值时会被限流,避免速率太大导致资源占用过高,影响系统稳定性。实际恢复速率不一定能达到该值,会受OBS、磁盘等影响。

约束限制

OpenSearch集群和版本是7.6.2以后的Elasticsearch集群,恢复速率还受限于“indices.recovery.max_bytes_per_sec”参数。当“最大恢复速率(每秒)”小于“indices.recovery.max_bytes_per_sec”的参数值时,恢复速率达到“最大恢复速率(每秒)”参数值时就会被限流。当“最大恢复速率(每秒)”大于“indices.recovery.max_bytes_per_sec”的参数值时,恢复速率达到“indices.recovery.max_bytes_per_sec”参数值时就会被限流。

取值范围

有以下3种填写规则:

  • 数字+单位

    数字部分支持0~9999。

    单位部分支持k、kb、m、mb、g、gb、t、tb、p、pb、b,且不区分大小写。

    当填写0mb时,表示不限速(但OpenSearch集群和7.6.2以上版本的Elasticsearch集群,恢复速率还受限于“indices.recovery.max_bytes_per_sec”参数),当恢复速率过大时,可能导致恢复占用资源过高,影响系统稳定性,请谨慎配置该值。

  • 0

    表示不限速(但OpenSearch集群和7.6.2以上版本的Elasticsearch集群,恢复速率还受限于“indices.recovery.max_bytes_per_sec”参数),当恢复速率过大时,可能导致恢复占用资源过高,影响系统稳定性,请谨慎配置该值。

  • -1

    表示不限速(但OpenSearch集群和7.6.2以上版本的Elasticsearch集群,恢复速率还受限于“indices.recovery.max_bytes_per_sec”参数),当恢复速率过大时,可能导致恢复占用资源过高,影响系统稳定性,请谨慎配置该值。

默认取值

7.6.2及以下版本的Elasticsearch集群,默认值是40mb。

OpenSearch集群和7.6.2以上版本的Elasticsearch集群,默认值是不限制,但还受限于“indices.recovery.max_bytes_per_sec”参数。

不填写时表示使用默认值。

enable

String

参数解释

是否开启自动创建快照策略。

约束限制

不涉及

取值范围

true:表示开启自动创建快照策略。

false:表示关闭自动创建快照策略。

默认取值

false

indices

String

参数解释

需要备份的索引名。

约束限制

  • *代表所有索引,enable为true时有效。

  • 不能包含大写字母、空格以及字符:"<|>/?

取值范围

  • 不填写:默认恢复快照中所有索引。

  • 支持使用“”匹配多个索引,比如“index”,表示恢复快照中名称前缀是index的所有索引。

  • 恢复指定索引:比如“index1"、“index2”、“Index3”。

默认取值

不涉及

prefix

String

参数解释

自动创建快照的名称前缀,需要用户自己手动输入。

约束限制

当enable为true时该字段为必选字段。

取值范围

只能包含1~32位小写字母、数字、中划线或者下划线,并且以小写字母开头。

默认取值

不涉及

period

String

参数解释

每天创建快照的时刻。

约束限制

  • frequency取值HOUR无需指定period值,默认从设置成功的下一整点创建。

  • enable为true:该字段为必选字段。

取值范围

只支持整点,后面需加上时区,格式为HH:mm z,HH:mm表示整点时间,z表示时区。 比如00:00 GMT+08:00、01:00 GMT+08:00等。

默认取值

00:00 GMT+08:00

keepday

Integer

参数解释

自定义设置快照保留的个数。系统在半点时刻会自动删除超过保留个数的快照。过期删除策略只针对与当前自动创建快照策略相同执行频次的自动快照。

约束限制

当enable为true时该字段为必选字段。

取值范围

1~90

默认取值

不涉及

frequency

String

参数解释

自动创建快照的执行频次。

约束限制

不涉及

取值范围

  • HOUR:表示每小时整点执行一次。

  • DAY:表示每天执行一次。

  • SUN、MON、TUE、WED、THU、FRI、SAT:表示在每周对应时间执行一次。比如SUN表示每周日执行一次。

  • 保留快照个数与自动创建快照策略中设置的执行频次和索引有关。当执行频次间隔时间短或索引数据量大,保留自动快照可能会达不到设置的个数,请谨慎选择!

默认取值

DAY

delete_auto

String

参数解释

表示关闭自动创建快照策略时,是否需要清除所有自动创建的快照。

约束限制

只有在enable参数为false(表示关闭自动备份开关)的时候才生效。

取值范围

true:表示在关闭自动创建快照策略的同时,删除所有已创建的快照。

false:表示不会删除之前已自动创建的快照。

默认取值

false

响应参数

状态码:200

请求已成功。

请求示例

开启快照功能。

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

{
  "bucket" : "test-bucket",
  "agency" : "usearch",
  "base_path" : "css_repository/Es-name",
  "max_snapshot_bytes_per_seconds" : 0,
  "max_restore_bytes_per_seconds" : 0
}

响应示例

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
53
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 UpdateSnapshotSettingSolution {

    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();
        UpdateSnapshotSettingRequest request = new UpdateSnapshotSettingRequest();
        request.withClusterId("{cluster_id}");
        UpdateSnapshotSettingReq body = new UpdateSnapshotSettingReq();
        body.withBasePath("css_repository/Es-name");
        body.withAgency("usearch");
        body.withBucket("test-bucket");
        request.withBody(body);
        try {
            UpdateSnapshotSettingResponse response = client.updateSnapshotSetting(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
37
# 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 = UpdateSnapshotSettingRequest()
        request.cluster_id = "{cluster_id}"
        request.body = UpdateSnapshotSettingReq(
            base_path="css_repository/Es-name",
            agency="usearch",
            bucket="test-bucket"
        )
        response = client.update_snapshot_setting(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.UpdateSnapshotSettingRequest{}
	request.ClusterId = "{cluster_id}"
	request.Body = &model.UpdateSnapshotSettingReq{
		BasePath: "css_repository/Es-name",
		Agency: "usearch",
		Bucket: "test-bucket",
	}
	response, err := client.UpdateSnapshotSetting(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

请求已成功。

406

服务器无法根据客户端请求的内容特性完成请求。

412

未满足前提条件,服务器未满足请求者在请求中设置的其中一个前提条件。

504

网关超时。

错误码

请参见错误码

相关文档