文档首页> 虚拟私有云 VPC> API参考> API V3> 辅助弹性网卡> 查询租户下辅助弹性网卡列表
更新时间:2024-04-29 GMT+08:00
分享

查询租户下辅助弹性网卡列表

功能介绍

查询辅助弹性网卡列表,单次查询最多返回2000条数据。

调试

您可以在API Explorer中调试该接口。

URI

GET /v3/{project_id}/vpc/sub-network-interfaces

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

表2 Query参数

参数

是否必选

参数类型

描述

id

ARRAY

  • 功能说明:辅助弹性网卡ID,支持多ID过滤。
  • 使用场景:查询需要的多个辅助弹性网卡信息。

description

ARRAY

  • 功能说明:辅助弹性网卡的描述信息,支持多个同时过滤。
  • 使用场景:通过描述信息过滤辅助弹性网卡。

limit

Integer

每页返回的个数。

mac_address

ARRAY

  • 功能说明:辅助弹性网卡的mac地址,支持多个同时过滤。
  • 使用场景:使用mac地址精确过滤辅助弹性网卡。

marker

String

分页查询起始的资源ID,为空时查询第一页。

parent_id

ARRAY

  • 功能说明:辅助弹性网卡的宿主网卡的ID,支持多ID过滤。
  • 使用场景:过滤单个或多个宿主网卡下存在的辅助弹性网卡。

private_ip_address

ARRAY

  • 功能说明:辅助弹性网卡的私有IPv4地址,支持多个地址同时过滤。
  • 使用场景:通过单个或者多个ip地址过滤查询辅助弹性网卡。

virsubnet_id

ARRAY

  • 功能说明:辅助弹性网卡所属虚拟子网的ID,支持多个ID过滤。
  • 使用场景:过滤需要的单个或者多个虚拟子网下的辅助弹性网卡。

vpc_id

ARRAY

  • 功能说明:辅助弹性网卡所属的VPC_ID,支持多ID过滤。
  • 使用场景:过滤单个或多个VPC下的辅助弹性网卡信息。

请求参数

响应参数

状态码为 200 时:

表3 响应Body参数

参数

参数类型

描述

request_id

String

  • 功能说明:请求ID。
  • 取值范围:标准UUID。

sub_network_interfaces

Array of SubNetworkInterface objects

  • 功能说明:辅助弹性网卡查询对象。

page_info

PageInfo object

分页信息。

表4 SubNetworkInterface

参数

参数类型

描述

id

String

  • 功能说明:辅助弹性网卡的唯一标识。
  • 取值范围:带(-)的标准UUID。

virsubnet_id

String

  • 功能说明:虚拟子网ID,即子网ID,对应控制台子网界面的网络ID。
  • 取值范围:标准UUID。

private_ip_address

String

  • 功能说明:辅助弹性网卡的私有IPv4地址。
  • 取值范围:必须在虚拟子网的网段内,不填则随机在虚拟子网网段内随机分配。

ipv6_ip_address

String

  • 功能说明:辅助弹性网卡的私有IPv6地址。
  • 取值范围:必须在虚拟子网的网段内,不填则随机在虚拟子网网段内随机分配。

mac_address

String

  • 功能说明:辅助弹性网卡的mac地址。
  • 取值范围:合法的mac地址,系统随机分配。

parent_device_id

String

  • 功能说明:设备ID。
  • 取值范围:标准UUID。

parent_id

String

  • 功能说明:宿主网络接口的ID。
  • 取值范围:标准UUID。

description

String

  • 功能说明:辅助弹性网卡的描述信息。
  • 取值范围:0-255个字符,不能包含“<”和“>”。

vpc_id

String

  • 功能说明:辅助弹性网卡所属的VPC_ID。
  • 取值范围:标准UUID。

vlan_id

Integer

  • 功能说明:辅助弹性网卡的VLAN ID。
  • 取值范围:1-4094。
  • 约束:同一个宿主网络接口下唯一。

security_enabled

Boolean

  • 功能说明:辅助弹性网卡安全使能标记,如果不使能则安全组不生效。

security_groups

Array of strings

  • 功能说明:安全组的ID列表,例如:"security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"]。
  • 取值范围:默认值为系统默认安全组。

tags

Array of strings

  • 功能说明:辅助弹性网卡的标签列表。

project_id

String

  • 功能说明:辅助弹性网卡所属项目ID。

created_at

String

  • 功能说明:辅助弹性网卡的创建时间。
  • 取值范围:UTC时间格式:yyyy-MM-ddTHH:mm:ssZ。
表5 PageInfo

参数

参数类型

描述

previous_marker

String

当前页第一条记录。

current_count

Integer

当前页总数。

next_marker

String

当前页最后一条记录,最后一页时无next_marker字段。

请求示例

过滤查询辅助弹性网卡列表
GET https://{Endpoint}/v3/{project_id}/vpc/sub-network-interfaces?vpc_id=63b97e6b-3598-430f-9eb8-1caf06937be8

响应示例

状态码为 200 时:

OK

{
  "request_id" : "e4cb9e3a-7b99-41c9-afd8-1630fe313299",
  "sub_network_interfaces" : [ {
    "id" : "2be868f2-f7c9-48db-abc0-eea0b9105b0d",
    "project_id" : "8c6fb137a48a428aaf9a0229dca4edb3",
    "virsubnet_id" : "08278e6c-61ca-46c1-9fc3-0d4f6c12f193",
    "private_ip_address" : "10.0.0.225",
    "ipv6_ip_address" : null,
    "mac_address" : "fa:16:3e:48:f8:6f",
    "parent_device_id" : "1ab01f1d-4ef7-4d83-82be-802b3aca0223",
    "security_groups" : [ "6727c950-9f01-47a2-a7aa-7d3686c4c95b" ],
    "vpc_id" : "63b97e6b-3598-430f-9eb8-1caf06937be8",
    "description" : null,
    "parent_id" : "637748df-2986-4350-8303-95d259580fb3",
    "vlan_id" : 2787,
    "tags" : [ ],
    "created_at" : "2020-05-19T01:16:25Z"
  }, {
    "id" : "55761e2d-8f72-42c0-9874-98e9885bf0fe",
    "project_id" : "8c6fb137a48a428aaf9a0229dca4edb3",
    "virsubnet_id" : "08278e6c-61ca-46c1-9fc3-0d4f6c12f193",
    "private_ip_address" : "10.0.3.55",
    "ipv6_ip_address" : null,
    "mac_address" : "fa:16:3e:c2:2c:ba",
    "parent_device_id" : "1ab01f1d-4ef7-4d83-82be-802b3aca0223",
    "security_groups" : [ "6727c950-9f01-47a2-a7aa-7d3686c4c95b" ],
    "vpc_id" : "63b97e6b-3598-430f-9eb8-1caf06937be8",
    "description" : null,
    "parent_id" : "637748df-2986-4350-8303-95d259580fb3",
    "vlan_id" : 799,
    "tags" : [ ],
    "created_at" : "2020-05-19T01:16:31Z"
  } ],
  "page_info" : {
    "next_marker" : "55761e2d-8f72-42c0-9874-98e9885bf0fe",
    "previous_marker" : "2be868f2-f7c9-48db-abc0-eea0b9105b0d",
    "current_count" : 2
  }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

分享:

    相关文档

    相关产品