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

查询公共池列表

功能介绍

查询公共池列表

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

  • 功能说明：项目ID

最小长度：0

最大长度：32

表2 Query参数

参数

是否必选

参数类型

描述

fields

否

String

  • 功能说明：查询字段，形式为"fields=id&fields=name&.."
  • 支持字段：id/name/status/type/used/allow_share_bandwidth_types/public_border_group

最小长度：0

最大长度：1024

name

否

String

  • 功能说明：公共池名称

最小长度：0

最大长度：36

public_border_group

否

String

  • 功能说明：公共池位于中心还是边缘

最小长度：0

最大长度：64

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

common_pools

Array of CommonPoolDict objects

功能说明：公共池对象

request_id

String

本次请求的编号

表4 CommonPoolDict

参数

参数类型

描述

name

String

  • 公共池名字

最小长度：0

最大长度：36

status

String

  • 公网池状态

最小长度：0

最大长度：36

type

String

  • 公共池类型，如bgp等

最小长度：0

最大长度：36

used

Integer

  • 已经使用的ip数量

最小值：0

最大值：99999

public_border_group

String

  • 功能说明：表示中心站点资源或者边缘站点资源
  • 取值范围： center、边缘站点名称
  • 约束：publicip只能绑定该字段相同的资源

最小长度：1

最大长度：64

id

String

  • 功能说明：默认不展示，取值, 公共池ID

最小长度：0

最大长度：36

allow_share_bandwidth_types

Array of strings

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

最大长度：64

请求示例

无

响应示例

状态码： 200

Get操作正常返回

{
  "common_pools" : [ {
    "name" : "5_bgp",
    "status" : "active",
    "type" : "bgp",
    "used" : 99,
    "public_border_group" : "center",
    "allow_share_bandwidth_types" : [ "share" ]
  } ],
  "request_id" : "4a06c169-cc67-4d94-a786-2d70ef09b100"
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题：公共池