弹性公网IP EIP-查询EIP列表:响应参数

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

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

publicips

Array of PublicipShowResp objects

弹性公网IP对象

表4 PublicipShowResp

参数

参数类型

描述

bandwidth_id

String

  • 功能说明:EIP对应带宽ID

最大长度:36

bandwidth_name

String

  • 功能说明:带宽名称

最小长度:1

最大长度:64

bandwidth_share_type

String

  • 功能说明:表示共享带宽或者独享带宽

  • 取值范围:

    • WHOLE:共享带宽

    • PER:独享带宽

  • 约束:其中IPv6暂不支持WHOLE类型带宽。

枚举值:

  • WHOLE

  • PER

bandwidth_size

Integer

  • 功能说明:带宽大小,单位为Mbit/s。

最小值:0

create_time

String

  • 功能说明:EIP申请时间(UTC)

enterprise_project_id

String

  • 企业项目ID。最大长度36字节,带“-”连字符的UUID格式,或者是字符串“0”。

  • 创建弹性公网IP时,给弹性公网IP绑定企业项目ID。

  • 不指定该参数时,默认值是 0

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

最大长度:36

id

String

  • 功能说明:EIP唯一标识

最大长度:36

port_id

String

  • 功能说明:端口id。

  • 约束:只有绑定了的EIP查询才会返回该参数

最大长度:36

private_ip_address

String

  • 功能说明:绑定弹性公网IP的私有IP地址

  • 约束:只有绑定了的弹性公网IP查询才会返回该参数

profile

ProfileResp object

  • 功能说明:额外参数,包括订单id、产品id等信息

  • 约束:如果profile不为空,说明是包周期的EIP

public_ip_address

String

  • 功能说明:IPv4时是申请到的EIP地址,IPv6时是IPv6地址对应的IPv4地址

最大长度:15

status

String

  • 功能说明:弹性公网IP的状态

  • 取值范围

    • FREEZED:冻结

    • BIND_ERROR:绑定失败

    • BINDING:绑定中

    • PENDING_DELETE:释放中

    • PENDING_CREATE:创建中

    • NOTIFYING:创建中

    • NOTIFY_DELETE:释放中

    • PENDING_UPDATE:更新中

    • DOWN:未绑定

    • ACTIVE:绑定

    • ELB:绑定ELB

    • VPN:绑定VPN

    • ERROR:失败

枚举值:

  • FREEZED

  • BIND_ERROR

  • BINDING

  • PENDING_DELETE

  • PENDING_CREATE

  • NOTIFYING

  • NOTIFY_DELETE

  • PENDING_UPDATE

  • DOWN

  • ACTIVE

  • ELB

  • VPN

  • ERROR

tenant_id

String

  • 功能说明:项目ID

最大长度:36

type

String

  • 功能说明:EIP的类型

  • 取值范围:5_bgp(全动态BGP),5_sbgp(静态BGP),5_youxuanbgp(优选BGP)

    • 华南-广州:5_bgp、5_sbgp

    • 华东-上海一:5_bgp、5_sbgp

    • 华东-上海二:5_bgp、5_sbgp

    • 华北-北京一:5_bgp、5_sbgp

    • 中国-香港:5_bgp、5_youxuanbgp

    • 亚太-曼谷:5_bgp

    • 亚太-新加坡:5_bgp

    • 非洲-约翰内斯堡:5_bgp

    • 西南-贵阳一:5_sbgp

    • 华北-北京四:5_bgp、5_sbgp

    • 拉美-圣地亚哥:5_bgp

    • 拉美-圣保罗一:5_bgp

    • 拉美-墨西哥城一:5_bgp

    • 拉美-布宜诺斯艾利一:5_bgp

    • 拉美-利马一:5_bgp

    • 拉美-圣地亚哥二: 5_bgp

  • 约束:

    • 必须是系统具体支持的类型。

    • publicip_id为IPv4端口,所以"type"字段未给定时,默认为5_bgp。

最大长度:36

public_ipv6_address

String

  • 功能说明:IPv4时无此字段,IPv6时为申请到的EIP地址

最大长度:39

ip_version

Integer

  • 功能说明:IP版本信息

  • 取值范围是4和6

    • 4:IPv4

    • 6:IPv6

枚举值:

  • 4

  • 6

public_border_group

String

  • 功能说明:表示中心站点资源或者边缘站点资源,对接了边缘站点的区域才会返回该字段

  • 取值范围: center、边缘站点名称

  • 约束:publicip只能绑定该字段相同的资源

最小长度:1

最大长度:64

allow_share_bandwidth_types

Array of strings

  • 功能说明:表示此publicip可以加入的共享带宽类型列表,如果列表为空,则表示该publicip不能加入任何共享带宽

  • 约束:publicip只能加入到有该带宽类型的共享带宽中

最大长度:64

alias

String

  • 功能说明:弹性公网IP名称

  • 取值范围:1-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点)

最大长度:64

表5 ProfileResp

参数

参数类型

描述

order_id

String

订单的id

最大长度:36

product_id

String

产品的id

最大长度:36

region_id

String

region的id

最大长度:36

user_id

String

用户的id

最大长度:36

状态码: 400

表6 响应Body参数

参数

参数类型

描述

message

String

服务异常错误信息描述

最小长度:0

最大长度:256

code

String

服务异常错误信息编码

最小长度:0

最大长度:36

状态码: 401

表7 响应Body参数

参数

参数类型

描述

message

String

服务异常错误信息描述

最小长度:0

最大长度:256

code

String

服务异常错误信息编码

最小长度:0

最大长度:36

状态码: 403

表8 响应Body参数

参数

参数类型

描述

message

String

服务异常错误信息描述

最小长度:0

最大长度:256

code

String

服务异常错误信息编码

最小长度:0

最大长度:36

状态码: 404

表9 响应Body参数

参数

参数类型

描述

message

String

服务异常错误信息描述

最小长度:0

最大长度:256

code

String

服务异常错误信息编码

最小长度:0

最大长度:36

状态码: 405

表10 响应Body参数

参数

参数类型

描述

message

String

服务异常错误信息描述

最小长度:0

最大长度:256

code

String

服务异常错误信息编码

最小长度:0

最大长度:36

状态码: 406

表11 响应Body参数

参数

参数类型

描述

message

String

服务异常错误信息描述

最小长度:0

最大长度:256

code

String

服务异常错误信息编码

最小长度:0

最大长度:36

状态码: 407

表12 响应Body参数

参数

参数类型

描述

message

String

服务异常错误信息描述

最小长度:0

最大长度:256

code

String

服务异常错误信息编码

最小长度:0

最大长度:36

状态码: 408

表13 响应Body参数

参数

参数类型

描述

message

String

服务异常错误信息描述

最小长度:0

最大长度:256

code

String

服务异常错误信息编码

最小长度:0

最大长度:36

状态码: 409

表14 响应Body参数

参数

参数类型

描述

message

String

服务异常错误信息描述

最小长度:0

最大长度:256

code

String

服务异常错误信息编码

最小长度:0

最大长度:36

状态码: 500

表15 响应Body参数

参数

参数类型

描述

message

String

服务异常错误信息描述

最小长度:0

最大长度:256

code

String

服务异常错误信息编码

最小长度:0

最大长度:36

状态码: 501

表16 响应Body参数

参数

参数类型

描述

message

String

服务异常错误信息描述

最小长度:0

最大长度:256

code

String

服务异常错误信息编码

最小长度:0

最大长度:36

状态码: 502

表17 响应Body参数

参数

参数类型

描述

message

String

服务异常错误信息描述

最小长度:0

最大长度:256

code

String

服务异常错误信息编码

最小长度:0

最大长度:36

状态码: 503

表18 响应Body参数

参数

参数类型

描述

message

String

服务异常错误信息描述

最小长度:0

最大长度:256

code

String

服务异常错误信息编码

最小长度:0

最大长度:36

状态码: 504

表19 响应Body参数

参数

参数类型

描述

message

String

服务异常错误信息描述

最小长度:0

最大长度:256

code

String

服务异常错误信息编码

最小长度:0

最大长度:36

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