文档首页/ 弹性公网IP EIP/ API参考/ API V3/ 公共池/ 更新公网IP池详情 - UpdatePublicipPool
更新时间：2026-07-22 GMT+08:00
在线调试
CLI示例
查看PDF
分享

更新公网IP池详情 - UpdatePublicipPool

功能介绍

更新公网IP池详情。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

PUT /v3/{project_id}/eip/publicip-pools/{publicip_pool_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

最大长度：32

publicip_pool_id

是

String

公网ip池唯一标识。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

publicip_pool

否

UpdatePublicipPoolDict object

公网IP池的对象
表3 UpdatePublicipPoolDict

参数

是否必选

参数类型

描述

id

否

String

  • 功能说明：公网IP池ID

name

否

String

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

status

否

String

  • 功能说明：状态

type

否

String

  • 功能说明：类型

  • 取值范围：

    • spec_bgp：专属离散动态

    • spec_sbgp：专属离散静态

description

否

String

  • 功能说明：描述

project_id

否

String

size

否

Integer

  • 功能说明：池子大小

used

否

Integer

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

created_at

否

String

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

updated_at

否

String

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

billing_info

否

BillingInfoDict object

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

public_border_group

否

String

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

shared

否

Boolean

  • 功能说明：是否共享

tags

否

Array of TagsInfo objects

  • 功能说明：用户标签。

数组长度：0 - 9999

enterprise_project_id

否

String

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

allow_share_bandwidth_types

否

Array of strings

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

  • 约束与限制：publicip只能加入到有该带宽类型的共享带宽中

最大长度：64

数组长度：0 - 9999
表4 BillingInfoDict

参数

是否必选

参数类型

描述

order_id

是

String

  • 功能说明：订单信息

product_id

是

String

  • 功能说明：产品id
表5 TagsInfo

参数

是否必选

参数类型

描述

key

否

String

  • 功能说明：标签名称

  • 约束与限制：

    • 不能为空。

    • 长度不超过128个字符。

    • 由英文字母、数字、下划线、中划线、中文字符组成

    • 同一资源的key值不能重复。

最大长度：128

value

否

String

  • 功能说明：标签值

  • 约束与限制：

    • 长度不超过255个字符。

    • 由英文字母、数字、下划线、中划线、中文字符组成

最大长度：255

响应参数

状态码：200

表6 响应Body参数

参数

参数类型

描述

publicip_pool

PublicipPoolShowResp object

公网IP池详情

request_id

String

本次请求的编号
表7 PublicipPoolShowResp

参数

参数类型

描述

id

String

  • 功能说明：公网IP池ID

name

String

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

status

String

  • 参数解释：公网IP池状态。

  • 约束限制：不涉及

  • 取值范围：

    • ACTIVE：已上线。

    • INACTIVE:已下线。

    • SOLDOUT：已售罄。

  • 默认取值：不涉及

type

String

  • 功能说明：公网IP池类型。

  • 约束限制：不涉及

  • 取值范围：

    • spec_bgp：专属离散动态

    • spec_sbgp：专属离散静态

  • 默认取值：不涉及

description

String

  • 功能说明：描述

project_id

String

size

Integer

  • 功能说明：池子大小

used

Integer

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

created_at

String

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

updated_at

String

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

billing_info

BillingInfoDict object

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

public_border_group

String

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

shared

Boolean

  • 功能说明：是否共享

tags

Array of TagsInfo objects

  • 功能说明：用户标签。

enterprise_project_id

String

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

allow_share_bandwidth_types

Array of strings

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

  • 约束与限制：publicip只能加入到有该带宽类型的共享带宽中
表8 BillingInfoDict

参数

参数类型

描述

order_id

String

  • 功能说明：订单信息

product_id

String

  • 功能说明：产品id
表9 TagsInfo

参数

参数类型

描述

key

String

  • 功能说明：标签名称

  • 约束与限制：

    • 不能为空。

    • 长度不超过128个字符。

    • 由英文字母、数字、下划线、中划线、中文字符组成

    • 同一资源的key值不能重复。

value

String

  • 功能说明：标签值

  • 约束与限制：

    • 长度不超过255个字符。

    • 由英文字母、数字、下划线、中划线、中文字符组成

请求示例

{
  "publicip_pool" : {
    "id" : "f588ccfa-8750-4d7c-bf5d-2ede24414706",
    "name" : "test_pool_1",
    "description" : "test1"
  }
}

响应示例

状态码：200

更新操作正常返回

  • 示例 1

    {
  "id" : "f588ccfa-8750-4d7c-bf5d-2ede24414706",
  "name" : "test_pool_xxx",
  "status" : "active",
  "network_id" : "f588ccfa-8750-4d7c-bf5d-2ede24414706",
  "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-30T12:39:19Z",
  "description" : "test",
  "public_border_group" : "center",
  "allow_share_bandwidth_types" : [ "share" ],
  "per_bandwidth_type" : "bgp"
}

  • 示例 2

    "4a06c169-cc67-4d94-a786-2d70ef09b100"

状态码

状态码

描述

200

更新操作正常返回

错误码

请参见错误码。

父主题： 公共池

相关文档