AttachKeyPair - Elastic Compute Service: Central de Documentação do Alibaba Cloud

Anexa um par de chaves SSH a uma ou mais instâncias Linux.

Descrição da operação

Ao chamar esta operação, observe os seguintes itens:

Instâncias Windows não suportam pares de chaves SSH.
Após anexar um par de chaves SSH, a autenticação por nome de usuário e senha é desativada.
Se uma instância estiver no estado Running, reinicie a instância chamando RebootInstance para que o par de chaves SSH tenha efeito.
Se uma instância estiver no estado Stopped, inicie a instância chamando StartInstance para que o par de chaves SSH tenha efeito.
Se um par de chaves SSH já estiver anexado a uma instância, o novo par de chaves SSH substituirá automaticamente o original.
Esta é uma operação em lote que suporta sucesso parcial. Uma resposta HTTP 200 indica apenas que a solicitação foi processada, e não que todas as instâncias foram anexadas com sucesso. Verifique o valor de FailCount e os campos Code e Success de cada elemento em Results.Result[] para determinar o resultado de cada instância:
- Erros no nível da solicitação: Erros como parâmetros inválidos, par de chaves inexistente ou mais de 50 instâncias são interceptados antes da execução em lote. O erro é retornado no nível superior da resposta com um código de status HTTP diferente de 200, e toda a solicitação em lote falha.
- Erros no nível da instância: Erros como uma instância Windows, um estado de instância não suportado ou um tipo de instância não suportado afetam apenas a instância correspondente. O código de erro é registrado no elemento Results.Result[] correspondente, e a solicitação geral ainda retorna HTTP 200.

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

ecs:AttachKeyPair

update

*Instância.

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

*Par de chaves.

acs:ecs:{#regionId}:{#accountId}:keypair/{#keypairName}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região do par de chaves SSH. Você pode chamar DescribeRegions para consultar a lista de regiões mais recente.	cn-hangzhou
KeyPairName	string	Sim	O nome do par de chaves SSH.	testKeyPairName
InstanceIds	string	Sim	Os IDs das instâncias às quais você deseja anexar o par de chaves SSH. O valor pode ser uma matriz JSON que consiste em até 50 IDs de instância. Separe os IDs com vírgulas (,).	["i-bp1gtjxuuvwj17zr**", "i-bp17b7zrsbjwvmfy", … "i-bp1h6jmbefj1ytos**"]

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
KeyPairName	string	O nome do par de chaves.	testKeyPairName
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3*****83E
TotalCount	string	O número total de instâncias às quais o par de chaves está anexado.	2
FailCount	string	O número de instâncias às quais o par de chaves não pôde ser anexado.	1
Results	object
Result	array<object>	A coleção de resultados que indicam se o par de chaves está anexado a cada instância.
	object	O resultado.
Code	string	O código de status da operação. Um valor 200 indica que a operação foi bem-sucedida.	200
Message	string	A mensagem da operação. Se Code for 200, a mensagem indica sucesso.	successful
InstanceId	string	O ID da instância.	i-m5eg7be9ndloji64****
Success	string	Indica se a operação foi bem-sucedida.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "KeyPairName": "testKeyPairName",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3*****83E",
  "TotalCount": "2",
  "FailCount": "1",
  "Results": {
    "Result": [
      {
        "Code": "200",
        "Message": "successful",
        "InstanceId": "i-m5eg7be9ndloji64****",
        "Success": "true"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidKeyPairName.NotFound	The specified KeyPairName does not exist in our records.	O KeyPairName especificado não existe.
400	InvalidInstanceIds.ValueNotSupported	The specified parameter InstanceIds is not valid.	O parâmetro InstanceIds especificado é inválido.
400	DependencyViolation.IoOptimize	The specified parameter InstanceIds is not valid.	O ID da instância especificado é inválido ou a configuração de otimização de E/S da instância especificada é inválida.
403	DependencyViolation.WindowsInstance	The instance creating is windows, cannot use ssh key pair to login	Os pares de chaves não são suportados para instâncias Windows.
403	InstanceKeyPairLimitExceeded	The specified instances are beyond the permitted range.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.