Domain name for API request: gaap.tencentcloudapi.com.
This API (ModifyRuleAttribute) is used to modify forwarding rule information, including health check configuration and forwarding policies.
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 parameter. The value used for this API: ModifyRuleAttribute. |
| Version | Yes | String | Common parameter. The value used for this API: 2018-05-29. |
| Region | No | String | Common parameter. This parameter is not required for this API. |
| ListenerId | Yes | String | Listener ID |
| RuleId | Yes | String | Forwarding rule ID |
| Scheduler | No | String | Scheduling policy: rr: round robin; wrr: weighted round robin; lc: least connections. |
| HealthCheck | No | Integer | Whether to enable the origin server health check: 1: enable; 0: disable. |
| CheckParams | No | RuleCheckParams | Health check configuration parameters |
| Path | No | String | Forwarding rule path |
| ForwardProtocol | No | String | Protocol types of the forwarding from acceleration connection to origin server, which supports default, HTTP and HTTPS. If ForwardProtocol=default, the ForwardProtocol of the listener will be used. |
| ForwardHost | No | String | The host carried in the request forwarded from the acceleration connection to the origin server.If ForwardHost=default, the domain name of rule will be used. For other cases, the value set in this field will be used. |
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
Modify the forwarding rule information.
https://gaap.tencentcloudapi.com/?Action=ModifyRuleAttribute
&RuleId=rule-5g8dh58
&ListenerId=listener-8fueuc9
&Path=/
&Scheduler=rr
&HealthCheck=0
&CheckParam=null
&<Common request parameters>{
"Response": {
"RequestId": "c7bfcad5-3f20-472f-9afc-13a66faebad8"
}
}This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.
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 |
|---|---|
| FailedOperation | Operation failed. |
| FailedOperation.InstanceStatusNotInRuning | Unable to operate: the connection is not running. |
| FailedOperation.ListenerHasTask | The listener is in operation. Do not repeat the operation. |
| FailedOperation.RuleAlreadyExisted | Rule already exists. |
| InternalError | Internal error. |
| InvalidParameter | Incorrect parameter. |
| InvalidParameterValue | Incorrect parameter value. |
| MissingParameter | Missing parameter. |
| UnauthorizedOperation | Unauthorized operation. |
Was this page helpful?