DescribePeerIpTranslationNatRules

Last Updated At: 2026-08-02 00:06:16

1. Interface Description

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

Query the Direct Connect customer gateway IP translation

Default interface request rate limit: 20 times per second.

Interface update time: 2022-07-27 03:21:37.

The interface is both signature verification and authentication.

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: DescribePeerIpTranslationNatRules
Version	Yes	No	String	Public parameter, The value of this interface: 2017-03-12
Region	No	No	String	Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface
DirectConnectGatewayId	Yes	No	String	Direct connect gateway ID Example: dcg-e6mxyyvj
VpcId	Yes	No	String	Character-type VPCID Example: vpc-67wlqf6v
Offset	No	No	Int64	Offset. Default value: 0 Example: 0
Limit	No	No	Int64	Number of request objects. The default value is 20. Example: 20
Filters	No	No	Array of Filter	Filter criteria, which support filtering by description. Example:View

3. Output Parameters

Parameter name	Type	Description
PeerIpTranslationNatRuleSet	Array of LocalIpTranslationNatRule	Customer IP translation list Example:View
TotalCount	Int64	Count of eligible customer IP translation lists Example: 10
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	The parameter value is invalid.
InvalidParameter	Invalid input parameters.
LimitExceeded	Exceeded the limit
InternalServerError	Internal operation error.