更新公网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	项目ID，获取项目ID请参见获取项目ID 最大长度：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	项目ID，获取项目ID请参见获取项目ID
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	功能说明：状态
type	String	功能说明：类型取值范围： spec_bgp：专属离散动态 spec_sbgp：专属离散静态
description	String	功能说明：描述
project_id	String	项目ID，获取项目ID请参见获取项目ID
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

表8 BillingInfoDict
参数	参数类型	描述
order_id	String	功能说明：订单信息
product_id	String	功能说明：产品id

表9 TagsInfo
参数	参数类型	描述
key	String	功能说明：标签名称约束与限制：不能为空。长度不超过128个字符。由英文字母、数字、下划线、中划线、中文字符组成同一资源的key值不能重复。最大长度：128
value	String	功能说明：标签值约束与限制：长度不超过255个字符。由英文字母、数字、下划线、中划线、中文字符组成最大长度：255

请求示例

{
  "bandwidth_rule" : {
    "name" : "bandwidth_rule_2",
    "egress_size" : 10,
    "egress_guarented_size" : 5
  }
}

响应示例

状态码：200

GET和PUT操作正常返回

{
  "bandwidth_rule" : {
    "id" : "c7cf9045-bd79-4195-99ea-7194a20c2e48",
    "name" : "bandwidth_rule_2",
    "bandwidth_id" : "c7cf9045-bd79-4195-99ea-7194a20c2e48",
    "admin_state_up" : true,
    "egress_size" : "10,",
    "egress_guarented_size" : "5,",
    "publicip_info" : [ {
      "publicip_id" : "6285e7be-fd9f-497c-bc2d-dd0bdea6efe0",
      "publicip_address" : "161.x.x.9",
      "publicip_type" : "5_bgp",
      "ip_version" : 4
    } ]
  },
  "request_id" : "4a06c169-cc67-4d94-a786-2d70ef09b100"
}