AttachKeyPair - Elastic Compute Service - Centro de documentación de Alibaba Cloud

Adjunta un par de claves SSH a una o más instancias Linux.

Descripción de la operación

Al llamar a esta operación, tenga en cuenta los siguientes puntos:

Las instancias Windows no admiten pares de claves SSH.
Después de adjuntar un par de claves SSH, se deshabilita la autenticación mediante nombre de usuario y contraseña.
Si una instancia está en estado Running, reinicie la instancia llamando a RebootInstance para que el par de claves SSH surta efecto.
Si una instancia está en estado Stopped, inicie la instancia llamando a StartInstance para que el par de claves SSH surta efecto.
Si ya hay un par de claves SSH adjunto a una instancia, el nuevo par de claves SSH reemplaza automáticamente al original.
Se trata de una operación por lotes que admite éxito parcial. Una respuesta HTTP 200 solo indica que se procesó la solicitud, no que el par de claves se haya adjuntado correctamente a todas las instancias. Compruebe el valor de FailCount y los campos Code y Success de cada elemento de Results.Result[] para determinar el resultado de cada instancia:
- Errores de nivel de solicitud: los errores, como parámetros no válidos, un par de claves inexistente o más de 50 instancias, se interceptan antes de la ejecución por lotes. El error se devuelve en el nivel superior de la respuesta con un código de estado HTTP distinto de 200 y toda la solicitud por lotes falla.
- Errores de nivel de instancia: los errores, como una instancia Windows, un estado de instancia no admitido o un tipo de instancia no admitido, afectan únicamente a la instancia correspondiente. El código de error se registra en el elemento Results.Result[] correspondiente y la solicitud general aún devuelve HTTP 200.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

ecs:AttachKeyPair

update

*Instance

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

*KeyPair

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

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	Sí	El ID de la región del par de claves SSH. Puede llamar a DescribeRegions para consultar la lista más reciente de regiones.	cn-hangzhou
KeyPairName	string	Sí	El nombre del par de claves SSH.	testKeyPairName
InstanceIds	string	Sí	Los ID de las instancias a las que desea adjuntar el par de claves SSH. El valor puede ser un arreglo JSON que consta de hasta 50 ID de instancias. Separe los ID con comas (,).	["i-bp1gtjxuuvwj17zr**", "i-bp17b7zrsbjwvmfy", … "i-bp1h6jmbefj1ytos**"]

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
KeyPairName	string	El nombre del par de claves.	testKeyPairName
RequestId	string	El ID de la solicitud.	473469C7-AA6F-4DC5-B3DB-A3*****83E
TotalCount	string	El número total de instancias a las que se adjunta el par de claves.	2
FailCount	string	El número de instancias a las que no se pudo adjuntar el par de claves.	1
Results	object
Result	array<object>	La colección de resultados que indica si el par de claves está adjunto a cada instancia.
	object	El resultado.
Code	string	El código de estado de la operación. Un valor de 200 indica que la operación se realizó correctamente.	200
Message	string	El mensaje de la operación. Si Code es 200, el mensaje es correcto.	successful
InstanceId	string	El ID de la instancia.	i-m5eg7be9ndloji64****
Success	string	Indica si la operación se realizó correctamente.	true

Ejemplos

Respuesta exitosa

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 error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	InvalidKeyPairName.NotFound	The specified KeyPairName does not exist in our records.	El KeyPairName especificado no existe.
400	InvalidInstanceIds.ValueNotSupported	The specified parameter InstanceIds is not valid.	El parámetro InstanceIds especificado no es válido.
400	DependencyViolation.IoOptimize	The specified parameter InstanceIds is not valid.	El ID de instancia especificado no es válido, o la configuración de optimización de E/S especificada para la instancia no es válida.
403	DependencyViolation.WindowsInstance	The instance creating is windows, cannot use ssh key pair to login	Los pares de claves no son compatibles con las instancias de Windows.
403	InstanceKeyPairLimitExceeded	The specified instances are beyond the permitted range.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.