文档首页/ 弹性公网IP EIP/ API参考/ API V3/ 公共池/ 查询公网IP池列表
更新时间：2024-04-17 GMT+08:00
查看PDF

查询公网IP池列表

功能介绍

全量查询公网IP池列表

URI

GET /v3/{project_id}/eip/publicip-pools

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String
  • 功能说明：项目ID

最小长度：0

最大长度：32
表2 Query参数

参数

是否必选

参数类型

描述

marker

否

String
  • 功能说明：分页查询起始的资源ID，为空时为查询第一页

最小长度：0

最大长度：36

limit

否

Integer
  • 功能说明：每页返回的个数
  • 取值范围：0~[2000]，其中2000为局点差异项，具体取值由局点决定

最小值：0

最大值：2000

fields

否

String
  • 功能说明：查询字段，形式为"fields=id&fields=name&..."
  • 支持字段：id/name/size/used/project_id/status/billing_info/created_at/updated_at/type/shared/is_common/description/tags/enterprise_project_id/allow_share_bandwidth_types/public_border_group

最小长度：0

最大长度：1024

sort_key

否

String
  • 功能说明：排序字段，形式为"sort_key=id&sort_dir=asc"
  • 支持字段：id/name/created_at/updated_at/public_border_group

最小长度：0

最大长度：36

sort_dir

否

String
  • 功能说明：排序方向
  • 取值范围：asc、desc

最小长度：0

最大长度：16

id

否

String
  • 功能说明：根据id过滤

最小长度：0

最大长度：36

name

否

String
  • 功能说明：根据name过滤

最小长度：0

最大长度：128

size

否

Integer
  • 功能说明：根据size过滤

最小值：0

最大值：999999

status

否

String
  • 功能说明：根据status过滤

最小长度：0

最大长度：36

type

否

String
  • 功能说明：根据type过滤

最小长度：0

最大长度：36

description

否

String
  • 功能说明：根据description过滤

最小长度：0

最大长度：1024

public_border_group

否

String
  • 功能说明：根据public_border_group过滤

最小长度：0

最大长度：64

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

publicip_pools

Array of PublicipPoolShowResp objects

功能说明：公网池对象

request_id

String

本次请求的编号

page_info

PageInfoOption object

分页页码信息
表4 PublicipPoolShowResp

参数

参数类型

描述

id

String
  • 功能说明：公网IP池id

最小长度：1

最大长度：36

name

String
  • 功能说明：公网IP池名字

最小长度：0

最大长度：64

status

String
  • 功能说明：公网IP池状态

最小长度：0

最大长度：36

type

String
  • 功能说明：类型
  • 取值范围：
    • spec_bgp：专属离散动态
    • spec_sbgp：专属离散静态

枚举值：

  • spec_bgp
  • spec_sbgp

description

String
  • 功能说明：描述

最小长度：0

最大长度：1024

project_id

String
  • 功能说明：租户id

最小长度：1

最大长度：36

size

Integer
  • 功能说明：池子大小

最小值：0

最大值：999999

used

Integer
  • 功能说明：已经使用的ip数量

最小值：0

最大值：999999

created_at

String
  • 功能说明：公网IP池创建时间

最小长度：0

最大长度：64

updated_at

String
  • 功能说明：公网IP池更新时间

最小长度：0

最大长度：64

billing_info

BillingInfoDict object

订单信息, 有订单表示包周期

public_border_group

String
  • 功能说明：中心还是边缘。公网IP池取值为center

最小长度：0

最大长度：64

shared

Boolean
  • 功能说明：是否共享

is_common

Boolean
  • 功能说明：是否公共池

tags

Array of TagsInfo objects
  • 功能说明：用户标签。（默认不显示）

enterprise_project_id

String
  • 功能说明：企业项目ID。最大长度36字节,带“-”连字符的UUID格式,或者是字符串“0”。创建弹性公网IP时,给弹性公网IP绑定企业项目ID。

最小长度：0

最大长度：36

allow_share_bandwidth_types

Array of strings
  • 功能说明：表示此publicip可以加入的共享带宽类型列表，如果为空列表，则表示该 publicip不能加入任何共享带宽
  • 约束：publicip只能加入到有该带宽类型的共享带宽中

最大长度：64
表5 BillingInfoDict

参数

参数类型

描述

order_id

String
  • 功能说明：订单信息

最小长度：0

最大长度：64

product_id

String
  • 功能说明：产品id

最小长度：0

最大长度：64
表6 TagsInfo

参数

参数类型

描述

key

String
  • 功能说明：键。同一资源的key值不能重复。

最小长度：0

最大长度：64

value

String
  • 功能说明：值列表。

最小长度：0

最大长度：256
表7 PageInfoOption

参数

参数类型

描述

previous_marker

String

翻页时，作为前一页的marker取值

最小长度：0

最大长度：36

next_marker

String

翻页时，作为后一页的marker取值

最小长度：0

最大长度：36

current_count

Integer

当前页的数据总数

最小值：0

最大值：99999

请求示例

无

响应示例

状态码： 200

Get操作正常返回

{
  "publicip_pools" : [ {
    "id" : "f588ccfa-8750-4d7c-bf5d-2ede24414706",
    "name" : "test_pool_xxx",
    "status" : "active",
    "shared" : true,
    "is_common" : false,
    "enterprise_project_id" : 0,
    "type" : "spec_bgp",
    "project_id" : "8b7e35ad379141fc9df3e178bd64f55c",
    "size" : 100,
    "used" : 20,
    "billing_info" : {
      "order_id" : "CS20081917179HW3H",
      "product_id" : "00301-335034-0--0"
    },
    "created_at" : "2020-07-17T09:25:53Z",
    "updated_at" : "2020-07-17T09:25:53Z",
    "description" : "test",
    "public_border_group" : "center",
    "allow_share_bandwidth_types" : [ "share" ]
  } ],
  "request_id" : "4a06c169-cc67-4d94-a786-2d70ef09b100",
  "page_info" : {
    "previous_marker" : "f588ccfa-8750-4d7c-bf5d-2ede24414706",
    "current_count" : 1
  }
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 公共池