ModifyForwardRule

Last Updated At: 2026-10-28 00:03:56

1. Interface Description

Interface request domain name: vpcdns.api3.convergecloud.com.

This API is used to modify forwarding rules.

Default interface request rate limit: 20 times per second.

Interface update time: 2025-06-24 04:59:40.

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: ModifyForwardRule
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.
RuleId	Yes	No	String	Forwarding rule ID Example: 20
ForwardAddress	Yes	Yes	Array of String	Forwarding rule ID Example: ["1.1.1.2:80", "1.2.3.4:80"]
Remark	No	Yes	String	Description. Example: This is a remark.

3. Output Parameters

Parameter name	Type	Description
RuleId	String	Forwarding rule ID Example: 12
ForwardAddress	Array of String	Forwarding address IP address. Example: ["1.1.1.2:80", "1.2.3.4:80"]
Remark	String	Remarks Example: This is a remark.
CreatedAt	Datetime	The response time of the binding request. Example: 2014-08-03 12:00:0
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.