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

Cria um trabalho de restauração.

Descrição da operação

Cria um trabalho de restauração com base no snapshot selecionado e no destino da restauração.
O tipo de fonte de dados e o tipo de fonte de dados do destino da restauração devem ser iguais.

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

create

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RestoreType	string	Sim	O tipo de fonte de dados do destino da restauração. Valores válidos: ECS_FILE: restaura para um arquivo ECS. OSS: restaura para o Alibaba Cloud OSS. NAS: restaura para o Alibaba Cloud NAS. COMMON_FILE_SYSTEM: restaura para CPFS. OTS_TABLE: restaura para o Alibaba Cloud OTS. UDM_ECS_ROLLBACK: restaura para uma instância ECS do Alibaba Cloud (migração por cópia completa).	ECS_FILE
VaultId	string	Não	O ID do cofre de backup ao qual o snapshot de backup pertence.	v-*********************
SnapshotId	string	Não	O ID do snapshot de backup.	s-********************
SnapshotHash	string	Não	O valor de hash do snapshot de backup.	f2fe...
SourceType	string	Sim	O tipo de fonte de dados. Valores válidos: ECS_FILE: restaura arquivos ECS. OSS: restaura o Alibaba Cloud OSS. NAS: restaura o Alibaba Cloud NAS. COMMON_FILE_SYSTEM: restaura para CPFS. OTS_TABLE: restaura para o Alibaba Cloud OTS. UDM_ECS: restaura para uma instância ECS do Alibaba Cloud (migração por cópia completa).	ECS_FILE
Options	string	Não	Os parâmetros do trabalho de restauração.	{\"includes\":[],\"excludes\":[],\"conflictPolicy\":\"OVERWRITE_EXISTING\"}
TargetFileSystemId	string	Não	Este parâmetro é válido apenas quando RestoreType está definido como NAS. O ID do sistema de arquivos do destino da restauração.	005494
TargetCreateTime	integer	Não	Este parâmetro é válido apenas quando RestoreType está definido como NAS. A hora de criação do sistema de arquivos de destino. Este valor é um timestamp UNIX. Unidade: segundos.	1554347313
TargetPath	string	Não	Este parâmetro é válido apenas quando RestoreType está definido como ECS_FILE. O caminho de arquivo do destino da restauração.	C:\
TargetBucket	string	Não	Este parâmetro é válido apenas quando RestoreType está definido como OSS. O nome do bucket OSS de destino.	hbr-backup-oss
TargetPrefix	string	Não	Este parâmetro é válido apenas quando RestoreType está definido como OSS. O prefixo do objeto do destino da restauração.	hbr
UdmDetail	object	Não	Este parâmetro é válido apenas quando SourceType está definido como UDM_ECS. Os detalhes do backup de migração por cópia completa. Este parâmetro é uma string JSON. Os detalhes variam dependendo do valor de RestoreType: UDM_ECS_DISK: clone de disco em nuvem ECS. targetInstanceId: tipo string, obrigatório. ID da instância ECS de destino à qual o disco em nuvem clonado está anexado. diskCategory: tipo string, obrigatório. O tipo do disco em nuvem de destino. diskPerformanceLevel: tipo string. Se diskCategory estiver definido como essd, este parâmetro especifica o nível de desempenho (PL) do disco em nuvem. Valores válidos: PL0, PL1, PL2 e PL3. Valor padrão: PL1. UDM_ECS_DISK_ROLLBACK: restauração de disco em nuvem ECS. sourceInstanceId: tipo string, obrigatório. ID da instância ECS de origem. foreceRestore: tipo bool. Valor padrão: false. Especifica se deve forçar a restauração. Se foreceRestore estiver definido como true, o trabalho de restauração ainda restaurará o disco em nuvem mesmo que o disco em nuvem de backup tenha sido desmontado da instância ECS original ou anexado a uma nova instância ECS. Proceda com cautela. bootAfterRestore: tipo bool. Valor padrão: false. Especifica se deve iniciar a instância ECS após a restauração. UDM_ECS: clone por cópia completa ECS. bootAfterRestore: tipo bool. Valor padrão: false. Especifica se deve iniciar a instância ECS após a restauração. diskCategory: tipo string, obrigatório. O tipo do disco em nuvem de destino. diskPerformanceLevel: tipo string. Se diskCategory estiver definido como essd, este parâmetro especifica o nível de desempenho (PL) do disco em nuvem. Valores válidos: PL0, PL1, PL2 e PL3. Valor padrão: PL1. instanceType: tipo string, obrigatório. O tipo da instância ECS de destino. restoredNetwork: tipo string, obrigatório. O ID do vSwitch da instância ECS de destino. securityGroup: tipo string, obrigatório. O ID do grupo de segurança da instância ECS de destino. restoredName: tipo string, obrigatório. O nome da instância ECS de destino. restoredHostName: tipo string, obrigatório. O nome do host da instância ECS de destino. allocatePublicIp: tipo bool. Valor padrão: false. Especifica se deve atribuir um endereço IP público à instância ECS de destino. privateIpAddress: tipo string. O endereço IP interno da instância ECS de destino. Se este parâmetro não for especificado, o DHCP será usado para atribuir aleatoriamente um endereço IP. UDM_ECS_ROLLBACK: restauração por cópia completa ECS. sourceInstanceId: tipo string, obrigatório. ID da instância ECS de origem. forceRestore: tipo bool. Valor padrão: false. Especifica se deve forçar a restauração. Se foreceRestore estiver definido como true, o trabalho de restauração ainda restaurará o disco em nuvem mesmo que o disco em nuvem de backup tenha sido desmontado da instância ECS original ou anexado a uma nova instância ECS. Proceda com cautela. bootAfterRestore: tipo bool. Valor padrão: false. Especifica se deve iniciar a instância ECS após a restauração.	{\"sourceInstanceId\":\"i-uf62te6pm3iwsyxyz66q\",\"bootAfterRestore\":false}
UdmRegionId	string	Não	Este parâmetro é válido apenas quando SourceType está definido como UDM_ECS. A região de destino para restauração.	cn-shanghai
TargetInstanceId	string	Não	Este parâmetro é válido apenas quando RestoreType está definido como ECS_FILE. O ID da instância ECS do destino da restauração.	i-*********************
Include	string	Não	O caminho a ser restaurado. Todos os arquivos neste caminho são restaurados. Comprimento máximo: 255 caracteres.	["/home/alice/.pdf", "/home/bob/.txt"]
Exclude	string	Não	O caminho a ser excluído da restauração. Todos os arquivos neste caminho não são restaurados. Comprimento máximo: 255 caracteres.	["/var", "/proc"]
TargetContainer	string	Não	Os detalhes do contêiner de destino para restauração.	{\"host\":\"k8s-node1\",\"hostPrefix\":\"/var/lib/kubelet/pods/4acb31fe-8577-40ff-bc8c-eccabd835f73/volumes/kubernetes.io~csi/pvc-b050b00e-ef17-4792-aab1-1642355cf1f4/mount\",\"pvPath\":\"/\"}
InitiatedByAck	boolean	Não	Especifica se a operação é invocada pelo Container Service. Valor padrão: false.	false
TargetContainerClusterId	string	Não	O ID do cluster de contêineres de destino para restauração.	cc-000amjsc7o1h9506oob7
TargetInstanceName	string	Não	O nome da instância Tablestore de destino para restauração.	instancename
TargetTableName	string	Não	O nome da tabela de dados de destino no Tablestore para restauração.	tablename
TargetTime	integer	Não	O ponto no tempo para o qual os dados do Tablestore são restaurados. Este valor é um timestamp UNIX. Unidade: segundos.	1642496881
OtsDetail	OtsTableRestoreDetail	Não	Os detalhes da instância Tablestore.
CrossAccountType	string	Não	O tipo de backup entre contas. Valores válidos: SELF_ACCOUNT: backup dentro da conta atual. CROSS_ACCOUNT: backup entre contas.	SELF_ACCOUNT
CrossAccountUserId	integer	Não	O ID da conta de origem para backup entre contas gerenciado pela conta atual.	158975xxxxx4625
CrossAccountRoleName	string	Não	O nome da função RAM criada na conta de origem para backup entre contas gerenciado pela conta atual.	BackupRole
FailbackDetail	object	Não	Os detalhes da restauração para o host local.	{"cpu":4,"extra":"{\"restoreVMNamePrefix\":\"627-\",\"dataCenterName\":\"SDDC-Datacenter\",\"dataStoreId\":\"datastore-50\",\"folderId\":\"group-v49\",\"resourcePoolId\":\"resgroup-46\",\"locationName\":\"vcenter.pc-uf600a****1.acvs.aliyuncs.com/SDDC-Datacenter/Workloads\",\"computeResourceName\":\"SDDC-Datacenter/Default_c-uf600a**\",\"dataStoreName\":\"Default_c-uf600a**/WorkloadDatastore\",\"networkMoReference\":\"DistributedVirtualPortgroup:dvportgroup-1001\",\"useHotAdd\":false}","instanceId":"i-2vc****z","memoryInMB":8192,"serverId":"0fdc0c86-eb92-4e05-91ab-eeaf9fb6ad01","uefiBoot":false}
Edition	string	Não	A edição do recurso Cloud Backup. Valores válidos: STANDARD: Edição Standard. Este é o valor padrão. BASIC: Edição Essential. Atualmente, apenas a Edição Essential de Backup de Arquivos ECS é suportada.	STANDARD

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Code	string	O código de resposta. O valor 200 indica sucesso.	200
Message	string	A mensagem de resposta. O valor "successful" é retornado em caso de sucesso. Uma mensagem de erro é retornada em caso de falha.	successful
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Success	boolean	Indica se a solicitação foi bem-sucedida. true: A solicitação foi bem-sucedida. false: A solicitação falhou.	true
RestoreId	string	O ID do trabalho de restauração.	r-*********************

Exemplos

Resposta de sucesso

JSON formato

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

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.