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

Instala um ou mais clientes do Cloud Backup em uma instância especificada.

Descrição da operação

Antes de chamar esta operação, certifique-se de compreender totalmente os métodos de cobrança e os preços do Cloud Backup. Para mais informações, consulte Métodos de cobrança e itens cobráveis.

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

create

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
VaultId	string	Sim	O ID do cofre de backup.	v-0001ufe******kgm
AlertSetting	string	Não	As configurações de alerta. O valor INHERITED especifica que o método de alerta do cofre de backup é utilizado.	INHERITED
ClientInfo	string	Não	As informações de instalação do cliente.	[ { "instanceId": "i-bp116lr****te9q2", "accessKeyId": "", "accessKeySecret": "", "clusterId": "cl-000csy09q**9rfz9", "sourceTypes": [ "HANA" ] }, { "instanceId": "i-bp116lrux****hte9q4", "accessKeyId": "", "accessKeySecret": "", "clusterId": "cl-000csy09q5094vw9rfz9", "sourceTypes": [ "HANA" ] }]
UseHttps	boolean	Não	Especifica se deve usar HTTPS para transmissão de dados. Valores válidos: true: Usa HTTPS. false: Usa HTTP.	false
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-aekzvx7d3c4kpny
CrossAccountType	string	Não	O tipo de backup entre contas. Valores válidos: SELF_ACCOUNT: backup da conta atual CROSS_ACCOUNT: backup entre contas	CROSS_ACCOUNT
CrossAccountUserId	integer	Não	O ID da conta de origem para backups entre contas gerenciados pela conta atual.	158975xxxxx4625
CrossAccountRoleName	string	Não	O nome da função RAM criada na conta de origem para backups entre contas gerenciados pela conta atual.	hbrcrossrole

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Code	string	O código de retorno. O valor 200 indica sucesso.	200
Message	string	A mensagem de resposta. O valor geralmente é successful se a chamada for bem-sucedida. Se ocorrer um erro, a mensagem de erro correspondente é retornada.	successful
RequestId	string	O ID da solicitação.	4A8A9AE4-F798-5E6D-853E-10F9F5A1BD4E
TaskId	string	O ID da tarefa assíncrona. Você pode chamar DescribeTask para consultar o resultado da tarefa.	t-000h9x5t02vhyksf1x7k
Success	boolean	Indica se a solicitação foi bem-sucedida. Valores válidos: true: A solicitação foi bem-sucedida. false: A solicitação falhou.	true
InstanceStatuses	object
InstanceStatus	array<object>	O status da instância ECS. Se o status de uma instância ECS não atender aos requisitos para instalação do cliente e a solicitação contiver mais de um ID de instância, este campo retornará a mensagem de erro.
	object	O status da instância ECS. Se o status de uma instância ECS não atender aos requisitos para instalação do cliente e a solicitação contiver mais de um ID de instância, este campo retornará a mensagem de erro.
ValidInstance	boolean	Indica se um cliente de backup pode ser instalado na instância ECS. Valores válidos: true: Um cliente de backup pode ser instalado. false: Um cliente de backup não pode ser instalado.	true
InstanceId	string	O ID da instância ECS.	i-2zegp3cdu******uj9i

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "4A8A9AE4-F798-5E6D-853E-10F9F5A1BD4E",
  "TaskId": "t-000h9x5t02vhyksf1x7k",
  "Success": true,
  "InstanceStatuses": {
    "InstanceStatus": [
      {
        "ValidInstance": true,
        "InstanceId": "i-2zegp3cdu******uj9i"
      }
    ]
  }
}

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.