Help Center/ NAT Gateway/ API Reference/ APIs for Private NAT Gateways/ Transit Subnet/ Querying the Details of a Transit Subnet
Updated on 2025-07-04 GMT+08:00

Querying the Details of a Transit Subnet

Function

This API is used to query the details of a specified transit subnet.

Calling Method

For details, see Calling APIs.

URI

GET /v3/{project_id}/private-nat/transit-subnets/{transit_subnet_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

transit_subnet_id

Yes

String

Specifies the transit subnet ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. The value of X-Subject-Token in the response header is the token value.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

transit_subnet

TransitSubnet object

Specifies the response body of the transit subnet.

request_id

String

Specifies the request ID.

Table 4 TransitSubnet

Parameter

Type

Description

id

String

Specifies the transit subnet ID.

name

String

Specifies the transit subnet name.

description

String

Provides supplementary information about the transit subnet.

virsubnet_project_id

String

Specifies the ID of the project to which the transit subnet belongs.

project_id

String

Specifies the project ID.

vpc_id

String

Specifies the ID of the VPC to which the transit subnet belongs.

virsubnet_id

String

Specifies the transit subnet ID.

cidr

String

Specifies the CIDR block of the transit subnet.

type

String

Specifies the transit subnet type. The value can only be VPC.

status

String

Specifies the transit subnet status. The value can be ACTIVE, indicating the transit subnet is normal.

ip_count

Integer

Specifies the number of IP addresses that has been assigned from the transit subnet.

created_at

DateTime

Specifies when the transit subnet was assigned. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format.

updated_at

DateTime

Specifies when the transit subnet was updated. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format.

tags

Array of Tag objects

Specifies the tag list.

Table 5 Tag

Parameter

Type

Description

key

String

Specifies the tag key. A key can contain up to 128 Unicode characters. key cannot be left blank.

value

String

Specifies the tag value. Each value can contain up to 255 Unicode characters.

Example Requests

None

Example Responses

Status code: 200

The transit subnet queried.

{
  "transit_subnet" : {
    "id" : "48b55781-306c-4a90-9cc0-d376337fae4f",
    "name" : "transit-subnet_t1",
    "description" : "transit-subnet-description",
    "virsubnet_project_id" : "aea5011c0bc2454d8645a560345da810",
    "project_id" : "aea5011c0bc2454d8645a560345da810",
    "vpc_id" : "f9169a4f-5f0a-41ce-b2a3-834c15b038c2",
    "virsubnet_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
    "cidr" : "192.168.1.0/24",
    "type" : "VPC",
    "status" : "ACTIVE",
    "ip_count" : 0,
    "created_at" : "2021-07-01T09:15:54Z",
    "updated_at" : "2021-04-01T09:15:54Z",
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    } ]
  },
  "request_id" : "747a911c17067a39692f75ac146fb47e"
}

Status Codes

Status Code

Description

200

The transit subnet queried.

400

Bad Request

Error Codes

See Error Codes.