1. Interface Description
Interface request domain name: clb.api3.convergecloud.com.
An HTTPS:443 listener needs to be created first, along with a forwarding rule. When this API is called, an HTTP:80 listener will be created automatically if it did not exist and a forwarding rule corresponding to Domains (specified in the input parameter) under the HTTPS:443 listener will also be created. After successful creation, access requests to an HTTP:80 address will be redirected to an HTTPS:443 address automatically.
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: 2024-02-18 17:59:55.
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: AutoRewrite |
| 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-r6nx1iby |
| ListenerId | Yes | No | String | HTTPS:443 listener ID Example: lbl-lmeeyb1q |
| Domains | No | No | Array of String | The domain name to be redirected under the HTTPS:443 listener Example: ["www.domain1.com"] |
| TakeUrls | No | No | Array of Bool | Whether the matched URL is carried in redirection Example: [true] |
| RewriteCodes | No | No | Array of Int64 | Redirection status code. Valid values: 301, 302, and 307. Example: [301] |
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.ListenerIdNotFound | Listener ID error. |
| InvalidParameter.LocationNotFound | Unable to find eligible forwarding rules. |
| InvalidParameter.PortCheckFailed | Listener port check due to port conflicts or other reasons. |
| InvalidParameter.FormatError | Incorrect parameter format |
| InvalidParameterValue.Length | Invalid parameter length. |