Domain name for API request: cvm.tencentcloudapi.com.
This API is used to modify attributes of a key pair.
Modify the name and description information of the key pair specified by the key pair ID.
The key pair name should not be the same as the name of an existing key pair.
The key pair ID is the unique identifier of a key pair and cannot be modified.
Either the key pair name or description information should be specified, and both can also be specified simultaneously.
A maximum of 10 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: ModifyKeyPairAttribute. |
Version | Yes | String | Common Params. The value used for this API: 2017-03-12. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
KeyId | Yes | String | Key pair ID in the format of skey-xxxxxxxx . You can obtain the available key pair IDs in two ways: KeyId in the response. |
KeyName | No | String | New key pair name, which can contain numbers, letters, and underscores, with a maximum length of 25 characters. |
Description | No | String | New key pair description. You can specify any name you like, but its length cannot exceed 60 characters. |
Parameter Name | Type | Description |
---|---|---|
RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to modify the key pair name.
GET https://cvm.tencentcloudapi.com/?Action=ModifyKeyPairAttribute
&KeyId=skey-mv9yzyjj
&KeyName=Tencent
&<Common request parameters>
{
"Response": {
"RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
}
}
This example shows you how to modify the key pair description.
GET https://cvm.tencentcloudapi.com/?Action=ModifyKeyPairAttribute
&KeyId=skey-mv9yzyjj
&Description=Tencent
&<Common request parameters>
{
"Response": {
"RequestId": "aea2227b-fbb7-4cc7-bf29-d49b2b6db97c"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
InternalServerError | Internal error. |
InvalidKeyPairId.Malformed | Invalid key pair ID. The specified key pair ID has an invalid format. For example, skey-1122 has an invalid ID length. |
InvalidKeyPairId.NotFound | Invalid key pair ID. The specified key pair ID does not exist. |
InvalidKeyPairName.Duplicate | Key pair name already exists. |
InvalidParameter | A parameter error occurred. |
InvalidParameterValue | Incorrect parameter value. |
MissingParameter | Missing parameter. |
Was this page helpful?