1. Interface Description
Interface request domain name: clb.api3.convergecloud.com.
After the original access address and the redirection address are configured manually, the system will automatically redirect requests made to the original access address to the target address of the corresponding path. Multiple paths can be configured as a redirection policy under one domain name to achieve automatic redirection between HTTP and HTTPS. A redirection policy should meet the following rules: if A has already been redirected to B, then it cannot be redirected to C (unless the original redirection relationship is deleted and a new one is created), and B cannot be redirected to any other addresses.
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: 2020-01-10 20:30:03.
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: ManualRewrite |
| 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-51jjji93 |
| SourceListenerId | Yes | No | String | Source listener ID Example: lbl-0nonji93 |
| TargetListenerId | Yes | No | String | Target listener ID Example: lbl-r4iaji93 |
| RewriteInfos | Yes | No | Array of RewriteLocationMap | Redirection relationship between forwarding rules Example:View |
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 |
| ResourceInsufficient | Insufficient resources |
| LimitExceeded | Quota limit reached |
| FailedOperation | Failed to operate. |
| InvalidParameter.LBIdNotFound | CLB instance ID error. |
| InvalidParameter.SomeRewriteNotFound | Some redirection rules do not exist. |
| InvalidParameter.ListenerIdNotFound | Listener ID error. |
| InvalidParameter.LocationNotFound | Unable to find eligible forwarding rules. |
| InvalidParameter.RewriteAlreadyExist | The forwarding rule has been bound to a redirection relationship. |
| InvalidParameter.ProtocolCheckFailed | Listener protocol check failed because, for example, the protocol used is incompatible with the corresponding operation. |
| InvalidParameter.FormatError | Incorrect parameter format |
| InvalidParameterValue.Length | Invalid parameter length. |