Call the ImportKeyPair API to import a public key - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Operation description

Description

When you call this operation, take note of the following items:

You can have a maximum of 500 key pairs in each region.
The imported key pair must support one of the following encryption methods:
- rsa
- dsa
- ssh-rsa
- ssh-dss
- ecdsa

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

ecs:ImportKeyPair

create

*KeyPair

acs:ecs:{#regionId}:{#accountId}:keypair/*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call DescribeRegions to query the most recent region list.	cn-hangzhou
KeyPairName	string	Yes	The name of the key pair. The name must be unique. The name must be 2 to 128 characters in length and must start with a letter or Chinese character. It cannot start with http:// or https://. The name can contain characters that are categorized as letter in Unicode, including letters, Chinese characters, and digits. The name can contain colons (:), underscores (_), periods (.), or hyphens (-).	testKeyPairName
PublicKeyBody	string	Yes	The public key of the key pair.	ABC1234567
ResourceGroupId	string	No	The ID of the enterprise resource group to which the SSH key pair belongs.	rg-bp67acfmxazb4p****
Tag	array<object>	No	The tags.
	object	No	The tags.
Key	string	No	The key of tag N of the key pair. Valid values of N: 1 to 20. The tag key cannot be an empty string. The tag key can be up to 128 characters in length. It cannot start with aliyun or acs: and cannot contain http:// or https://.	TestKey
Value	string	No	The value of tag N of the key pair. Valid values of N: 1 to 20. The tag value can be an empty string. The tag value can be up to 128 characters in length. It cannot contain http:// or https://.	TestValue

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
KeyPairName	string	The name of the key pair.	testKeyPairName
KeyPairFingerPrint	string	The fingerprint of the key pair. The public key fingerprint format is defined in RFC 4716 and uses the MD5 message digest algorithm.	89:f0:ba:62:ac:b8:aa:e1:61:5e:fd:81:69:86:6d:6b:f0:c0:5a:**

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "KeyPairName": "testKeyPairName",
  "KeyPairFingerPrint": "89:f0:ba:62:ac:b8:aa:e1:61:5e:fd:81:69:86:6d:6b:f0:c0:5a:**"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidKeyPairName.Malformed	Specified Key Pair name is not valid.
400	InvalidPublicKeyBody.Malformed	The PublicKeyBody format is not supported.	The public key format is not supported.
400	MissingParameter	The input parameter "PublicKeyBody" that is mandatory for processing this request is not supplied.
400	KeyPair.AlreadyExist	The key pair already exist.	A key pair with the same name already exists. Key pair names must be unique.
500	InternalError	The request processing has failed due to some unknown error.
403	QuotaExceed.KeyPair	The key pair quota exceeds.
404	InvalidResourceGroup.NotFound	The ResourceGroup provided does not exist in our records.	The specified resource group does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.