Use DeleteKeyPairs to delete SSH key pairs - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Operation description

After you delete an SSH key pair, take note of the following items:

You cannot query the SSH key pair by calling DescribeKeyPairs.
If an ECS instance is bound to the SSH key pair, the SSH key pair cannot be deleted.

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:DeleteKeyPairs

delete

*KeyPair

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region where the SSH key pairs reside. You can call DescribeRegions to query the most recent region list.	cn-hangzhou
KeyPairNames	string	Yes	The names of SSH key pairs. The value can be a JSON array that consists of up to 100 SSH key pair names. Separate multiple names with commas (,). Note Before you delete SSH key pairs, you can call DescribeKeyPairs to query existing key pairs.	["TestKeyPairName-1", "TestKeyPairName-2", … "TestKeyPairName-100"]

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter	The input parameter "KeyPairNames" that is mandatory for processing this request is not supplied.
400	InvalidKeyPairNames.ValueNotSupported	The specified parameter "KeyPairNames" is not valid.
400	InvalidParameter.KeypairAlreadyAttachedInstance	The specified parameter "KeyPairNames" attached to instances can not be deleted.
403	InstanceKeyPairLimitExceeded	Exceeding the allowed amount of instance which will be deleted.	The number of specified key pairs exceeds the upper limit.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.