文档首页/ NAT网关 NAT/ API参考/ API(私网NAT网关)/ 中转子网/ 查询中转子网列表 - ListTransitSubnet
更新时间:2025-12-10 GMT+08:00

查询中转子网列表 - ListTransitSubnet

功能介绍

查询中转子网列表。

接口约束

可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 支持参数说明中所有非必选参数过滤,请参考请求样例。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

表2 Query参数

参数

是否必选

参数类型

描述

id

Array of strings

中转子网的ID

name

Array of strings

中转子网的名字

description

Array of strings

中转子网的描述

virsubnet_project_id

Array of strings

中转子网的子网所属项目的ID

vpc_id

Array of strings

中转子网的子网所属的VPC的ID

virsubnet_id

Array of strings

中转子网的子网ID

status

Array of strings

中转子网状态。

取值范围:

ACTIVE: 当前资源状态正常。

INACTIVE: 不可用。

limit

Integer

功能说明:每页返回的个数。 取值范围:1~2000。 默认值:2000

marker

String

功能说明:分页查询起始的资源ID,为空时查询第一页。 值从上一次查询的PageInfo中的next_marker或者previous_marker中获取

page_reverse

Boolean

是否查询前一页

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

用户Token也就是调用获取用户Token获取请求认证接口的响应值,该接口是唯一不需要认证的接口。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

transit_subnets

Array of TransitSubnet objects

查询中转子网列表的响应体。详见TransitSubnet字段说明

request_id

String

请求ID。

page_info

PageInfo object

分页信息。

表5 TransitSubnet

参数

参数类型

描述

id

String

中转子网的ID

name

String

中转子网的名称

description

String

中转子网的描述

virsubnet_project_id

String

中转子网的子网所属的项目ID

project_id

String

项目ID

vpc_id

String

中转子网的子网所属VPC的ID

virsubnet_id

String

中转子网的子网ID

cidr

String

中转子网的子网网段

type

String

中转子网类型。取值范围:VPC

status

String

中转子网状态。

取值范围:

ACTIVE: 当前资源状态正常。

INACTIVE: 不可用。

ip_count

Integer

当前中转子网下已分配的中转子网IP数量。

created_at

String

中转子网创建时间,遵循UTC时间,格式是yyyy-mm-ddThh:mm:ssZ。

updated_at

String

中转子网更新时间,遵循UTC时间,格式是yyyy-mm-ddThh:mm:ssZ。

tags

Array of Tag objects

标签列表

表6 Tag

参数

参数类型

描述

key

String

键。最大长度128个unicode字符。key不能为空。

value

String

值。每个值最大长度255个unicode字符。

表7 PageInfo

参数

参数类型

描述

next_marker

String

分页查询结果中最后一条记录的ID。通常用于查询下一页。

previous_marker

String

分页查询结果中第一条记录的ID。通常用于配合page_reverse=true查询上一页。

current_count

Integer

分页查询资源时,本页的实例的个数。

请求示例

响应示例

状态码:200

查询中转子网列表成功。

{
  "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
  }
}

SDK代码示例

SDK代码示例如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.nat.v2.region.NatRegion;
import com.huaweicloud.sdk.nat.v2.*;
import com.huaweicloud.sdk.nat.v2.model.*;


public class ListTransitSubnetSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        NatClient client = NatClient.newBuilder()
                .withCredential(auth)
                .withRegion(NatRegion.valueOf("<YOUR REGION>"))
                .build();
        ListTransitSubnetRequest request = new ListTransitSubnetRequest();
        try {
            ListTransitSubnetResponse response = client.listTransitSubnet(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdknat.v2.region.nat_region import NatRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdknat.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = NatClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(NatRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListTransitSubnetRequest()
        response = client.list_transit_subnet(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    nat "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/nat/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/nat/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/nat/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := nat.NewNatClient(
        nat.NatClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListTransitSubnetRequest{}
	response, err := client.ListTransitSubnet(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

查询中转子网列表成功。

错误码

请参见错误码