# 更新公网IP池详情 - UpdatePublicipPool #### 功能介绍 更新公网IP池详情。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/EIP/doc?api=UpdatePublicipPool&version=v3)中调试该接口，支持自动认证鉴权。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-eip/eip_apipermission_0000.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI PUT /v3/{project_id}/eip/publicip-pools/{publicip_pool_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | - 参数解释：项目ID。[请参见获取项目ID](https://support.huaweicloud.com/api-eip/eip_api06_0004.html) - 取值范围：不涉及 最大长度：**32** | | publicip_pool_id | 是 | String | 公网ip池唯一标识。 | #### 请求参数 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | publicip_pool | 否 | [UpdatePublicipPoolDict] object | 公网IP池的对象 | 表3UpdatePublicipPoolDict | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 否 | String | - 功能说明：公网IP池ID | | name | 否 | String | - 功能说明：公网IP池名字 | | type | 否 | String | - 功能说明：类型 - 取值范围： - spec_bgp：专属离散动态 - spec_sbgp：专属离散静态 | | description | 否 | String | - 功能说明：描述 | | project_id | 否 | String | - 参数解释：项目ID。[请参见获取项目ID](https://support.huaweicloud.com/api-eip/eip_api06_0004.html) - 取值范围：不涉及 | | used | 否 | Integer | - 功能说明：已经使用的IP数量 | | created_at | 否 | String | - 功能说明：公网IP池创建时间 | | updated_at | 否 | String | - 功能说明：公网IP池更新时间 | | 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** | 表4TagsInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | key | 否 | String | - 功能说明：标签名称 - 约束与限制： - 不能为空。 - 长度不超过128个字符。 - 由英文字母、数字、下划线、中划线、中文字符组成 - 同一资源的key值不能重复。 最大长度：**128** | | value | 否 | String | - 功能说明：标签值 - 约束与限制： - 长度不超过255个字符。 - 由英文字母、数字、下划线、中划线、中文字符组成 最大长度：**255** | #### 响应参数 **状态码：200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | publicip_pool | [PublicipPoolShowResp] object | 公网IP池详情 | | request_id | String | 本次请求的编号 | 表6PublicipPoolShowResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | - 参数解释：项目ID。[请参见获取项目ID](https://support.huaweicloud.com/api-eip/eip_api06_0004.html) - 取值范围：不涉及 | | 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** | 表7BillingInfoDict | 参数 | 参数类型 | 描述 | |:---|:---|:---| | order_id | String | - 功能说明：订单信息 | | product_id | String | - 功能说明：产品id | 表8TagsInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | - 功能说明：标签名称 - 约束与限制： - 不能为空。 - 长度不超过128个字符。 - 由英文字母、数字、下划线、中划线、中文字符组成 - 同一资源的key值不能重复。 最大长度：**128** | | value | String | - 功能说明：标签值 - 约束与限制： - 长度不超过255个字符。 - 由英文字母、数字、下划线、中划线、中文字符组成 最大长度：**255** | #### 请求示例 ``` { "publicip_pool" : { "id" : "f588ccfa-8750-4d7c-bf5d-2ede24414706", "name" : "test_pool_1", "description" : "test1" } } ``` #### 响应示例 **状态码：200** - ``` { "publicip_pool" : { "id" : "f588ccfa-8750-4d7c-bf5d-2ede24414706", "name" : "test_pool_xxx", "status" : "active", "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" ] }, "request_id" : "4a06c169-cc67-4d94-a786-2d70ef09b100" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 更新操作正常返回 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-eip/ErrorCode.html)。