All Products
Search
Document Center

ENS:ImportKeyPair

Last Updated:Oct 14, 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

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
ens:ImportKeyPaircreate
  • All Resources
    *
    none
none

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.
400InvalidPublicKeyBody.MalformedThe PublicKeyBody format is not supported.The PublicKeyBody format is not supported.

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

Change history

Change timeSummary of changesOperation
2024-06-27API Description Update. The Error code has changedView Change Details
2023-12-21The Error code has changed. The request parameters of the API has changedView Change Details