AttachKeyPair

Description

When you call this operation, note that:

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

Debugging

You can use API Explorer to perform debugging. API Explorer allows you to perform various operations to simplify API usage. For example, you can retrieve APIs, call APIs, and dynamically generate SDK example code.

Request parameters

Response parameters

Examples

Sample requests

https://ecs.aliyuncs.com/?Action=AttachKeyPair
&InstanceIds=["i-xxxxxxxxx", "i-yyyyyyyyy", … "i-zzzzzzzzz"]
&KeyPairName=FinanceJoshuaV25
&RegionId=cn-hangzhou 
&<Common request parameters>

Successful response examples

XML format

<AttachKeyPairResponse>
  <TotalCount>2</TotalCount>
  <RequestId>4ADF7A06-66BD-4FBF-A2ED-2364E41D8C06</RequestId><RequestId> 4ADF7A06-66BD-4FBF-A2ED-2364E41D8C06 </RequestId>
  <Results>
    </Result>
      <Message>AccessDenied</Message>
       <InstanceId>i-m5eg7be9ndloji64jknv</InstanceId>
      <Success>true</Success>
      <Code>200</Code>
    </Result>
    </Result>
      <Message>AccessDenied</Message>
       <InstanceId>i-m5e25x2mwr0hk33dwv0h</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-m5eg7be9ndloji64jknv",
				"Success":true,
				"Code":"200"
			},
			{
				"Message":"successful",
				"InstanceId":"i-m5e25x2mwr0hk33dwv0h",
				"Success":true,
				"Code":"200"
			}
		]
	},
	"FailCount":0
}

Error codes

View error codes