1. Interface Description
Interface request domain name: vpcdns.api3.convergecloud.com.
Create forwarding rule
Default interface request rate limit: 20 times per second.
Interface update time: 2025-06-24 04:56:48.
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: CreateForwardRule |
| 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. |
| DomainIdList | Yes | No | Array of String | Private domain ID Example: 3 |
| ForwardAddress | Yes | Yes | Array of String | Forwarding IP Example: ["1.1.1.2:80", "1.2.3.4:80"] |
| Remark | No | No | String | Description. Example: This is a forwarding rule remark. |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| RuleIdList | Array of String | Forwarding rule ID Example: ["40","41"] |
| CreatedAt | Datetime | Call Time 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. |
| InvalidParameterValue.RecordNotExist | This record does not exist. |
| UnknownParameter. | Unknown parameter. |
| InvalidParameterValue.RecordExist | Record already exists. |
| InvalidParameterValue.ForwardRuleOverLimit | Number of forwarding rules exceeds the limit of 200. |