Modifying the Backup Policy Bound to Vault
Function
This API is used to modify the backup policy associated with the vault.
Calling Method
For details, see Calling APIs.
URI
PUT /v5/{project_id}/backup/policy
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value contains 1 to 256 characters. Default Value N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A |
region |
No |
String |
Definition Region ID, which is used to query assets in the required region. For details about how to obtain a region ID, see Obtaining a Region ID. Constraints N/A Range The value can contain 0 to 128 characters. Default Value N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enabled |
No |
Boolean |
Definition Whether the policy is enabled. Constraints N/A Range
Default Value true |
policy_id |
Yes |
String |
Definition Policy ID. This parameter is mandatory if backup protection is enabled. You can obtain the ID by calling the API for Querying Information About the Backup Policy Bound to an HSS Vault. Constraints N/A Range The value contains 1 to 256 characters. Default Value N/A |
operation_definition |
No |
Definition Scheduling parameter. Constraints N/A Range The value range is 0 to 100. Default Value N/A |
|
trigger |
No |
BackupTriggerRequestInfo object |
Time scheduling rule for the policy |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
day_backups |
No |
Integer |
Definition Number of daily backups retained, which is not affected by the allowed maximum number of retained backups. If this parameter is configured, timezone is mandatory. Constraints N/A Range The value range is 0 to 100. Default Value N/A |
max_backups |
No |
Integer |
Definition Maximum number of backups that can be automatically created for an object. If the value is set to -1, backups will not be cleared when they reach the quantity limit. If this parameter and retention_duration_days are both left blank, the backups will be retained permanently. Constraints N/A Range The value can be -1 or in the range 1 to 99,999. Default Value -1 |
month_backups |
No |
Integer |
Definition Number of monthly backups retained, which is not affected by the allowed maximum number of retained backups. If this parameter is configured, timezone is mandatory. Constraints N/A Range The value range is 0 to 100. Default Value N/A |
retention_duration_days |
No |
Integer |
Definition Backup retention period, in days. The maximum value is 99,999. If the value is set to -1, backups will not be cleared by retention duration. If this parameter and max_backups are both left blank, the backups will be retained permanently. Constraints N/A Range Value range: -1 to 99,999 Default Value -1 |
timezone |
No |
String |
Definition Time zone where the user is located, for example, UTC+08:00 Constraints This parameter cannot be set if none of the yearly, monthly, weekly, and daily backup parameters is selected. Range
... Default Value N/A |
week_backups |
No |
Integer |
Definition Number of weekly backups retained, which is not affected by the allowed maximum number of retained backups. If this parameter is configured, timezone is mandatory. Constraints N/A Range The value range is 0 to 100. Default Value N/A |
year_backups |
No |
Integer |
Definition Number of yearly backups retained, which is not affected by the allowed maximum number of retained backups. If this parameter is configured, timezone is mandatory. Constraints N/A Range The value range is 0 to 100. Default Value N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
properties |
Yes |
Time rule for the policy execution. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
pattern |
Yes |
Array of strings |
Definition Scheduling rule. This parameter is mandatory if the backup function is enabled with ransomware protection. Constraints A maximum of 24 rules can be configured. Range Scheduling rule. It complies with iCalendar RFC 2445, but it supports only parameters FREQ, BYDAY, BYHOUR, BYMINUTE, and INTERVAL. FREQ can be set only to WEEKLY or DAILY. BYDAY* can be set to MO, TU, WE, TH, FR, SA, or SU (seven days of a week). BYHOUR ranges from 0 to 23 hours. BYMINUTE ranges from 0 minutes to 59 minutes. The scheduling interval must not be less than 1 hour. A maximum of 24 time points can be configured in a day. For example, if the scheduling time is 14:00 from Monday to Sunday, set the scheduling rule as follows: 'FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00' To start scheduling at 14:00 every day, the rule is as follows: FREQ=DAILY;INTERVAL=1;BYHOUR=14;BYMINUTE=00' Default Value N/A |
Response Parameters
Status code: 200
Request succeeded.
None
Example Requests
Modify the backup policy. The target backup policy ID is af4d08ad-2b60-4916-a5cf-8d6a23956dda.
PUT https://{endpoint}/v5/{project_id}/backup/policy { "enabled" : true, "policy_id" : "af4d08ad-2b60-4916-a5cf-8d6a23956dda", "operation_definition" : { "day_backups" : 0, "max_backups" : -1, "month_backups" : 0, "retention_duration_days" : 5, "timezone" : "UTC+08:00", "week_backups" : 0, "year_backups" : 0 }, "trigger" : { "properties" : { "pattern" : [ "FREQ=DAILY;INTERVAL=2;BYHOUR=14;BYMINUTE=00" ] } } }
Example Responses
None
SDK Sample Code
The SDK sample code is as follows.
Modify the backup policy. The target backup policy ID is af4d08ad-2b60-4916-a5cf-8d6a23956dda.
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 56 57 58 59 60 61 62 63 64 65 66 67 68 69 |
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.hss.v5.region.HssRegion; import com.huaweicloud.sdk.hss.v5.*; import com.huaweicloud.sdk.hss.v5.model.*; import java.util.List; import java.util.ArrayList; public class UpdateBackupPolicyInfoSolution { 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); HssClient client = HssClient.newBuilder() .withCredential(auth) .withRegion(HssRegion.valueOf("<YOUR REGION>")) .build(); UpdateBackupPolicyInfoRequest request = new UpdateBackupPolicyInfoRequest(); UpdateBackupPolicyRequestInfo body = new UpdateBackupPolicyRequestInfo(); List<String> listPropertiesPattern = new ArrayList<>(); listPropertiesPattern.add("FREQ=DAILY;INTERVAL=2;BYHOUR=14;BYMINUTE=00"); BackupTriggerPropertiesRequestInfo propertiesTrigger = new BackupTriggerPropertiesRequestInfo(); propertiesTrigger.withPattern(listPropertiesPattern); BackupTriggerRequestInfo triggerbody = new BackupTriggerRequestInfo(); triggerbody.withProperties(propertiesTrigger); OperationDefinitionRequestInfo operationDefinitionbody = new OperationDefinitionRequestInfo(); operationDefinitionbody.withDayBackups(0) .withMaxBackups(-1) .withMonthBackups(0) .withRetentionDurationDays(5) .withTimezone("UTC+08:00") .withWeekBackups(0) .withYearBackups(0); body.withTrigger(triggerbody); body.withOperationDefinition(operationDefinitionbody); body.withPolicyId("af4d08ad-2b60-4916-a5cf-8d6a23956dda"); body.withEnabled(true); request.withBody(body); try { UpdateBackupPolicyInfoResponse response = client.updateBackupPolicyInfo(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()); } } } |
Modify the backup policy. The target backup policy ID is af4d08ad-2b60-4916-a5cf-8d6a23956dda.
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkhss.v5.region.hss_region import HssRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkhss.v5 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 = HssClient.new_builder() \ .with_credentials(credentials) \ .with_region(HssRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateBackupPolicyInfoRequest() listPatternProperties = [ "FREQ=DAILY;INTERVAL=2;BYHOUR=14;BYMINUTE=00" ] propertiesTrigger = BackupTriggerPropertiesRequestInfo( pattern=listPatternProperties ) triggerbody = BackupTriggerRequestInfo( properties=propertiesTrigger ) operationDefinitionbody = OperationDefinitionRequestInfo( day_backups=0, max_backups=-1, month_backups=0, retention_duration_days=5, timezone="UTC+08:00", week_backups=0, year_backups=0 ) request.body = UpdateBackupPolicyRequestInfo( trigger=triggerbody, operation_definition=operationDefinitionbody, policy_id="af4d08ad-2b60-4916-a5cf-8d6a23956dda", enabled=True ) response = client.update_backup_policy_info(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Modify the backup policy. The target backup policy ID is af4d08ad-2b60-4916-a5cf-8d6a23956dda.
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 56 57 58 59 60 61 62 63 64 65 66 67 68 69 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" hss "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/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 := hss.NewHssClient( hss.HssClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UpdateBackupPolicyInfoRequest{} var listPatternProperties = []string{ "FREQ=DAILY;INTERVAL=2;BYHOUR=14;BYMINUTE=00", } propertiesTrigger := &model.BackupTriggerPropertiesRequestInfo{ Pattern: listPatternProperties, } triggerbody := &model.BackupTriggerRequestInfo{ Properties: propertiesTrigger, } dayBackupsOperationDefinition:= int32(0) maxBackupsOperationDefinition:= int32(-1) monthBackupsOperationDefinition:= int32(0) retentionDurationDaysOperationDefinition:= int32(5) timezoneOperationDefinition:= "UTC+08:00" weekBackupsOperationDefinition:= int32(0) yearBackupsOperationDefinition:= int32(0) operationDefinitionbody := &model.OperationDefinitionRequestInfo{ DayBackups: &dayBackupsOperationDefinition, MaxBackups: &maxBackupsOperationDefinition, MonthBackups: &monthBackupsOperationDefinition, RetentionDurationDays: &retentionDurationDaysOperationDefinition, Timezone: &timezoneOperationDefinition, WeekBackups: &weekBackupsOperationDefinition, YearBackups: &yearBackupsOperationDefinition, } enabledUpdateBackupPolicyRequestInfo:= true request.Body = &model.UpdateBackupPolicyRequestInfo{ Trigger: triggerbody, OperationDefinition: operationDefinitionbody, PolicyId: "af4d08ad-2b60-4916-a5cf-8d6a23956dda", Enabled: &enabledUpdateBackupPolicyRequestInfo, } response, err := client.UpdateBackupPolicyInfo(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
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. |
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