AttachKeyPair

Description

When you call this operation, take note of the following items:

• SSH key pairs are not supported on Windows instances.
• If an SSH key pair is attached to an instance, the username and password authentication is disabled for the instance.
• If an instance is in the Running (Running) state, call the RebootInstance operation to restart the instance for the SSH key pair to take effect.
• If an instance is in the Stopped (Stopped) state, call the StartInstance operation to start the instance for the SSH key pair to take effect.
• If an instance already has an SSH key pair attached, the new SSH key pair will automatically replace the original one.

Request parameters

Response parameters

Examples

Sample requests

https://ecs.aliyuncs.com/?Action=AttachKeyPair
&InstanceIds=["i-bp1gtjxuuvwj17zr****", "i-bp17b7zrsbjwvmfy****", … "i-bp1h6jmbefj1ytos****"]
&KeyPairName=testKeyPairName
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

<AttachKeyPairResponse>
      <TotalCount>2</TotalCount>
      <RequestId>4ADF7A06-66BD-4FBF-A2ED-2364E41D8C06</RequestId>
      <Results>
            <Result>
                  <Message>successful</Message>
                  <InstanceId>i-m5eg7be9ndloji64****</InstanceId>
                  <Success>true</Success>
                  <Code>200</Code>
            </Result>
            <Result>
                  <Message>successful</Message>
                  <InstanceId>i-m5e25x2mwr0hk33d****</InstanceId>
                  <Success>true</Success>
                  <Code>200</Code>
            </Result>
      </Results>
      <FailCount>0</FailCount>
</AttachKeyPairResponse>

JSON format

{
    "TotalCount": 2,
    "RequestId": "4ADF7A06-66BD-4FBF-A2ED-2364E41D8C06",
    "Results": {
        "Result": [
            {
                "Message": "successful",
                "InstanceId": "i-m5eg7be9ndloji64****",
                "Success": true,
                "Code": "200"
            },
            {
                "Message": "successful",
                "InstanceId": "i-m5e25x2mwr0hk33d****",
                "Success": true,
                "Code": "200"
            }
        ]
    },
    "FailCount": 0
}

Error codes

For a list of error codes, visit the API Error Center.