All Products
Search

This Product

    ENS:CreateKeyPair

    Document Center

    ENS:CreateKeyPair

    Last Updated:Apr 16, 2024

    Creates an SSH key pair.

    Operation description

    An SSH key pair consists of a public key and a private key. ENS stores the public key and returns the unencrypted private key that is PEM-encoded in the PKCS#8 format. You must securely lock away the private key.

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

    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. For more information, see RFC 4716.

    		7880c1ad4687fdbf7a6da2131****
    KeyPairIdstring

    The ID of the SSH key pair.

    		ssh-5lywanlkih1zo9yl8eg****
    KeyPairNamestring

    The name of the key pair.

    		TestKeyPairName
    PrivateKeyBodystring

    The private key of the key pair. The private key is encoded with PEM in the PKCS#8 format.

    		-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQE****
    RequestIdstring

    The ID of the request.

    		473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

    Examples

    Sample success responses

    JSONformat

    {
  "KeyPairFingerPrint": "7880c1ad4687fdbf7a6da2131****",
  "KeyPairId": "ssh-5lywanlkih1zo9yl8eg****",
  "KeyPairName": "TestKeyPairName",
  "PrivateKeyBody": "-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQE****",
  "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-21API Description Update. The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    API DescriptionAPI Description Update.
    Error CodesThe Error code has changed.
      Error Codes 400 change
    Input ParametersThe request parameters of the API has changed.
      delete Input Parameters: Version