虚拟私有云 VPC-查询端口列表(废弃):URI

时间:2024-10-28 14:52:50

URI

GET /v1/ports

样例:
GET https://{Endpoint}/v1/ports?id={port_id}&name={port_name}&admin_state_up={is_admin_status_up}&network_id={network_id}&mac_address={port_mac}&device_id={port_device_id}&device_owner={device_owner}&status={port_status}&fixed_ips=ip_address={ip_address}&fixed_ips=subnet_id={subnet_id}
参数说明请参见表1
表1 参数说明

名称

是否必选

参数类型

说明

id

String

按照port_id过滤查询

name

String

  • 功能说明:按照name过滤查询
  • 取值范围:最大长度不超过255

admin_state_up

Boolean

按照admin_state_up进行过滤

network_id

String

按照network_id过滤查询

mac_address

String

按照mac_address过滤查询

device_id

String

按照device_id过滤查询

device_owner

String

按照device_owner过滤查询

status

String

  • 功能说明:按照status过滤查询
  • 取值范围:ACTIVE、BUILD、DOWN

marker

String

分页查询的起始资源ID,表示从指定资源的下一条记录开始查询。

marker需要和limit配合使用:

  • 若不传入marker和limit参数,查询结果返回第一页全部资源记录。
  • 若不传入marker参数,limit为10,查询结果返回第1~10条资源记录。
  • 若marker为第10条记录的资源ID,limit为10,查询结果返回第11~20条资源记录。
  • 若marker为第10条记录的资源ID,不传入limit参数,查询结果返回第11~2000条(limit默认值2000)资源记录。

limit

Integer

分页查询每页返回的记录个数,取值范围为0~intmax(2^31-1),默认值2000。

limit需要和marker配合使用,详细规则请见marker的参数说明。

fixed_ips

String

按照fixed_ips=ip_address或者fixed_ips=subnet_id过滤查询

support.huaweicloud.com/api-vpc/vpc_port03_0003.html