Querying Transit Subnets

Function

This API is used to query transit subnets.

Constraints

You can type a question mark (?) and an ampersand (&) at the end of the URI to define multiple search criteria. All optional parameters can be filtered. For details, see the example request.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
id	No	Array of strings	Specifies the transit subnet ID.
name	No	Array of strings	Specifies the transit subnet name.
description	No	Array of strings	Provides supplementary information about the transit subnet.
virsubnet_project_id	No	Array of strings	Specifies the ID of the project to which the transit subnet belongs.
vpc_id	No	Array of strings	Specifies the ID of the VPC to which the transit subnet belongs.
virsubnet_id	No	Array of strings	Specifies the transit subnet ID.
status	No	Array of strings	Specifies the transit subnet status. Range: ACTIVE: The transit subnet is normal. PENDING_ACCEPT: The request for the transit subnet is waiting for approval. REJECTED: The request for the transit subnet is rejected.
limit	No	Integer	Specifies the number of records returned on each page. Value range: 1–2000 Default value: 2000
marker	No	String	Specifies the start resource ID of pagination query. If the parameter is left blank, only resources on the first page are queried. The value was obtained from next_marker or previous_marker in PageInfo queried last time.
page_reverse	No	Boolean	Specifies whether to query the previous page.

Request Parameters

**Table 3** 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 4** Response body parameters
Parameter	Type	Description
transit_subnets	Array of TransitSubnet objects	Specifies the response body for querying transit subnets. For details, see the description of the TransitSubnet field.
request_id	String	Specifies the request ID.
page_info	PageInfo object	Specifies the pagination information.

**Table 5** 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	String	Specifies when the transit subnet was assigned. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format.
updated_at	String	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 6** 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.

**Table 7** PageInfo
Parameter	Type	Description
next_marker	String	Specifies the ID of the last record in this query, which can be used in the next query.
previous_marker	String	Specifies the ID of the first record in the pagination query result. When page_reverse is set to true, this parameter is used together to query resources on the previous page.
current_count	Integer	Specifies the ID of the last record in the pagination query result. It is usually used to query resources on the next page.

Example Requests

None

Example Responses

Status code: 200

Transit subnets queried.

{
  "transit_subnets" : [ {
    "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"
    } ]
  }, {
    "id" : "500caad8-5023-11f0-8369-02421d92b15b",
    "name" : "transit-subnet_t2",
    "description" : "transit-subnet-description",
    "virsubnet_project_id" : "aea5011c0bc2454d8645a560345da810",
    "project_id" : "aea5011c0bc2454d8645a560345da810",
    "vpc_id" : "f9169a4f-5f0a-41ce-b2a3-834c15b038c2",
    "virsubnet_id" : "2759da7b-8015-404c-ae0a-a389007b0e2d",
    "cidr" : "192.168.2.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" : "key2",
      "value" : "value2"
    } ]
  } ],
  "request_id" : "a7b00469-5a31-4274-bb10-59167243383e",
  "page_info" : {
    "previous_marker" : "14338426-6afe-4019-996b-018008113013",
    "current_count" : 2
  }
}