Domain name for API request: ga2.intl.tencentcloudapi.com.
This API is used to modify a Layer 7 forwarding rule.
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: ModifyForwardingRule. |
| Version | Yes | String | Common Params. The value used for this API: 2025-01-15. |
| Region | No | String | Common Params. This parameter is not required. |
| GlobalAcceleratorId | Yes | String | Global acceleration instance ID. |
| ListenerId | Yes | String | Listener ID. |
| ForwardingPolicyId | Yes | String | Policy ID. |
| ForwardingRuleId | Yes | String | Layer 7 forwarding rule ID. |
| RuleConditions.N | No | Array of RuleCondition | Conditional information of Layer 7 forwarding rules. Input parameter limit: The array length cannot exceed 1. |
| RuleActions.N | No | Array of RuleAction | Layer 7 forwarding rule behavior information. Input parameter limit: array length cannot exceed 1. |
| OriginHeaders.N | No | Array of OriginHeader | Origin-pull Header information. Input limitation: The length of the array is between 1 and 5. |
| EnableOriginSni | No | Boolean | Whether to enable origin-pull sni. |
| OriginSni | No | String | Origin sni. Input parameter limit: length cannot exceed 80. This field is required when origin sni is enabled. |
| OriginHost | No | String | Origin-pull host. Input parameter limit: length cannot exceed 80. This field is required when origin-pull sni is enabled. |
| ResponseHeaders.N | No | Array of ResponseHeaders | Origin server response headers Input limitation: The array length cannot exceed 5. |
| HideResponseHeaders.N | No | Array of HideResponseHeaders | Delete origin response headers Input parameter limit: array length cannot exceed 5. |
| Parameter Name | Type | Description |
|---|---|---|
| TaskId | String | Asynchronous task ID. |
| 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. |
POST / HTTP/1.1
Host: ga2.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyForwardingRule
<Common request parameters>
{
"GlobalAcceleratorId": "ga-80bzejka",
"ListenerId": "lsr-nd3qmz7h",
"ForwardingPolicyId": "dm-kzk3neks",
"ForwardingRuleId": "rule-5lybgwaw",
"RuleConditions": [
{
"RuleConditionType": "Path",
"RuleConditionValue": [
"\\cc"
]
}
]
}{
"Response": {
"RequestId": "e6437f6a-18e9-4a61-895b-28d5083297f4",
"TaskId": "2347cd92-de71-40d9-a6b4-eeee09a14513"
}
}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 |
|---|---|
| InvalidParameter.InputRepeat | The input parameter %(key)s in the request has duplicate values. |
| InvalidParameterValue.AsciiCharacters | Can only be printable ASCII characters. |
| InvalidParameterValue.Empty | Parameter %(parameter)s cannot be empty. |
| InvalidParameterValue.ForwardingRulePathConflict | The Path of the Layer 7 forwarding rule duplicates an existing one. |
| InvalidParameterValue.InstanceMismatch | The instance object %(value)s has a mismatched relationship. |
| InvalidParameterValue.InternalReservedFields | |
| InvalidParameterValue.Malformed | Parameter value %(value)s of %(parameter)s is invalid. A correct and complete value is in the form of %(template)s. |
| InvalidParameterValue.SpecialCharacters | Parameter value %(value)s cannot contain special characters %(key)s. |
| InvalidParameterValue.TooLong | Parameter value %(value)s length cannot be greater than %(max_size)s. |
| LimitExceeded | The quota limit is exceeded. |
| MissingParameter | Parameters are missing. |
| ResourceNotFound | The resource does not exist. |
| UnsupportedOperation.DefaultForwardingRuleOperate | The default Layer 7 forwarding rule is not allowed to be modified: %(value)s. |
| UnsupportedOperation.ForwardGroupForwardingRuleUnsupportedDefaultEndpointGroup | Forwarding rules cannot be configured with a default terminal node group. |
| UnsupportedOperation.InstanceNotRunning | The instance is not in the running state. The current operation is not supported. |
| UnsupportedOperation.TransportLayerUnsupportedOperateForwardingPolicy | Layer-4 listeners do not support creation of forwarding policies. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback