1. Interface Description
Interface request domain name: clb.api3.convergecloud.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 returns a successful result, you need to call the DescribeTaskStatus API with the returned RequestID as an input parameter to check whether this task is successful.
Default interface request rate limit: 20 times per second.
Interface update time: 2019-10-22 20:16:49.
The interface only verifies the signature but does not authenticate.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: ModifyRule |
| Version | Yes | No | String | Public parameter, The value of this interface: 2018-03-17 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| LoadBalancerId | Yes | No | String | CLB instance ID Example: lb-cuxw2rm0 |
| ListenerId | Yes | No | String | CLB listener ID Example: lbl-4fbxq45k |
| LocationId | Yes | No | String | The ID of the forwarding rule to be modified. Example: loc-9dr7bsl3 |
| Url | No | No | String | New forwarding path of the forwarding rule. This parameter is not required if the URL does not need to be modified. Example: /bar |
| HealthCheck | No | No | HealthCheck | Health check information Example:View |
| Scheduler | No | No | String | Request forwarding method of the rule. Valid values: WRR (weighted round robin), LEAST_CONN (least connections), and IP_HASH (IP hash) Default: WRR Example: LEAST_CONN |
| SessionExpireTime | No | No | Int64 | Session persistence Duration Example: 75 |
| ForwardType | No | No | String | Forwarding protocol between the CLB instance and the real server. Default: HTTP. Valid values: HTTP and HTTPS Example: HTTP |
| TargetType | No | No | String | Target real server type. NODE: Bind a general node. Example: NODE |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InvalidParameter | Wrong parameter. |
| InvalidParameterValue | Incorrect parameter value |
| InternalError | Internal Error |
| UnauthorizedOperation | Unauthorized operation |
| FailedOperation | Failed to operate. |
| InvalidParameter.FormatError | Incorrect parameter format |
| InvalidParameterValue.Length | Invalid parameter length. |
| MissingParameter | Missing parameter error. |