All Products
Search
Document Center

Elastic Compute Service:DetachKeyPair

Last Updated:Sep 29, 2024

Unbinds an SSH key pair from 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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ecs:DetachKeyPairupdate
  • Instance
    acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}
  • KeyPair
    acs:ecs:{#regionId}:{#accountId}:keypair/{#keypairName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the SSH key pair. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
KeyPairNamestringYes

The name of the SSH key pair.

testKeyPairName
InstanceIdsstringYes

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

ParameterTypeDescriptionExample
object
KeyPairNamestring

The name of the key pair.

testKeyPairName
RequestIdstring

The ID of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCountstring

The total number of instances from which you want to unbind the SSH key pair.

2
FailCountstring

The number of instances from which the SSH key pair failed to be unbound.

0
Resultsarray<object>

The result set of the unbind operation.

Resultobject
Codestring

The operation status code that is returned. 200 indicates that the operation is successful.

200
Messagestring

The result of the operation. For example, if the value of Code is 200, the value of Message is successful.

successful
InstanceIdstring

The ID of the instance.

i-bp1d6tsvznfghy7y****
Successstring

Indicates whether the operation is successful.

true

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400InvalidKeyPairName.NotFoundThe specified KeyPairName does not exist in our records.The specified KeyPairName parameter does not exist.
400InvalidInstanceIds.ValueNotSupportedThe specified parameter InstanceIds is not valid.The specified InstanceIds parameter is invalid.
403DependencyViolation.WindowsInstanceThe instance creating is windows, cannot use ssh key pair to login.-
403InstanceKeyPairLimitExceededThe specified instances are beyond the permitted range.-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-07-10The Error code has changedView Change Details