tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyKeyPairAttribute

Last updated: 2024-10-22 19:32:43

    1. API Description

    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.

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    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:
  • Log in to the console to query the key pair IDs.
  • Call DescribeKeyPairs and look for 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.

    3. Output Parameters

    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.

    4. Example

    Example1 Modifying the key pair name

    This example shows you how to modify the key pair name.

    Input Example

    GET https://cvm.tencentcloudapi.com/?Action=ModifyKeyPairAttribute
&KeyId=skey-mv9yzyjj
&KeyName=Tencent
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
    }
}

    Example2 Modifying the key pair description

    This example shows you how to modify the key pair description.

    Input Example

    GET https://cvm.tencentcloudapi.com/?Action=ModifyKeyPairAttribute
&KeyId=skey-mv9yzyjj
&Description=Tencent
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "aea2227b-fbb7-4cc7-bf29-d49b2b6db97c"
    }
}

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    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.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy