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

Cria um plano de backup.

Descrição da operação

Importante

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:CreateBackupPlan

create

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
SourceType	string	Sim	O tipo da fonte de dados. Valores válidos:	ECS_FILE
PlanName	string	Não	O nome do plano de backup. O nome deve ter de 1 a 64 caracteres. O nome do plano de backup deve ser exclusivo para cada tipo de fonte de dados dentro de um único cofre.	planname
BackupType	string	Não	O tipo de backup. Defina o valor como COMPLETE, que indica backup completo.	COMPLETE
VaultId	string	Não	O ID do cofre.	v-0006******q
Schedule	string	Não	A política de backup. Formato: `I\|{startTime}\|{interval}`. Isso indica que um job de backup é executado a cada `{interval}` começando em `{startTime}`. Jobs de backup para períodos passados não são compensados. Se o job de backup anterior não for concluído, o próximo job de backup não será acionado. Exemplo: `I\|1631685600\|P1D` indica que um backup é realizado uma vez por dia a partir de 2021-09-15 14:00:00.	I\|1602673264\|P1D
Retention	integer	Não	O período de retenção dos dados de backup. Valor mínimo: 1. Unidade: dias.	7
ClusterId	string	Não	O ID do grupo de clientes que executa o plano de sincronização de dados. Este parâmetro é necessário apenas para sincronização de dados.	cl-***************
FileSystemId	string	Não	Este parâmetro é necessário apenas quando SourceType está definido como NAS. O ID do sistema de arquivos.	005494
CreateTime	integer	Não	Este parâmetro é necessário apenas quando SourceType está definido como NAS. A hora em que o sistema de arquivos foi criado. O valor é um timestamp UNIX. Unidade: segundos.	1607436917
Bucket	string	Não	Este parâmetro é necessário apenas quando SourceType está definido como OSS. O nome do bucket do OSS.	hbr-backup-oss
Prefix	string	Não	Este parâmetro é necessário apenas quando SourceType está definido como OSS. O prefixo de backup. Se especificado, apenas objetos que correspondem ao prefixo terão backup realizado.	oss-prefix
InstanceId	string	Não	Este parâmetro é necessário apenas quando SourceType está definido como ECS_FILE. O ID da instância ECS.	i-m5e*****6q
Detail	object	Não	Os detalhes do backup de cópia completa. O valor é uma string JSON.	{\"EnableFsFreeze\":true,\"appConsistent\":false,\"postScriptPath\":\"\",\"preScriptPath\":\"\",\"snapshotGroup\":true,\"timeoutInSeconds\":60}
UdmRegionId	string	Não	A região onde reside a instância ECS para backup de cópia completa.	cn-shanghai
SpeedLimit	string	Não	Este parâmetro é necessário apenas quando SourceType está definido como ECS_FILE. O controle de tráfego de backup. Formato: `{start}:{end}:{bandwidth}`. Separe várias configurações de controle de tráfego com barras verticais (\|). Os intervalos de tempo das configurações não podem se sobrepor.	0:24:5120
Include	string	Não	Este parâmetro é necessário apenas quando SourceType está definido como ECS_FILE. O caminho a ser incluído no backup. Todos os arquivos neste caminho terão backup realizado. O valor pode ter até 255 caracteres.	["/home/alice/.pdf", "/home/bob/.txt"]
Exclude	string	Não	Este parâmetro é necessário apenas quando SourceType está definido como ECS_FILE. O caminho a ser excluído do backup. Nenhum arquivo neste caminho terá backup realizado. O valor pode ter até 255 caracteres.	["/var", "/proc"]
Options	string	Não	Este parâmetro é necessário apenas quando SourceType está definido como ECS_FILE. Especifica se deve ser usado o Windows Volume Shadow Copy Service (VSS) para definir o caminho de origem.	{"UseVSS":false}
DataSourceId	string	Não	O ID da fonte de dados de origem. Este parâmetro é necessário apenas para sincronização de dados.	ds-****************
Path	array	Não	Os caminhos de origem.
	string	Não	O caminho de origem. O valor pode ter até 65536 caracteres.	["/home"]
Rule	array<object>	Não	As regras do plano de backup.
	object	Não	As regras do plano de backup.
DestinationRetention	integer	Não	O período de retenção do backup com redundância geográfica. Unidade: dias.	7
Schedule	string	Não	A política de backup. Formato: I\|{startTime}\|{interval}. Isso indica que um job de backup é executado a cada {interval} começando em {startTime}. Jobs de backup para períodos passados não são executados. Se o job de backup anterior não for concluído, o próximo job de backup não será acionado. Exemplo: I\|1631685600\|P1D indica que um backup é realizado uma vez por dia a partir de 2021-09-15 14:00:00.	I\|1602673264\|P1D
Retention	integer	Não	O período de retenção do backup.	7
Disabled	boolean	Não	Especifica se a regra está desativada.	false
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 replicação entre regiões.	cn-hangzhou
RuleName	string	Não	O nome da regra.	rule-test-name
BackupType	string	Não	O tipo de backup.	COMPLETE
InstanceName	string	Não	O nome da instância do Tablestore.	instancename
OtsDetail	OtsDetail	Não	Os detalhes da instância do Tablestore.
CrossAccountType	string	Não	O tipo de backup entre contas. Valores válidos: Valores válidos: SELF_ACCOUNT : SELF_ACCOUNT. CROSS_ACCOUNT : CROSS_ACCOUNT.	CROSS_ACCOUNT
CrossAccountUserId	integer	Não	O ID da conta de origem para backup entre contas.	15897534xxxx4625
CrossAccountRoleName	string	Não	O nome da função RAM criada na conta de origem para backup entre contas.	BackupRole
KeepLatestSnapshots	integer	Não	Especifica se pelo menos uma versão de backup deve ser retida. Valores válidos: Valores válidos: 0 : Não retém. 1 : Retém.	1
DestSourceType	string	Não	O tipo da fonte de dados de destino. Este parâmetro é necessário apenas para sincronização de dados.	OSS
DestDataSourceId	string	Não	O ID da fonte de dados de destino. Este parâmetro é necessário apenas para sincronização de dados.	ds-*********************
DestDataSourceDetail	object	Não	Os detalhes da fonte de dados de destino. Este parâmetro é necessário apenas para sincronização de dados.	{\"prefix\":\"/\"}
ChangeListPath	string	Não	A configuração da lista de sincronização incremental de arquivos. Este parâmetro é necessário apenas para sincronização de dados.	{"dataSourceId": "ds-123456789", "path": "/changelist"}
Disabled	boolean	Não	Especifica se o plano está desativado por padrão.	true
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	Os parâmetros de resposta.
Code	string	O código de resposta. O valor 200 indica sucesso.	200
Message	string	A mensagem retornada. O valor "successful" é retornado para uma resposta de sucesso. Uma mensagem de erro é retornada para uma resposta de falha.	successful
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PlanId	string	O ID do plano de backup.	plan-*********************
Success	boolean	Indica se a solicitação foi bem-sucedida.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PlanId": "plan-*********************",
  "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.