tencent cloud

Feedback

DeleteKeyPairs

Last updated: 2022-09-26 17:00:17

1. API Description

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

This API is used to delete a key pair.

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: 2020-03-24.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
KeyIds.N Yes Array of String Key pair ID list. Each request can contain up to 10 key pairs.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Deleting key pair

Input Example

https://lighthouse.tencentcloudapi.com/?Action=DeleteKeyPairs
&KeyIds.0=lhkp-1234abcd
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "3cc773c5-f5fe-49f2-8eb0-f6304f5ee39c"
    }
}

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
FailedOperation.DeleteKeyPairFailed Failed to delete the key pair.
InvalidParameterValue.Duplicated Invalid parameter value: duplicate values are not allowed.
InvalidParameterValue.KeyPairIdMalformed Invalid parametric value: the key pair ID format is invalid.
ResourceInUse.KeyPairInUse The key pair is in use.
ResourceNotFound.KeyIdNotFound The key pair ID does not exist.
UnsupportedOperation.KeyPairBindToBlueprints Unsupported operation: the KeyPair has a binding relationship with the image. Before performing this operation, please delete the custom image bound to the key pair.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support