tencent cloud

API Gateway

Release Notes and Announcements
Release Notes
Announcements
Product Introduction
Overview
Strengths
Features
Use Limits
Use Cases
Regions and Availability Zones
Migrating from Region A to Region B
FAQs
Billing
Console
TKE
504 Error Solution
HTTP Error Codes
Service Level Agreement
Contact Us
ドキュメントAPI Gateway

DeleteApiKey

フォーカスモード
フォントサイズ
最終更新日: 2025-10-30 21:27:32

1. API Description

Domain name for API request: apigateway.intl.tencentcloudapi.com.

This API is used to delete an API key pair.

A maximum of 20 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: DeleteApiKey.
Version Yes String Common Params. The value used for this API: 2018-08-08.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
AccessKeyId Yes String ID of the key to be deleted.

3. Output Parameters

Parameter Name Type Description
Result Boolean Whether deletion succeeded.
Note: this field may return null, indicating that no valid values can be obtained.
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 DeleteApiKey

Input Example

https://apigateway.intl.tencentcloudapi.com/?Action=DeleteApiKey
&AccessKeyId=AKID***********************************************
&<Common request parameters>

Output Example

{
    "Response": {
        "Result": true,
        "RequestId": "7bc61f00-1cb0-4436-9f7e-55c3e2652248"
    }
}

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
InvalidParameterValue.InvalidRegion Incorrect region.
ResourceNotFound.InvalidAccessKeyId The key does not exist.
UnsupportedOperation.InvalidStatus The current key status does not support this operation.
UnsupportedOperation.ResourceIsInUse The key has already been bound to a usage plan. Please unbind it and try again.
次の記事へ: Release Notes

ヘルプとサポート

この記事はお役に立ちましたか？

フィードバック