All Products
Search
Document Center

ENS:ImportKeyPair

Last Updated:Mar 12, 2024

Imports the public key of a Rivest–Shamir–Adleman (RSA)-encrypted key pair that is generated by a third-party tool.

Operation description

  • After the key pair is imported, ENS stores the public key. You must securely store the private key.
  • The key pair can be only in the ssh-rsa format.

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
KeyPairNamestringYes

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 but cannot start with http:// or https://.
  • The name can contain letters, digits, colons (:), underscores (_), and hyphens (-).

You can specify the name of only one key pair.

TestKeyPairName
PublicKeyBodystringYes

The public key of the key pair. You can specify only one public key.

ssh-rsa AAAAB****

Response parameters

ParameterTypeDescriptionExample
object
KeyPairFingerPrintstring

The fingerprint of the key pair. The message-digest algorithm 5 (MD5) is used based on the public key fingerprint format defined in RFC 4716.

fdaf8ff7a756ef843814fc****
KeyPairNamestring

The name of the key pair.

TestKeyPairName
RequestIdstring

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Sample success responses

JSONformat

{
  "KeyPairFingerPrint": "fdaf8ff7a756ef843814fc****",
  "KeyPairName": "TestKeyPairName",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

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.-
400InvalidSecurityGroupId.NotFoundThe specified SecurityGroupId does not exist.-
400SecurityGroupRuleConflict.DuplicatedThe SecurityGroup rule already exists.-
400AuthorizationLimitExceedThe limit of authorization records in the security group reaches.-
400ens.interface.errorAn error occurred while calling the API.-
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
2023-12-21The 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