UpdateBackupPlan - Cloud Backup: Central de Documentação do Alibaba Cloud

Atualiza um plano de backup.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

hbr:UpdateBackupPlan

update

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
PlanId	string	Sim	O ID do plano de backup.	plan-20211***735
PlanName	string	Não	O nome do plano de backup.	planname
Schedule	string	Não	A política de backup. Formato válido: `I\|{startTime}\|{interval}`. Este formato especifica que um trabalho de backup é executado em um intervalo de `{interval}` a partir de `{startTime}`. Trabalhos de backup para horários passados não são compensados. Se o trabalho de backup anterior não for concluído, o próximo trabalho de backup não será acionado. Por exemplo, `I\|1631685600\|P1D` especifica que um backup é realizado todos os dias a partir de 2021-09-15 14:00:00.\n\n- startTime: A hora de início do backup. O valor é um timestamp UNIX em segundos.\n- interval: O intervalo de tempo ISO 8601. Por exemplo, PT1H especifica um intervalo de uma hora. P1D especifica um intervalo de um dia.	I\|1602673264\|P1D
Retention	integer	Não	O período de retenção de backups em dias. O valor mínimo é 1.	7
Prefix	string	Não	O prefixo do backup. Este parâmetro é obrigatório apenas quando SourceType é definido como OSS. Após a especificação deste parâmetro, apenas os objetos cujos nomes correspondem ao prefixo são incluídos no backup.	oss-prefix
VaultId	string	Não	O ID do cofre de backup.	v-0006******q
Detail	object	Não	Os detalhes do backup da instância ECS. O valor é uma string JSON.\n\n* snapshotGroup: Especifica se deve ser usado um grupo de snapshots consistente. Isso é válido apenas quando todos os discos em nuvem da instância são ESSDs.\n* appConsistent: Especifica se deve ser usada a consistência de aplicativo. Este parâmetro deve ser usado em conjunto com os parâmetros preScriptPath e postScriptPath.\n* preScriptPath: O caminho do script de pré-congelamento.\n* postScriptPath: O caminho do script de pós-descongelamento.	{\"EnableFsFreeze\":true,\"appConsistent\":false,\"postScriptPath\":\"\",\"preScriptPath\":\"\",\"snapshotGroup\":true,\"timeoutInSeconds\":60}
SourceType	string	Não	O tipo da fonte de dados. Valores válidos:\n\n- ECS_FILE: Arquivos ECS.\n- OSS: Alibaba Cloud OSS.\n- NAS: Alibaba Cloud NAS.\n- OTS: Alibaba Cloud Tablestore.\n- UDM_ECS: Instâncias ECS.	ECS_FILE
SpeedLimit	string	Não	O limitador de tráfego de backup. Este parâmetro é obrigatório apenas quando SourceType é definido como ECS_FILE. O limitador ajuda você a controlar o tráfego de arquivos de backup durante os horários de pico para evitar impactos nos negócios normais. O formato é `{start}\|{end}\|{bandwidth}`. Várias configurações de limitação são separadas por barras verticais (\|), e os períodos de tempo configurados não podem se sobrepor.\n\n- start: A hora de início.\n- end: A hora de término.\n- bandwidth: O limite de largura de banda em KB/s.	0:24:5120
Include	string	Não	Os caminhos a serem incluídos no backup. Todos os arquivos nos caminhos especificados são incluídos no backup. Este parâmetro é obrigatório apenas quando SourceType é definido como ECS_FILE. O valor pode ter até 255 caracteres.	["/home/alice/.pdf", "/home/bob/.txt"]
Exclude	string	Não	Os caminhos a serem excluídos do backup. Todos os arquivos nos caminhos especificados não são incluídos no backup. Este parâmetro é obrigatório apenas quando SourceType é definido como ECS_FILE. O valor pode ter até 255 caracteres.	["/var", "/proc"]
Options	string	Não	Especifica se deve ser usado o Volume Shadow Copy Service (VSS) para definir caminhos de backup para Windows. Este parâmetro é obrigatório apenas quando SourceType é definido como ECS_FILE.\n\n- Este recurso é suportado apenas para instâncias ECS Windows.\n- Se os dados na fonte de backup forem alterados e você precisar garantir a consistência entre os dados de backup e os dados de origem, defina este parâmetro como `["UseVSS":true]`.\n- Se você usar o VSS, não poderá fazer backup de várias pastas de arquivos ao mesmo tempo.	{"UseVSS":false}
UpdatePaths	boolean	Não	Especifica se os caminhos de origem devem ser atualizados quando os caminhos de origem estiverem vazios. Valores válidos:\n\n- true: atualiza os caminhos de origem com base nos caminhos definidos nesta operação.\n- false: não atualiza os caminhos de origem. O backup continua com base nos caminhos especificados quando o plano de backup foi criado.	false
Path	array	Não	O caminho de backup.
	string	Não	O caminho de origem. O valor pode ter até 65.536 caracteres. O caminho de origem deve atender às seguintes regras:\n\n- Se nenhum curinga () for usado, você pode inserir até 20 linhas de caminhos.\n- Se um curinga () for usado, você pode inserir apenas uma linha de caminho. Curingas como `//` são suportados.\n- Apenas caminhos absolutos são suportados em cada linha.\n- Se o VSS for usado, vários caminhos, caminhos UNC, curingas e arquivos excluídos não serão suportados.\n- Se o UNC for usado, VSS, curingas e arquivos excluídos não serão suportados. Se a fonte de backup contiver um caminho UNC, as ACLs do Windows não serão incluídas no backup.	["/home"]
Rule	array<object>	Não	As regras do plano de backup.
	object	Não
DestinationRetention	integer	Não	O período de retenção de backups com redundância geográfica em dias.	7
Schedule	string	Não	A política de backup. Formato válido: I\|{startTime}\|{interval}. Este formato especifica que um trabalho de backup é executado em um intervalo de {interval} a partir de {startTime}. Trabalhos de backup para horários passados não são executados. Se o trabalho de backup anterior não for concluído, o próximo trabalho de backup não será acionado. Por exemplo, I\|1631685600\|P1D especifica que um backup é realizado todos os dias a partir de 2021-09-15 14:00:00.\n\nstartTime: A hora de início do backup. O valor é um timestamp UNIX em segundos. interval: O intervalo de tempo ISO 8601. Por exemplo, PT1H especifica um intervalo de uma hora. P1D especifica um intervalo de um dia.	I\|1631685600\|P1D
Disabled	boolean	Não	Especifica se a política está desativada.	false
Retention	integer	Não	O período de retenção de backups em dias. O valor mínimo é 1.	7
DoCopy	boolean	Não	Especifica se a replicação entre regiões deve ser ativada.	false
DestinationRegionId	string	Não	O ID da região de destino para backups com redundância geográfica.	cn-shanghai
RuleName	string	Não	O nome da política.	rule-test-name
BackupType	string	Não	O tipo de backup. Valor válido: COMPLETE, que especifica um backup completo.	COMPLETE
OtsDetail	OtsDetail	Não	Os detalhes da instância Tablestore.
KeepLatestSnapshots	integer	Não	Especifica se pelo menos uma versão de backup deve ser retida. Valores válidos:\n- 0: não retém.\n- 1: retém.	1
ChangeListPath	string	Não	A configuração da lista de sincronização de arquivos incrementais. Este parâmetro é obrigatório apenas para sincronização.	{"dataSourceId": "ds-123456789", "path": "/changelist"}
Edition	string	Não	O tipo de edição. Valores válidos: BASIC e STANDARD. Valor padrão: STANDARD.	STANDARD

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Code	string	O código de status HTTP. Um valor 200 indica que a solicitação foi bem-sucedida.	200
Message	string	A mensagem retornada. Se a solicitação for bem-sucedida, "successful" será retornado. Se ocorrer um erro, a mensagem de erro correspondente será retornada.	successful
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Success	boolean	Indica se a solicitação foi bem-sucedida. Valores válidos:\n\n- true: A solicitação foi bem-sucedida.\n- false: A solicitação falhou.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Success": true
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.