CreateKeyPair - Simple Application Server - Alibaba Cloud Documentation Center

Operation description

An Alibaba Cloud Secure Shell (SSH) key pair is a secure and convenient authentication method that uses a public key and a private key for identity verification and encrypted communication over the SSH protocol. SSH key pairs are supported only on Linux instances and provide enhanced security and convenience.

Key pair logon is supported only for Simple Application Server instances that run Linux.
An Alibaba Cloud account can have a maximum of 10 key pairs in a region.
The console supports only the creation of 2048-bit RSA key pairs.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

swas-open:CreateKeyPair

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the Simple Application Server instance. Call ListRegions to view the list of supported Alibaba Cloud regions.	cn-hangzhou
ClientToken	string	No	A client token to ensure the idempotence of the request. Generate a unique value from your client for this parameter. The token can contain only ASCII characters and must be no more than 64 characters in length. For more information, see How to ensure idempotence.	123e4567-e89b-12d3-a456-426655440000
KeyPairName	string	Yes	The name of the key pair. The name must be 2 to 64 characters in length. It must start with a letter or a Chinese character and cannot start with http:// or https://. The name can contain digits, colons (:), underscores (_), and hyphens (-).	KeyPairName

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	20758A-585D-4A41-A9B2-28DA8F4F****
KeyPairName	string	The name of the key pair. The name must be 2 to 64 characters in length. It must start with a letter or a Chinese character and cannot start with http:// or https://. The name can contain digits, colons (:), underscores (_), and hyphens (-).	KeyPairName
PrivateKeyBody	string	The private key of the key pair. The private key is PEM-encoded in the PKCS#8 format.	MIIEpAIBAAKCAQEAtReyMzLIcBH78EV2zj****

Examples

Success response

JSON format

{
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F****",
  "KeyPairName": "KeyPairName",
  "PrivateKeyBody": "MIIEpAIBAAKCAQEAtReyMzLIcBH78EV2zj****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	KeyPairNameAlreadyExist	The keyPair name already exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.