Unbinds an SSH key pair from one or more Linux instances.
Operation description
When you call this operation, take note of the following items:
- After you unbind an SSH key pair from an instance, you must call the RebootInstance operation to restart the instance to allow the unbind operation to take effect.
- After you unbind an SSH key pair from an instance, the username and password authentication method is selected for the instance.
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RegionId | string | Yes | The region ID of the SSH key pair. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
KeyPairName | string | Yes | The name of the SSH key pair. | testKeyPairName |
InstanceIds | string | Yes | The IDs of instances from which you want to unbind the SSH key pair. The value can be a JSON array that consists of up to 50 instance IDs. Separate multiple instance IDs with commas (,). | ["i-bp1d6tsvznfghy7y****", "i-bp1ippxbaql9zet7****", … "i-bp1ib7bcz07l****"] |
Response parameters
Examples
Sample success responses
JSON
format
{
"KeyPairName": "testKeyPairName",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"TotalCount": "2",
"FailCount": "0",
"Results": {
"Result": [
{
"Code": "200",
"Message": "successful",
"InstanceId": "i-bp1d6tsvznfghy7y****",
"Success": "true"
}
]
}
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
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. |
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. | - |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||||
---|---|---|---|---|---|---|---|---|
2023-07-10 | The Error code has changed | see changesets | ||||||
|