Tenant Cloud Network Virtual Private Cloud NAT Gateway APIs DescribeNatGatewaySourceIpTranslationNatRules

DescribeNatGatewaySourceIpTranslationNatRules

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

1. Interface Description

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

This API (DescribeNat GatewaySourceIpTranslationNatRules) is used to query the SNAT forwarding rule object array for the NAT gateway.

Default interface request rate limit: 20 times per second.

Interface update time: 2023-08-30 23:11:46.

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: DescribeNatGatewaySourceIpTranslationNatRules
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
NatGatewayId Yes No String The unified NAT gateway ID, such as nat-jktxx454.
Example: nat-3isn9hr0
Filters No No Array of SourceIpTranslationNatRule Filter criteria: 
  •  resource-id, ID of subnet or CVM, e.g., subnet-0yi4hekt
    •  
  •  public-ip-address, elastic IP, e.g., 139.199.232.238
    •  
  • description, rule description.

    • Example:View
    Offset No No Int64 Offset. 0 by default.
    Example: 0
    Limit No No Int64 Number of returns, 20 by default, up to 100.
    Example: 10

    3. Output Parameters

    Parameter name Type Description
    SourceIpTranslationNatRuleSet Array of SourceIpTranslationNatRule NAT gateway SNAT rule object array.
    Example:View
    TotalCount Int64 Number of eligible NAT gateway port forwarding rules objects.
    Example:
    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 Invalid input parameters.
    InvalidParameterValue.Malformed Invalid input format.
    ResourceNotFound The resource does not exist
    InvalidParameterValue.LimitExceeded The parameter value exceeds the limit.
    InvalidParameterValue.Range The parameter value is not within the specified range.
    InternalServerError Internal operation error.
    InvalidAddressId.NotFound The specified EIP does not exist.