查询中转子网列表 - ListTransitSubnets

功能介绍

查询中转子网列表。

接口约束

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

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

nat:transitSubnets:list

List

transitSubnet *

-

-

-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
nat:transitSubnets:list	List	transitSubnet *	-	-	-

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