1. API Description
Domain name for API request: gaap.intl.tencentcloudapi.com.
This API is used to query names of blocked custom headers.
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.
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: DescribeBlackHeader. |
| Version |
Yes |
String |
Common Params. The value used for this API: 2018-05-29. |
| Region |
No |
String |
Common Params. This parameter is not required. |
3. Output Parameters
| Parameter Name |
Type |
Description |
| BlackHeaders |
Array of String |
List of blocked custom headers Note: this field may return null, indicating that no valid values can be obtained. |
| RequestId |
String |
The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
POST / HTTP/1.1
Host: gaap.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBlackHeader
<Common request parameters>
{}
Output Example
{
"Response": {
"RequestId": "c7bfcad5-3f20-472f-9afc-13a66faebad8",
"BlackHeaders": [
"X-Forward-For",
"allow"
]
}
}
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 |
| AuthFailure |
CAM signature/authentication error. |
| AuthFailure.NotEnterpriseAuthorization |
Not an organizational customer. |
| AuthFailure.UnauthorizedOperation |
The sub-account is not authorized for this operation. |
| FailedOperation |
Operation failed. |
| FailedOperation.UserNotConfirmProtocol |
Protocol not activated. |
| InternalError |
Internal error. |
| InvalidParameter |
Incorrect parameter. |
| InvalidParameterValue |
Incorrect parameter value. |
| MissingParameter |
Missing parameter. |
| ResourceUnavailable |
The resource is unavailable. |
| ResourceUnavailable.AccountViolation |
Restricted resources found in your account. Check your inbox and email for details. |
| UnknownParameter |
Unknown parameter. |