文档首页/ 云搜索服务 CSS/ API参考/ API V1/ 快照管理/ 查询自动创建快照的策略
更新时间:2025-08-15 GMT+08:00

查询自动创建快照的策略

功能介绍

CSS服务的快照备份功能为Elasticsearch集群提供数据保护和恢复能力。通过快照备份,可以将集群的数据状态保存到OBS桶中,以便在需要时进行恢复。集群快照分为两种方式:自动创建快照和手动创建快照。该接口用于查询自动创建快照策略。

  • 自动创建快照:按照预设的时间策略自动执行快照备份操作,适合定期备份场景,例如每日或每周备份,以确保数据的持续保护。通过设置自动快照策略,用户可以减少手动操作,提高备份的可靠性和效率。

  • 手动创建快照:用户根据需求手动触发快照备份操作,适合临时备份或特定场景,如在进行重大操作前(如集群升级)进行备份,以便在出现问题时能够快速恢复到之前的状态。手动快照提供了更高的灵活性,用户可以根据实际需求随时创建快照。

调用方法

请参见如何调用API

URI

GET /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/policy

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

不涉及

取值范围

账户的项目ID。

默认取值

不涉及

cluster_id

String

参数解释

指定需查询自动创建快照策略的集群ID。获取方法请参见获取集群ID

约束限制

不涉及

取值范围

集群ID。

默认取值

不涉及

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

keepday

Integer

参数解释

自定义设置快照保留的个数。

取值范围

不涉及

period

String

参数解释

每天快照创建的具体时刻。

取值范围

不涉及

prefix

String

参数解释

快照命名前缀,需要用户自己手动输入。

取值范围

不涉及

bucket

String

参数解释

快照存放的OBS桶的桶名。

取值范围

不涉及

basePath

String

参数解释

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

取值范围

不涉及

agency

String

参数解释

访问OBS桶用到的委托。

取值范围

不涉及

enable

String

参数解释

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

取值范围

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

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

frequency

String

参数解释

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

取值范围

  • DAY:表示天。

  • HOUR:表示小时。

  • MON:表示周一。

  • TUE:表示周二。

  • WED:表示周三。

  • THU:表示周四。

  • FRI:表示周五。

  • SAT:表示周六。

  • SUN:表示周日。

maxSnapshotBytesPerSeconds

String

参数解释

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

取值范围

有以下3种填写规则:

  • 数字+单位

    数字部分支持0~9999。

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

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

  • 0

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

  • -1

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

maxRestoreBytesPerSeconds

String

参数解释

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

取值范围

有以下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”参数),当恢复速率过大时,可能导致恢复占用资源过高,影响系统稳定性,请谨慎配置该值。

请求示例

查询自动创建快照的策略。

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

响应示例

状态码:200

请求已成功。

{
  "keepday" : 2,
  "frequency" : "DAY",
  "period" : "16:00 GMT+08:00",
  "prefix" : "snapshot",
  "bucket" : "es-backup",
  "basePath" : "css_repository/tests",
  "agency" : "usearch",
  "enable" : "true"
}

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
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 ShowAutoCreatePolicySolution {

    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();
        ShowAutoCreatePolicyRequest request = new ShowAutoCreatePolicyRequest();
        request.withClusterId("{cluster_id}");
        try {
            ShowAutoCreatePolicyResponse response = client.showAutoCreatePolicy(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
# 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 = ShowAutoCreatePolicyRequest()
        request.cluster_id = "{cluster_id}"
        response = client.show_auto_create_policy(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
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.ShowAutoCreatePolicyRequest{}
	request.ClusterId = "{cluster_id}"
	response, err := client.ShowAutoCreatePolicy(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

请求已成功。

406

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

错误码

请参见错误码