1. Interface Description
Interface request domain name: vpc.api3.convergecloud.com.
This API (DescribeNatGateways) is used to query NAT gateways.
Default interface request rate limit: 100 times per second.
Interface update time: 2019-07-05 17:39:30.
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: DescribeNatGateways |
| 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 | The unified NAT gateway ID, such as nat-jktxx454.Example: ["nat-3isn9hr0\r\n","nat-mxkohguo\r\n"] |
| Filters | No | No | Array of Filter | Filtering conditions. The parameters NatGatewayIds and Filters cannot be specified simultaneously.nat-jktxx454.vpc-jktxx454.demo_nat.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 |
|---|---|---|
| NatGatewaySet | Array of NatGateway | NAT gateway object array. Example:View |
| TotalCount | Uint64 | Number of eligible NAT gateway 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
There is no error code related to business logic for this interface, For other error codes, see public ErrorCode.