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

Instala clientes de backup em uma ou mais instâncias ECS.

Descrição da operação

Esta operação cria uma tarefa assíncrona em segundo plano. A tarefa usa o Cloud Assistant para instalar clientes de backup em instâncias ECS.
Chame a operação DescribeTask para obter o resultado da tarefa.
O tempo limite da tarefa é de 15 minutos. Após a criação da tarefa, aguarde 60 segundos antes de fazer a primeira consulta. Em seguida, consulte o resultado a cada 30 segundos.

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

update

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceIds	object	Sim	Os IDs das instâncias ECS. Você pode especificar até 20 IDs de instâncias.	["i-0xi5wj5*****v3j3bh2gj5"]
CrossAccountType	string	Não	O tipo de backup entre contas. Valores válidos: SELF_ACCOUNT: Faz backup de dados na conta atual. CROSS_ACCOUNT: Faz backup de dados entre contas.	CROSS_ACCOUNT
CrossAccountUserId	integer	Não	O ID da conta de origem usada para backup entre contas.	16392782xxxxxx
CrossAccountRoleName	string	Não	O nome da função RAM criada na conta de origem para backup entre contas.	BackupRole

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Code	string	O código de retorno. Um valor 200 indica que a operação foi bem-sucedida.	200
Message	string	A mensagem retornada. Se a solicitação for bem-sucedida, successful é retornado. Se a solicitação falhar, uma mensagem de erro é retornada.	successful
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TaskId	string	O ID da tarefa assíncrona. Chame a operação DescribeTask para consultar o resultado da tarefa.	t-*********************
Success	boolean	Indica se a solicitação foi bem-sucedida. true: A solicitação foi bem-sucedida. false: A solicitação falhou.	true
InstanceStatuses	array<object>	O status das instâncias ECS.
	object
ValidInstance	boolean	Indica se um cliente de backup pode ser instalado na instância ECS. true: O cliente de backup pode ser instalado. false: O cliente de backup não pode ser instalado.	true
InstanceId	string	O ID da instância ECS.	i-0xi5w***v3j3bh2gj5
ErrorCode	string	O código de erro. Valores válidos: Um valor vazio indica que a operação foi bem-sucedida. InstanceNotExists: A instância ECS não existe. InstanceNotRunning: A instância ECS não está no estado Running. CloudAssistNotRunningOnInstance: O Cloud Assistant não está disponível.	InstanceNotExists

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TaskId": "t-*********************",
  "Success": true,
  "InstanceStatuses": [
    {
      "ValidInstance": true,
      "InstanceId": "i-0xi5w***v3j3bh2gj5",
      "ErrorCode": "InstanceNotExists"
    }
  ]
}

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.