AttachKeyPair

Description

When you call this interface, consider the following:

• SSH key pairs are not supported for Windows instances.

• Once the SSH key pair is used, the authentication method by using the user name and password is disabled, by default.

• If the instance is in Running (Running) status, restart the instance (RebootInstance) to make the operation take effect.

• If the instance is in Stopped (Stopped) status, the SSH key pair takes effect immediately once the instance starts (StartInstance).

• If an instance already has an attached SSH key pair, the new SSH key pair replaces the former one automatically.

Request parameters

Response parameters

All are common response parameters. For more information, see Common parameters.

Examples

https://ecs.aliyuncs.com/?Action=AttachKeyPair
&RegionId=cn-qingdao
&KeyPairName=test
&InstanceIds=["i-XXXXX"]
&<Common Request Parameters>

<AttachKeyPairResponse>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
</AttachKeyPairResponse>

{
    "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

Error codes

Error codes specific to this interface are as follows. For more information, see API Error Center.