Call ModifyKeyPairAttribute to modify the description of a key pair.

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

Only the request parameters specific to this operation and some common parameters are listed below. For more information, refer to Common parameters.

Action string required Sample value: ModifyKeyPairAttribute

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

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 required Sample value: ssh_key_pair aaa

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

It must start with a letter or a 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.

When an empty string is passed in, the existing description is cleared.

KeyPairId string Optional Sample value: kp-ybqcopwrdwl8j1******

The unique ID of the key pair. You can call the DescribeKeyPairs interface to query and obtain key pair information.

The KeyPairName and KeyPairId parameters cannot both be empty.

If the KeyPairName and KeyPairId parameters are configured at the same time, KeyPairId takes precedence.

KeyPairName string Optional Sample value: ssh_key_pair

The name of the key pair.

The KeyPairName and KeyPairId parameters cannot both be empty.

If the KeyPairName and KeyPairId parameters are configured at the same time, KeyPairId takes precedence.

Response parameters

Only the response parameters specific to this operation are listed below. For more information, refer to the response structure.

KeyPairName string Sample value: ssh_key_pair

The name 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	MissingParameter.Description	The required parameter Description is not supplied.	The specified value for parameter Description cannot be empty.
400	InvalidKeyPairDescription.Malformed	The specified KeyPairDescription is malformed.	The specified description of the key pair is invalid.
400	InvalidClientToken.Malformed	The specified ClientToken is malformed.	The specified ClientToken is invalid.
400	MissingParameter.KeyPairNameAndKeyPairId	The required parameters KeyPairName and KeyPairId are not supplied.	The key pair name and ID cannot be both empty.
404	InvalidKeyPair.NotFound	The specified KeyPair does not exist.	The specified key pair does not exist.
412	IdempotentProcessing	The request uses the same client token as a previous one that is still in process.	The previous idempotent request is still in process. Please try again later.
500	InternalError	An internal error has occurred.	An internal error occurred. Please try again. If multiple attempts fail, submit a ticket.

Elastic Compute Service