tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DeleteKeyPairs

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

    1. API Description

    Domain name for API request: cvm.tencentcloudapi.com.

    This API is used to delete the key pairs hosted in Tencent Cloud.

    • You can delete multiple key pairs at the same time.
    • A key pair used by an instance or image cannot be deleted. Therefore, you need to verify whether all the key pairs have been deleted successfully.

    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: DeleteKeyPairs.
    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.
    KeyIds.N Yes Array of String One or more key pair IDs to be operated. The maximum number of key pairs per request is 100.
    You can obtain an available key pair ID in the following ways:
  • Log in to the console to query the key pair ID.

  • Call the DescribeKeyPairs API and obtain the key pair ID from the KeyId in the response.
    		•

    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 Deleting a key pair

    Input Example

    GET https://cvm.tencentcloudapi.com/?Action=DeleteKeyPairs
&KeyIds.0=skey-mv9yzyjj
&<Common request parameters>

    Output Example

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

    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.
    InvalidKeyPair.LimitExceeded The number of key pairs exceeds the limit.
    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.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.KeyPairNotSupported The specified key does not support the operation.
    InvalidParameterValue.LimitExceeded The number of parameter values exceeds the limit.
    MissingParameter Missing parameter.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy