Tenant Cloud Network Virtual Private Cloud NAT Gateway APIs DescribeNatGatewayDestinationIpPortTranslationNatRules

DescribeNatGatewayDestinationIpPortTranslationNatRules

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

1. Interface Description

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

This API (DescribeNat GatewayDestinationIpPortTranslationNatRules) is used to query the NAT gateway port forwarding rule object array.

Default interface request rate limit: 100 times per second.

Interface update time: 2019-08-02 18:03:25.

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: DescribeNatGatewayDestinationIpPortTranslationNatRules
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
NatGatewayIds No No Array of String NAT gateway ID.
Example: ["nat-3isn9hr0\r\n"]
Filters No No Array of Filter Filter criteria:
Parameters NatGatewayIds and Filters must not be specified simultaneously.
  • nat-gateway-id - NAT gateway ID, e.g., nat-0yi4hekt;
  • vpc-id - VPC ID, e.g., vpc-0yi4hekt;
  • public-ip-address - EIP, e.g., 139.199.232.238;
  • public-port - Public port.
  • private-ip-address - Private IP, e.g., 10.0.0.1;
  • private-port - Private port.
  • description - Rule description.

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

    3. Output Parameters

    Parameter name Type Description
    NatGatewayDestinationIpPortTranslationNatRuleSet Array of NatGatewayDestinationIpPortTranslationNatRule NAT gateway port forwarding rule object array.
    Example:View
    TotalCount Uint64 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
    InvalidParameterValue The parameter value is invalid.
    InvalidParameter Invalid input parameters.
    InvalidParameterValue.Malformed Invalid input format.
    InvalidParameter.Coexist The parameters must not be specified simultaneously.
    InvalidParameterValue.Duplicate Input Parameters are repetitive.
    UnauthorizedOperation Unauthorized operation
    InvalidParameterValue.LimitExceeded The parameter value exceeds the limit.
    InternalServerError Internal operation error.
    InvalidAddressId.NotFound The specified EIP does not exist.