Queries the resources of a NAT firewall.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| Lang |
string |
No |
The language of the response. Valid values:
|
zh |
| NatGatewayId |
string |
No |
The ID of the NAT Gateway. |
ngw-uf6y16l23fm8hq0**** |
| MemberUid |
integer |
No |
The UID of the member account. |
136481150091**** |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| RequestId |
string |
The ID of the request. |
A8E8D50E-9F45-5662-B116-A1D0807F**** |
| ResourceList |
array<object> |
The list of resources. |
|
|
array<object> |
The list of resources. |
||
| RegionNo |
string |
The region ID. |
cn-beijing |
| VpcList |
array<object> |
The information about the VPCs. |
|
|
array<object> |
The information about the VPCs. |
||
| VpcId |
string |
The ID of the VPC instance. |
vpc-8vbuzirdl3w1r7exw**** |
| VpcName |
string |
The name of the VPC instance. |
vpc-wz94a4q37rgl7g**** |
| CidrBlock |
string |
The IPv4 CIDR block of the VPC. |
192.168.0.0/16 |
| MemberUid |
string |
The UID of the member account. |
157862808111**** |
| NatGateways |
array<object> |
The list of NAT gateways. |
|
|
array<object> |
The information about the NAT Gateway. |
||
| Status |
string |
The status of the NAT Gateway. |
Available |
| Detail |
string |
The status of the NAT Gateway. |
Available |
| NatGatewayId |
string |
The ID of the NAT Gateway. |
ngw-bp1bm0k2t8i6ooxu**** |
| NatGatewayName |
string |
The name of the NAT Gateway. |
ngw-test |
| NatRouteEntryList |
array<object> |
The list of NAT route tables. |
|
|
object |
The NAT route table. |
||
| NextHopId |
string |
The ID of the next hop instance. |
ngw-2zey0w2u02u1x584m**** |
| DestinationCidr |
string |
The destination CIDR block. |
10.0.70.XX/24 |
| RouteTableId |
string |
The ID of the route table. |
vtb-2ze409pp09d994a**** |
| NextHopType |
string |
The network type of the next hop. |
NatGateway |
Examples
Success response
JSON format
{
"RequestId": "A8E8D50E-9F45-5662-B116-A1D0807F****",
"ResourceList": [
{
"RegionNo": "cn-beijing",
"VpcList": [
{
"VpcId": "vpc-8vbuzirdl3w1r7exw****",
"VpcName": "vpc-wz94a4q37rgl7g****",
"CidrBlock": "192.168.0.0/16",
"MemberUid": "157862808111****",
"NatGateways": [
{
"Status": "Available",
"Detail": "Available",
"NatGatewayId": "ngw-bp1bm0k2t8i6ooxu****",
"NatGatewayName": "ngw-test",
"NatRouteEntryList": [
{
"NextHopId": "ngw-2zey0w2u02u1x584m****",
"DestinationCidr": "10.0.70.XX/24",
"RouteTableId": "vtb-2ze409pp09d994a****",
"NextHopType": "NatGateway"
}
]
}
]
}
]
}
]
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | ErrorAliUid | Aliuid invalid. | The aliuid is invalid. |
| 400 | ErrorDBSelectError | A database select error occurred. | The error message returned because an internal error has occurred in querying the database. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.