弹性公网IP EIP-查询EIP列表:URI

时间:2023-11-01 16:20:29

URI

GET /v1/{project_id}/publicips

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取项目ID请参见获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

marker

String

  • 功能说明:取值为上一页数据的最后一条记录的id,为空时为查询第一页

最大长度:36

limit

Integer

  • 功能说明:每页返回的个数

  • 取值范围:0~intmax

最小值:0

ip_version

Integer

  • 功能说明:IP地址版本信息,4:IPv4,6:IPv6

枚举值:

  • 4

  • 6

enterprise_project_id

String

  • 功能说明:企业项目ID。可以使用该字段过滤某个企业项目下的EIP。

  • 取值范围:最大长度36字节,带“-”连字符的UUID格式,或者是字符串“0”。“0”表示默认企业项目。若需要查询当前用户所有企业项目绑定的弹性公网IP,请传参all_granted_eps。

关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理用户指南》

port_id

Array

  • 功能说明:绑定弹性公网IP的端口id

public_ip_address

Array

  • 功能说明:IPv4时是申请到的弹性公网IP地址,IPv6时是IPv6地址对应的IPv4地址

private_ip_address

Array

  • 功能说明:关联端口的私有IP地址

id

Array

  • 功能说明:弹性公网IP唯一标识

allow_share_bandwidth_type_any

Array

  • 功能说明:共享带宽类型,根据任一共享带宽类型过滤EIP列表。可以指定多个带宽类型,不同的带宽类型间用逗号分隔。

support.huaweicloud.com/api-eip/eip_api_0003.html