Domain name for API request: clb.tencentcloudapi.com.
This API (ModifyRule) is used to modify the attributes of a forwarding rule under a layer-7 CLB listener, such as forwarding path, health check attribute, and forwarding policy.
This is an async API. After it is returned successfully, you can call the DescribeTaskStatus API with the returned RequestID as an input parameter to check whether this task is successful.
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: ModifyRule. |
Version | Yes | String | Common Params. The value used for this API: 2018-03-17. |
Region | No | String | Common Params. This parameter is not required for this API. |
LoadBalancerId | Yes | String | CLB instance ID |
ListenerId | Yes | String | CLB listener ID |
LocationId | Yes | String | ID of the forwarding rule to be modified. |
Url | No | String | New forwarding path of the forwarding rule. This parameter is not required if the URL does not need to be modified. |
HealthCheck | No | HealthCheck | Health check information |
Scheduler | No | String | Request forwarding method of the rule. Value range: WRR, LEAST_CONN, IP_HASH They represent weighted round robin, least connections, and IP hash, respectively. Default value: WRR. |
SessionExpireTime | No | Integer | Session persistence duration, in seconds. Value range: 0 or 30-86400. |
ForwardType | No | String | Forwarding protocol between a CLB instance and the real server. Default value: HTTP. Valid values: HTTP, HTTPS, GRPC. This parameter is valid only for HTTPS listeners. |
TrpcCallee | No | String | TRPC callee server route, which is required when ForwardType is "TRPC". This is now only for internal usage. |
TrpcFunc | No | String | TRPC calling service API, which is required when ForwardType is "TRPC". This is now only for internal usage. |
OAuth | No | OAuth | OAuth configuration information. |
Parameter Name | Type | Description |
---|---|---|
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. |
Modifies the health check parameter and forwarding policy of a forwarding rule
https://clb.tencentcloudapi.com/?Action=ModifyRule
&LoadBalancerId=lb-cuxw2rm0
&ListenerId=lbl-4fbxq45k
&LocationId=loc-9dr7bsl3
&Url=/bar
&Scheduler=LEAST_CONN
&SessionExpireTime=75
&HealthCheck.HealthSwitch=1
&HealthCheck.IntervalTime=50
&HealthCheck.HealthNum=3
&HealthCheck.UnHealthNum=3
&HealthCheck.HttpCode=7
&HealthCheck.HttpCheckPath=/check
&HealthCheck.HttpCheckDomain=foo.net
&HealthCheck.HttpCheckMethod=GET
&<Common request parameters>
{
"Response": {
"RequestId": "6d846dfd-27f3-4d74-bc00-ec9ae0570cb0"
}
}
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.ResourceInOperating | The specified resource is currently being operated. Please try again later. |
InternalError | Internal error. |
InvalidParameter | Parameter error. |
InvalidParameter.FormatError | Wrong parameter format. |
InvalidParameterValue | Incorrect parameter value. |
InvalidParameterValue.Length | Wrong parameter length. |
MissingParameter | Missing parameter. |
UnauthorizedOperation | Unauthorized operation. |
本页内容是否解决了您的问题?