All Products
Search
Document Center

Simple Application Server:DetachKeyPair

Last Updated:Oct 30, 2024

Unbinds key pairs from simple application servers.

Operation description

If you want to change the SSH key pairs that are bound to your simple application servers or your end user no longer needs to access a specific simple application server, you can unbind the SSH key pairs from simple application servers to improve the security of the simple application servers or restrict access to the specific simple application server.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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
swas-open:DetachKeyPairupdate
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the simple application servers.

cn-hangzhou
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.

123e4567-e89b-12d3-a456-426655440000
InstanceIdsarrayYes

The IDs of the simple application servers from which you want to unbind SSH key pairs. You can specify a maximum of 50 IDs of simple application servers.

stringYes

The ID of the simple application server from which you want to unbind an SSH key pair. You can specify a maximum of 50 IDs of simple application servers.

2ad1ae67295445f598017499dc****
KeyPairNamestringYes

The name of the key pair. The name must be globally unique. The name must be 2 to 64 characters in length and can contain letters, digits, colons (:), underscores (_), and hyphens (-). The name must start with a letter but cannot start with http:// or https://.

KeyPairName

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

20758A-585D-4A41-A9B2-28DA8F4F534F
TotalCountinteger

The total number of simple application servers from which the SSH key pair is unbound.

4
FailCountinteger

The total number of simple application servers from which you fail to unbind key pairs.

0
Resultsarray<object>

The request results.

Resultobject
Codestring

The HTTP status code.

200
Messagestring

The response message.

success
Successstring

Indicates whether the key pair is unbound from the simple application server successfully. Valid values:

  • true
  • false
True
InstanceIdstring

The ID of the simple application server.

aa6e71ddb35c46679bc4753d6219d604

Examples

Sample success responses

JSONformat

{
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
  "TotalCount": 4,
  "FailCount": 0,
  "Results": [
    {
      "Code": "200",
      "Message": "success",
      "Success": "True",
      "InstanceId": "aa6e71ddb35c46679bc4753d6219d604"
    }
  ]
}

Error codes

HTTP status codeError codeError message
400InvalidParameter.KeypairNotAttachedInstanceThe specified keyPair not attached to instances.
404InvalidInstanceId.NotFoundThe specified Instance Id does not exist.

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

Change history

Change timeSummary of changesOperation
2024-05-28The Error code has changedView Change Details