1. Interface Description
Interface request domain name: clb.api3.convergecloud.com.
This API (DeleteRule) is used to delete a forwarding rule under a layer-7 CLB instance listener.
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: 2021-04-06 21:37:30.
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: DeleteRule |
| 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 |
| LocationIds | No | No | Array of String | Array of IDs of the forwarding rules to be deleted Example: ["loc-5lc6ji93"] |
| Domain | No | No | String | Domain name of the forwarding rule to be deleted. This parameter will not take effect when the LocationIds parameter is provided. Example: foo.net |
| Url | No | No | String | Forwarding path of the forwarding rule to be deleted. This parameter will not take effect when the LocationIds parameter is provided. Example: /bar2 |
| NewDefaultServerDomain | No | No | String | A default domain name must be configured for the listener. When you need to delete the default domain name, you can use this parameter to specify a new default domain name. Example: www.default.example.com |
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. |
| InvalidParameter.FormatError | Incorrect parameter format |
| InvalidParameterValue | Incorrect parameter value |
| UnauthorizedOperation | Unauthorized operation |
| InvalidParameterValue.Length | Invalid parameter length. |
| FailedOperation | Failed to operate. |
| InternalError | Internal Error |