Domain name for API request: gaap.tencentcloudapi.com.
This API is used to create a custom header of the HTTP/HTTPS listener. When client requests reach the listener, they will be forwarded to the origin with this custom hearer.
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: CreateCustomHeader. |
Version | Yes | String | Common Params. The value used for this API: 2018-05-29. |
Region | No | String | Common Params. This parameter is not required. |
RuleId | Yes | String | Rule ID |
Headers.N | No | Array of HttpHeaderParam | Custom header name and content list. ‘’$remote_addr‘’ will be resolved and replaced with the client IP. Other values will be directly passed to the origin server. |
Parameter Name | Type | Description |
---|---|---|
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: gaap.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCustomHeader
<Common request parameters>
{
"RuleId": "rule-18vhg67",
"Headers": [
{
"HeaderName": "X-REAL_IP",
"HeaderValue": "$remote_addr"
},
{
"HeaderName": "X-FORWORD-IP",
"HeaderValue": "192.168.2.101"
}
]
}
{
"Response": {
"RequestId": "c7bfcad5-3f20-472f-9afc-13a66faebad8"
}
}
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 |
---|---|
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.GroupStatusNotInRuning | Unable to operate: the connection group is not running. |
FailedOperation.InstanceStatusNotInRuning | Unable to operate: the connection is not running. |
FailedOperation.InvalidListenerProtocol | Invalid listener protocol. |
FailedOperation.ListenerHasTask | The listener is in operation. Do not repeat the operation. |
FailedOperation.NonStandardProxy | This connection is non-standard and write operations are not allowed. |
FailedOperation.UserNotConfirmProtocol | Protocol not activated. |
InternalError | Internal error. |
InvalidParameter | Incorrect parameter. |
InvalidParameterValue | Incorrect parameter value. |
InvalidParameterValue.HitBlacklist | The header is blocklisted. |
LimitExceeded | The quota limit should not be exceeded. |
ResourceNotFound | The resource does not exist. |
ResourceUnavailable.AccountViolation | Restricted resources found in your account. Check your inbox and email for details. |
Was this page helpful?