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

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

As instâncias Windows não suportam pares de chaves SSH.
Após vincular um par de chaves SSH a uma instância, a autenticação por nome de usuário e senha é desativada.
Se a instância estiver no estado Running, reinicie a instância (RebootInstance) para que o par de chaves SSH entre em vigor.
Se a instância estiver no estado Stopped, inicie a instância (StartInstance) para que o par de chaves SSH entre em vigor.
Se um par de chaves SSH já estiver vinculado à instância, o novo par de chaves SSH substituirá automaticamente o original.

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

*Instance

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

*KeyPair

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 da Alibaba Cloud.	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 vincular o par de chaves SSH. O valor pode ser uma matriz JSON que consiste em até 50 IDs de instâncias. Separe vários 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-A3DC0DE3C83E
TotalCount	string	O número total de instâncias às quais o par de chaves está vinculado.	2
FailCount	string	O número de instâncias às quais não foi possível vincular o par de chaves.	0
Results	object
Result	array<object>	Os resultados da vinculação do par de chaves.
	object
Code	string	The operation status code. A value of 200 indicates that the operation is successful.	200
Message	string	The operation message. When Code is 200, the value of Message is successful.	successful
InstanceId	string	The instance ID.	i-m5eg7be9ndloji64****
Success	string	Indicates whether the operation is successful.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "KeyPairName": "testKeyPairName",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": "2",
  "FailCount": "0",
  "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.	The specified KeyPairName parameter does not exist.
400	InvalidInstanceIds.ValueNotSupported	The specified parameter InstanceIds is not valid.	The specified InstanceIds parameter is invalid.
400	DependencyViolation.IoOptimize	The specified parameter InstanceIds is not valid.	The specified instance ID is invalid. The specified instance is not an I/O optimized instance.
403	DependencyViolation.WindowsInstance	The instance creating is windows, cannot use ssh key pair to login	The specified instance is a Windows instance and does not support logons using SSH key pairs.
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.