All Products
Search
Document Center

ENS:DeleteKeyPairs

Last Updated:Mar 19, 2024

Deletes SSH key pairs.

Operation description

  • After you delete an SSH key pair, you can no longer query the key pair by calling the DescribeKeyPairs operation.
  • If you delete an SSH key pair that is bound to an Edge Node Service (ENS) instance, ENS no longer stores the SSH key pair. However, you can still use the key pair to access the instance. When you call the DescribeInstance operation to query instance information, no other information but the name of the key pair (KeyPairName) is returned.

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
KeyPairNamestringNo

The name of the key pair. The name must conform to the following naming conventions:

  • The name must be 2 to 128 characters in length.
  • The name must start with a letter and cannot start with http:// or https://.
  • The name can contain letters, digits, colons (:), underscores (_), and hyphens (-).

Before you delete a key pair, you can call the DescribeKeyPairs operation to query existing key pairs.

TestKeyPairName
KeyPairIdstringNo

The ID of the SSH key pair.

ssh-5lywanlkih1zo9yl8eg****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Sample success responses

JSONformat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\t"
}

Error codes

HTTP status codeError codeError messageDescription
400MissingParameterThe input parameter that is mandatory for processing this request is not supplied.-
400NoPermissionPermission denied.-
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-
400InvalidParameterThe errorMessage is %s. Please check it again.-
400ens.interface.errorAn error occurred while calling the API.-
400PubKeyNameExistedPublic Key Pair Name Existed.Key pair name already exists
400PubKeyAttachedWithInstancePublic Key Attached With Instance.Key already bound to instance
400InvalidPubKeyBodyInvalid Public Key Body.Illegal key
400PubKeyNameNotExistPublic Key Pair Name Not Exist.Key pair name does not exist
400CallInterfaceCall Interface Happen Error.An error occurred when you call the operation.

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

Change history

Change timeSummary of changesOperation
2024-01-22The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: KeyPairId
2023-12-21API Description Update. The Error code has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    Error Codes 400 change
2023-10-17The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
Input ParametersThe request parameters of the API has changed.
    delete Input Parameters: Version