Modificação da política de backup vinculada ao cofre
Função
Essa API é usada para modificar a política de backup vinculada ao cofre.
Método de chamada
Para obter detalhes, consulte Chamada de APIs.
URI
PUT /v5/{project_id}/backup/policy
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
project_id |
Sim |
String |
ID do projeto Mínimo: 1 Máximo: 256 |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
enterprise_project_id |
Não |
String |
ID do projeto empresarial. Para consultar todos os projetos empresariais, defina este parâmetro como all_granted_eps. Padrão: 0 Mínimo: 1 Máximo: 256 |
Parâmetros de solicitação
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
X-Auth-Token |
Sim |
String |
Token do usuário. Ele pode ser obtido chamando a API do IAM usada para obter um token de usuário. O valor de X-Subject-Token no cabeçalho da resposta é um token. Mínimo: 1 Máximo: 32768 |
region |
Sim |
String |
ID da região Mínimo: 0 Máximo: 128 |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
enabled |
Não |
Boolean |
Se a política está ativada. O valor padrão é true. |
policy_id |
Sim |
String |
ID da política de backup Mínimo: 1 Máximo: 256 |
operation_definition |
Não |
Parâmetro de agendamento. |
|
trigger |
Não |
BackupTriggerRequestInfo object |
Regra de agendamento de tempo para a política |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
day_backups |
Não |
Integer |
Número máximo de backups diários retidos. O último backup de cada dia é salvo a longo prazo. Esse parâmetro não é afetado pelo número máximo de backups retidos. O valor varia de 0 a 100. Se este parâmetro for especificado, o fuso horário deve ser configurado. Valor mínimo: 0. Valor máximo: 100 Mínimo: 0 Máximo: 100 |
max_backups |
Não |
Integer |
Número máximo de backups automatizados que podem ser retidos para um objeto. O valor pode ser -1 ou varia de 0 a 99999. Se o valor for definido como -1, os backups não serão apagados mesmo que o limite de quantidade de backups retidos configurado seja excedido. Se esse parâmetro e retention_duration_days forem deixados em branco ao mesmo tempo, os backups serão retidos permanentemente. Valor mínimo: 1. Valor máximo: 99999. Valor padrão: -1 Mínimo: -1 Máximo: 99999 |
month_backups |
Não |
Integer |
Número máximo de backups mensais retidos. O último backup de cada mês é salvo a longo prazo. Esse parâmetro não é afetado pelo número máximo de backups retidos. O valor varia de 0 a 100. Se este parâmetro for especificado, o fuso horário deve ser configurado. Valor mínimo: 0. Valor máximo: 100 Mínimo: 0 Máximo: 100 |
retention_duration_days |
Não |
Integer |
Duração da retenção de um backup, em dias. O valor máximo é 99999. Se o valor for definido como -1, os backups não serão apagados mesmo que a duração de retenção configurada seja excedida. Se este parâmetro e max_backups forem deixados em branco ao mesmo tempo, os backups serão retidos permanentemente. Valor mínimo: 1. Valor máximo: 99999. Valor padrão: -1 Mínimo: -1 Máximo: 99999 |
timezone |
Não |
String |
Fuso horário em que o usuário está localizado, por exemplo, UTC+08:00. Defina esse parâmetro somente depois de configurar qualquer um dos parâmetros day_backups, week_backups, month_backups e year_backups. Mínimo: 0 Máximo: 256 |
week_backups |
Não |
Integer |
Número máximo de backups semanais retidos. O último backup de cada semana é salvo a longo prazo. Este parâmetro pode ser efetivo junto com o número máximo de backups retidos especificado por max_backups. O valor varia de 0 a 100. Se este parâmetro for especificado, o fuso horário deve ser configurado. Mínimo: 0 Máximo: 100 |
year_backups |
Não |
Integer |
Número máximo de backups anuais retidos. O último backup de cada ano é salvo a longo prazo. Este parâmetro pode ser efetivo junto com o número máximo de backups retidos especificado por max_backups. O valor varia de 0 a 100. Se este parâmetro for especificado, o fuso horário deve ser configurado. Valor mínimo: 0. Valor máximo: 100 Mínimo: 0 Máximo: 100 |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
properties |
Sim |
Regra de tempo para a execução da política. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
pattern |
Sim |
Array of strings |
Regra de agendamento. Um máximo de 24 regras podem ser configuradas. A regra de agendamento está em conformidade com iCalendar RFC 2445, mas suporta apenas os parâmetros FREQ, BYDAY, BYHOUR, BYMINUTE e INTERVAL. FREQ pode ser definido apenas como WEEKLY ou DAILY. BYDAY pode ser definido como MO, TU, WE, TH, FR, SA ou SU (sete dias por semana). BYHOUR varia de 0 a 23 horas. BYMINUTE varia de 0 minutos a 59 minutos. O intervalo de agendamento não deve ser inferior a 1 hora. Um máximo de 24 pontos de tempo são permitidos em um dia. Por exemplo, se o horário de agendamento for 14:00 de segunda a domingo, defina a regra de agendamento da seguinte forma: FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00. Para iniciar o agendamento às 14:00 todos os dias, a regra é a seguinte: FREQ=DAILY;INTERVAL=1;BYHOUR=14;BYMINUTE=00'. Mínimo: 1 Máximo: 256 Comprimento da matriz: 0–24 |
Parâmetros de resposta
Nenhum
Exemplo de solicitações
Modificar a política de backup. O ID da política de backup de destino é 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" ] } } }
Exemplo de respostas
Nenhum
Código de amostra do SDK
O código de amostra do SDK é o seguinte.
Java
Modificar a política de backup. O ID da política de backup de destino é 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 |
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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); HssClient client = HssClient.newBuilder() .withCredential(auth) .withRegion(HssRegion.valueOf("<YOUR REGION>")) .build(); UpdateBackupPolicyInfoRequest request = new UpdateBackupPolicyInfoRequest(); request.withEnterpriseProjectId("<enterprise_project_id>"); 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()); } } } |
Python
Modificar a política de backup. O ID da política de backup de destino é 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 |
# coding: utf-8 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 = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = HssClient.new_builder() \ .with_credentials(credentials) \ .with_region(HssRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateBackupPolicyInfoRequest() request.enterprise_project_id = "<enterprise_project_id>" 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) |
Go
Modificar a política de backup. O ID da política de backup de destino é 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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := hss.NewHssClient( hss.HssClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UpdateBackupPolicyInfoRequest{} enterpriseProjectIdRequest:= "<enterprise_project_id>" request.EnterpriseProjectId = &enterpriseProjectIdRequest 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) } } |
Mais
Para obter o código de amostra do SDK de mais linguagens de programação, consulte a guia Código de amostra no API Explorer. O código de amostra do SDK pode ser gerado automaticamente.
Códigos de status
Código de status |
Descrição |
---|---|
200 |
Modificar uma política de backup. |
Códigos de erro
Consulte Códigos de erro.