Configuring the Automatic Snapshot Creation Policy
Function
This API is used to configure automatic snapshot creation. By default, a snapshot is created every day.
Calling Method
For details, see Calling APIs.
URI
POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/policy
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: ID of the cluster for which you want to create snapshots automatically. 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 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
indices |
No |
String |
Definition: Name of the index to be backed up. The value * indicates all indexes. Constraints: N/A Value range: N/A Default value: N/A |
prefix |
No |
String |
Definition: Prefix of a snapshot that is automatically created, which is manually entered. Constraints: N/A Value range: Enter up to 32 characters and start with a lowercase letter. Lowercase letters, digits, hyphens (-), and underscores (_) are allowed. Default value: N/A
NOTE:
This parameter is mandatory when enable is set to true.
|
period |
No |
String |
Definition: Time when a snapshot is generated every day. Snapshots can only be generated on the hour. The format is HH:mm z: HH:mm refers to the hour time and z refers to the time zone. For example, 00:00 GMT+08:00 and 01:00 GMT+08:00. Constraints: N/A Value range: N/A Default value: 00:00 GMT+08:00
NOTE:
The default value is 00:00 GMT+08:00. When frequency is set to HOUR, you do not need to specify period. By default, snapshot creation starts from the next hour after the settings are successful. This parameter is mandatory when enable is set to true.
|
keepday |
No |
Integer |
Definition: Customize the number of snapshots to be retained. Expired snapshots will be automatically deleted on the half hour. The deletion policy applies only to automated snapshots that are executed at the same frequency as the current automatic snapshot creation policy. Constraints: N/A Value range: 1–90 Default value: N/A
NOTE:
This parameter is mandatory when enable is set to true.
|
enable |
Yes |
String |
Definition: Whether to enable the automatic snapshot creation policy. Constraints: N/A Value range:
Default value: N/A |
delete_auto |
No |
String |
Definition: Whether to clear all the automatically created snapshots when the automatic snapshot creation policy is disabled. Constraints: N/A Value range:
Default value: false |
frequency |
No |
String |
Definition: Frequency of automatically creating snapshots. Constraints: N/A Value range: N/A Default value: DAY
NOTE:
The default value is DAY. If this parameter is set to HOUR, the scheduled task is executed every hour. If this parameter is set to DAY, the scheduled task is executed every day. If this parameter is set to SUN, MON, TUE, WED, THU, FRI or SAT, the scheduled task is executed at the specified day of every week. For example, SUN indicates that the task is executed once every Sunday. The number of retained snapshots depends on the execution frequency and indexes set in the automatic snapshot creation policy. If the execution interval is short or the index data volume is large, the number of retained automatic snapshots may not reach the preset value. Set this value based on actual conditions.
|
Response Parameters
Status code: 200
Request succeeded.
None
Example Requests
Configure the automatic snapshot creation policy.
POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/index_snapshot/policy { "prefix" : "snapshot", "period" : "16:00 GMT+08:00", "keepday" : 7, "frequency" : "DAY", "enable" : "true", "delete_auto" : "false" }
Example Responses
None
SDK Sample Code
The SDK sample code is as follows.
Java
Configure the automatic snapshot creation policy.
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 CreateAutoCreatePolicySolution { 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(); CreateAutoCreatePolicyRequest request = new CreateAutoCreatePolicyRequest(); request.withClusterId("{cluster_id}"); SetRDSBackupCnfReq body = new SetRDSBackupCnfReq(); body.withDeleteAuto("false"); body.withEnable("true"); body.withKeepday(7); body.withPeriod("16:00 GMT+08:00"); body.withPrefix("snapshot"); request.withBody(body); try { CreateAutoCreatePolicyResponse response = client.createAutoCreatePolicy(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
Configure the automatic snapshot creation policy.
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 = CreateAutoCreatePolicyRequest() request.cluster_id = "{cluster_id}" request.body = SetRDSBackupCnfReq( delete_auto="false", enable="true", keepday=7, period="16:00 GMT+08:00", prefix="snapshot" ) response = client.create_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
Configure the automatic snapshot creation policy.
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 |
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.CreateAutoCreatePolicyRequest{} request.ClusterId = "{cluster_id}" deleteAutoSetRdsBackupCnfReq:= "false" keepdaySetRdsBackupCnfReq:= int32(7) periodSetRdsBackupCnfReq:= "16:00 GMT+08:00" prefixSetRdsBackupCnfReq:= "snapshot" request.Body = &model.SetRdsBackupCnfReq{ DeleteAuto: &deleteAutoSetRdsBackupCnfReq, Enable: "true", Keepday: &keepdaySetRdsBackupCnfReq, Period: &periodSetRdsBackupCnfReq, Prefix: &prefixSetRdsBackupCnfReq, } response, err := client.CreateAutoCreatePolicy(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 |
---|---|
200 |
Request succeeded. |
406 |
The server could not fulfill the request according to the content characteristics of the request. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot