Domain name for API request: apigateway.tencentcloudapi.com.
This API is used to disable an API key.
A maximum of 20 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: DisableApiKey. |
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 disabled. |
Parameter Name | Type | Description |
---|---|---|
Result | Boolean | Whether the key is successfully disabled. 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. |
https://apigateway.tencentcloudapi.com/?Action=DisableApiKey
&AccessKeyId=AKID8my5MRr9i6VM98F3dZG9zV0KuBq5ID7pMG83
&<Common request parameters>
{
"Response": {
"Result": true,
"RequestId": "6ea68436-c37c-4887-9a2b-91ed0eb72f7a"
}
}
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 |
---|---|
InternalError.OssException | OSS internal request error. Please try again. If the problem persists, please contact the smart customer service or submit a ticket. |
ResourceNotFound.InvalidAccessKeyId | The key does not exist. |
UnsupportedOperation.UinNotInWhiteList | The current Uin is not in the manual key allowlist. |
UnsupportedOperation.UnsupportedUpdateApiKey | The current key status does not support this operation. |
Was this page helpful?