虚拟私有云 VPC-查询端口列表:URI

时间：2024-05-22 17:03:27

虚拟私有云 VPC

URI

GET /v1/{project_id}/ports

样例

GET https://{Endpoint}/v1/{project_id}/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}&limit=10&marker={marker}

参数说明请参见表1。

表1 参数说明
名称	是否必选	参数类型	说明
project_id	是	String	项目ID，请参见获取项目ID。
id	否	String	功能说明：按照端口ID过滤查询。
name	否	String	功能说明：按照端口名称过滤查询。取值范围：最大长度不超过255。
admin_state_up	否	Boolean	功能说明：按照管理状态过滤查询。取值范围：true、false
network_id	否	String	功能说明：按照端口所属网络的ID过滤查询。
mac_address	否	String	功能说明：按照端口MAC地址过滤查询。
device_id	否	String	功能说明：按照端口所属设备ID过滤查询。
device_owner	否	String	功能说明：按照端口所属设备过滤查询。取值范围：请参见表3中的device_owner参数。
status	否	String	功能说明：按照端口状态过滤查询。取值范围：ACTIVE、BUILD、DOWN。
security_groups	否	Array of strings	功能说明：按照安全组UUID列表过滤查询。
marker	否	String	分页查询的起始资源ID，表示从指定资源的下一条记录开始查询。 marker需要和limit配合使用：若不传入marker和limit参数，查询结果返回第一页全部资源记录。若不传入marker参数，limit为10，查询结果返回第1~10条资源记录。若marker为第10条记录的资源ID，limit为10，查询结果返回第11~20条资源记录。若marker为第10条记录的资源ID，不传入limit参数，查询结果返回第11条及之后的所有资源记录。
limit	否	Integer	分页查询每页返回的记录个数，取值范围为0~intmax（2^31-1），默认值2000。 limit需要和marker配合使用，详细规则请见marker的参数说明。
fixed_ips	否	Array of strings	功能说明：按照端口IP地址或者端口所属子网ID过滤查询。取值范围：fixed_ips=ip_address={ip_address}，fixed_ips=subnet_id={subnet_id}，其中{ip_address}填ip地址，如192.168.21.22；{subnet_id}填IPv4子网或IPv6子网的ID，如011fc878-5521-4654-a1ad-f5b0b5820302。
enterprise_project_id	否	String	功能说明：按照企业项目ID过滤查询。取值范围：最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。“0”表示默认企业项目。若需要查询当前用户所有企业项目绑定的端口，请传参all_granted_eps。说明：关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。
enable_efi	否	Boolean	功能说明：按照端口是否使能efi过滤查询。取值范围：true、false。