1. Interface Description
Interface request domain name: vpcdns.api3.convergecloud.com.
This API is used to pull the forwarding rule list.
Default interface request rate limit: 20 times per second.
Interface update time: 2025-06-24 04:58:19.
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: DescribeForwardRuleList |
| Version | Yes | No | String | Public parameter, The value of this interface: 2019-10-25 |
| Region | No | No | String | Public parameter,Regional information This interface does not need to pass this parameter. |
| Filters | No | No | Array of RuleListFilters | DomainName, ForwardIp and DomainId. Example:View |
| Offset | Yes | No | Int64 | Offset. Example: 0 |
| Limit | Yes | No | Int64 | Length. Example: 20 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| Total | Int64 | Total number Example: 3 |
| ForwardRuleList | Array of ForwardRuleList | Forwarding rule list. Example:View |
| CreatedAt | Datetime | The response time of the binding request. Example: 2014-08-03 12:00:00 |
| 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 |
|---|---|
| InvalidParameterValue. | Parameter value error. |
| InternalError.UndefiendError | Undefined error. |
| InvalidParameter. | Parameter error. |