CreateKeyPair - ENS - Alibaba Cloud Documentation Center

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
ens:CreateKeyPair	create	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
KeyPairName	string	Yes	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

Parameter	Type	Description	Example
	object
KeyPairFingerPrint	string	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****
KeyPairId	string	The ID of the SSH key pair.	ssh-5lywanlkih1zo9yl8eg****
KeyPairName	string	The name of the key pair.	TestKeyPairName
PrivateKeyBody	string	The private key of the key pair. The private key is encoded with PEM in the PKCS#8 format.	-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQE****
RequestId	string	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 code	Error code	Error message	Description
400	MissingParameter	The input parameter that is mandatory for processing this request is not supplied.	-
400	NoPermission	Permission denied.	-
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.	-
400	InvalidParameter	The errorMessage is %s. Please check it again.	-
400	InvalidSecurityGroupId.NotFound	The specified SecurityGroupId does not exist.	-
400	SecurityGroupRuleConflict.Duplicated	The SecurityGroup rule already exists.	-
400	AuthorizationLimitExceed	The limit of authorization records in the security group reaches.	-
400	ens.interface.error	An error occurred while calling the API.	-
400	CallInterface	Call 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 time	Summary of changes	Operation
2023-12-21	API Description Update. The Error code has changed. The request parameters of the API has changed	View Change Details