Help Center/ NAT Gateway/ API Reference/ Out-of-Date APIs/ API v2.0/ Public NAT Gateways/ Querying Details About a Public NAT Gateway
Updated on 2025-12-26 GMT+08:00
View PDF

Querying Details About a Public NAT Gateway

Function

This API is used to query details about a public NAT gateway.

URI

GET /v2.0/nat_gateways/{nat_gateway_id}

Table 1 Parameter description

Parameter

Mandatory

Type

Description

nat_gateway_id

Yes

String

Specifies the public NAT gateway ID.

Request

None

Response

Table 2 lists response parameter.

Table 2 Response parameter

Parameter

Type

Description

nat_gateway

Object

Specifies the NAT gateway object. For details, see Table 3.
Table 3 Description of the nat_gateway field

Parameter

Type

Description

id

String

Specifies the public NAT gateway ID.

tenant_id

String

Specifies the project ID.

name

String

Specifies the name of the public NAT gateway. You can enter up to 64 characters.

The name can contain only digits, letters, underscores (_), and hyphens (-).

description

String

Provides supplementary information about the public NAT gateway. You can enter up to 255 characters.

spec

String

Specifies the public NAT gateway type.

The value can be:

  • 1: small type, which supports up to 10,000 SNAT connections.
  • 2: medium type, which supports up to 50,000 SNAT connections.
  • 3: large type, which supports up to 200,000 SNAT connections.
  • 4: extra-large type, which supports up to 1,000,000 SNAT connections.

router_id

String

Specifies the router ID.

internal_network_id

String

Specifies the network ID of the downstream interface (the next hop of DVR) of the public NAT gateway.

status

String
  • Specifies the public NAT gateway status.
  • For details about all its values, see Table 1.

admin_state_up

Boolean

created_at

String

Specifies when the public NAT gateway was created (UTC time). Its value rounds to 6 decimal places for seconds. The format is yyyy-mm-dd hh:mm:ss.

Examples

  • Example request 
    GET https://{Endpoint}/v2.0/nat_gateways/a78fb3eb-1654-4710-8742-3fc49d5f04f8
  • Example response 
    {
    "nat_gateway": { 
         "router_id": "d84f345c-80a1-4fa2-a39c-d0d397c3f09a", 
         "status": "ACTIVE", 
         "description": "my nat gateway 01", 
         "admin_state_up": true, 
         "tenant_id": "27e25061336f4af590faeabeb7fcd9a3", 
         "created_at": "2017-11-18 07:34:32.203044", 
         "spec": "1", 
         "internal_network_id": "89d66639-aacb-4929-969d-07080b0f9fd9", 
         "id": "a78fb3eb-1654-4710-8742-3fc49d5f04f8", 
         "name": "nat_001" 
    }
}

Status Codes

See Status Codes.

Parent topic: Public NAT Gateways