查询自动创建快照的策略
功能介绍
该接口用于查询自动创建快照策略。
调用方法
请参见如何调用API。
URI
GET /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/policy
请求参数
无
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
keepday |
Integer |
参数解释: 自定义设置快照保留的个数。 取值范围: 不涉及 |
period |
String |
参数解释: 每天快照创建时刻。 取值范围: 不涉及 |
prefix |
String |
参数解释: 快照命名前缀,需要用户自己手动输入。 取值范围: 不涉及 |
bucket |
String |
参数解释: 快照存放的OBS桶的桶名。 取值范围: 不涉及 |
basePath |
String |
参数解释: 快照在OBS桶中的存放路径。 取值范围: 不涉及 |
agency |
String |
参数解释: 访问OBS桶用到的委托。 取值范围: 不涉及 |
enable |
String |
参数解释: 是否开启自动创建快照策略。 取值范围:
|
frequency |
String |
参数解释: 自动创建快照的执行频次。 取值范围:
|
maxSnapshotBytesPerSeconds |
String |
参数解释: 配置每个节点的最大备份速率(每秒),即当备份的速率超过该值时会被限流,避免速率太大导致资源占用过高,影响系统稳定性。实际备份速率不一定能达到该值,会受OBS、磁盘等影响。 约束限制: 不涉及 取值范围: 有以下3种填写规则:
默认取值: 默认值是40mb,不填写时表示使用默认值。 |
maxRestoreBytesPerSeconds |
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种填写规则:
默认取值: 7.6.2及以下版本的Elasticsearch集群,默认值是40mb。 OpenSearch集群和7.6.2以上版本的Elasticsearch集群,默认值是不限制,但还受限于“indices.recovery.max_bytes_per_sec”参数。 不填写时表示使用默认值。 |
请求示例
查询自动创建快照的策略。
GET https://{Endpoint}/v1.0/{project_id}/clusters/{cluster_id}/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代码示例如下。
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());
}
}
}
|
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)
|
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代码示例。
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());
}
}
}
|
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)
|
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 |
服务器无法根据客户端请求的内容特性完成请求。 |
错误码
请参见错误码。