Call the CreateKeyPair operation to create a key pair.

Usage notes

After the key pair is successfully created, the system stores the public key of the key pair for you, and the private key file is automatically downloaded to your local device. The default file name is KeyName.pem. You have only one opportunity to download the private key. VolcanoEngine does not store your private key. Make sure that you keep your private key safe. Learn more.

You can create up to 500 key pairs in the same region.

Debugging

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

The table below lists only the request parameters specific to this operation and some common parameters. For more information, please refer to Common parameters.

Action string required Sample value: CreateKeyPair

The action that you want to perform. Value: CreateKeyPair.

Version string required Sample value: 2020-04-01

The version of the API. Valid value: 2020-04-01.

ClientToken string Optional Sample value: 333456899ff****

The ClientToken is used to ensure the request idempotency. You can use the client to automatically generate a token, but you must make sure that the token is unique among different requests. This prevents repeated actions due to multiple client retries when the call of the API action times out or an internal server error occurs.

Value: Only ASCII characters are supported. The length is no more than 64 ASCII characters.

Description string Optional Sample value: ssh_key_pair description

The description of the key pair. Default value: empty string.

It must start with a letter or Chinese character.

Only Chinese characters, letters, numbers, dots (.), spaces, underscores (_), hyphen (-), equal signs (=), English comma (,), Chinese comma (，), and Chinese period (。) are allowed.

The length is limited to 255 characters.

KeyPairName string required Sample value: ssh_key_pair

The name of the key pair.

The name must be unique.

It must be 2 to 64 characters in length.

Periods "." are allowed to separate the string into multiple segments, and each segment can contain uppercase or lowercase letters, digits, or hyphens "-".

Cannot start or end with "-" or ".". Hyphens and periods cannot be used consecutively.

ProjectName string Optional Sample value: project_a

The project to which the resource belongs. A resource can only belong to one project.

Only letters, digits, underscores (_), hyphens (-), and dots (.) are allowed.

The length is limited to 64 characters.

Tags.N.Key string[] required Sample value: Tags.1.Key=k1&Tags.2.Key=k2

The tag key of the user tag.

Argument - N: specifies the serial number of the tag key. Valid range: 1–20.

Separate multiple tag keys with ampersands (&).

Naming rules:

It cannot start with volc: or sys: in any case form.

Only language characters, digits, spaces, and English symbols of "_", ".", ":", "/", "=", "+", "-", and "@" are allowed.

It must be 1 to 128 characters in length.

tip

Keys of the same resource must be unique.

Tags.N.Value string[] Optional Sample value: Tags.1.Value=v1&Tags.2.Value=v2

The tag value of the user tag.

Argument - N: specifies the serial number of the tag value. Valid range: 1–20.

Separate multiple key values with ampersands (&).

Naming rules:

Only language characters, digits, spaces, and English symbols of " _", ".", ":", "/", "=", "+", "-", and "@" are allowed.

It must be 0 to 256 characters in length.

tip

To pass in this parameter, pass in Tags.N.Key first.

Response parameters

The table below lists only the response parameters specific to this operation. For more information, refer to response structure.

FingerPrint string Sample value: kp-ybqcopwrdwl8j1******

This parameter is generated based on the MD5 message-digest algorithm in the RFC4716-defined format for public key fingerprints.

KeyPairId string Sample value: 4158f40dbc0814eb04f0dcac4e******

The unique ID of the key pair.

KeyPairName string Sample value: ssh_key_pair

The name of the key pair.

PrivateKey string Sample value: "-----BEGIN RSA PRIVATE KEY-----MIIEogIBAAKCAQEAw7ked3y+qiEoWcGqJB8eK5U+NEzopTrx5zyC4l2QbVc9NFh1x5DQGs5YFvum3EOExdv1RZP1b/+vT4CWaHE7yw8dfYU6WZK/CFFVAsn1855RhPgT******"

The private key information of the key pair.

Sample request

Sample response

Error codes

The table below lists the business-related error codes of the operation. For more information, refer to Common error codes.

Status code	Error code	Error message	Description
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.	The idempotent parameters are inconsistent.
400	InvalidClientToken.Malformed	The specified ClientToken is malformed.	The specified ClientToken is invalid.
400	InvalidKeyPairDescription.Malformed	The specified KeyPairDescription is malformed.	The description of the specified key pair is invalid.
400	InvalidKeyPairName.Malformed	The specified KeyPairName is malformed.	The specified key pair name is invalid.
400	InvalidTagKey.Malformed	The specified TagKey is malformed.	The specified tag key is invalid.
400	InvalidTagValue.Malformed	The specified TagValue is malformed.	The specified tag value is invalid.
400	LimitExceeded.MaximumKeyPairs	You've reached the limit on the number of KeyPairs that you can create.	The number of key pairs that you create exceeds the upper limit.
400	LimitExceeded.MaximumTags	You've reached the limit on the number of tags that you can create.	The specified tag number exceeds the maximum limit.
400	MissingParameter.KeyPairName	The required parameter KeyPairName is not supplied.	The key pair name cannot be empty.
404	InvalidProject.NotFound	The specified Project does not exist.	The specified project does not exist.
409	InvalidKeyPairName.Conflict	The specified KeyPairName already exists.	The specified key pair name is not unique.
409	InvalidTagKey.Conflict	The specified TagKey already exists.	The specified tag key already exists.
412	IdempotentProcessing	The request uses the same client token as a previous one that is still in process.	The previous idempotent request is still being processed. Please try again later.
412	OperationDenied.ResourceLocked	The specified operation is denied as your resource is locked for another operation.	The specified action was rejected because your resource has been locked by other actions.
500	InternalError	An internal error has occurred.	An internal error occurred. Try again. If multiple attempts fail, submit a ticket.

Elastic Compute Service