更新弹性公网IP - UpdatePublicips
功能介绍
更新弹性公网IP
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
eip:publicIps:update
Write
publicip *
-
g:EnterpriseProjectId
-
g:ResourceTag/<tag-key>
- vpc:publicIps:update
-
-
URI
PUT /v3/{project_id}/eip/publicips/{publicip_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID,获取项目ID请参见获取项目ID 最大长度:32 |
|
publicip_id |
是 |
String |
弹性公网IP的ID 最小长度:36 最大长度:36 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
publicip |
是 |
UpdatePublicipOption object |
弹性公网IP对象 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
alias |
否 |
String |
最小长度:0 最大长度:64 |
|
description |
否 |
String |
最小长度:0 最大长度:255 |
|
associate_instance_type |
否 |
String |
最小长度:0 最大长度:36 |
|
associate_instance_id |
否 |
String |
最小长度:0 最大长度:36 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
request_id |
String |
本次请求的编号 |
|
publicip |
PublicipUpdateResp object |
更新弹性公网IP的返回对象 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
|
|
project_id |
String |
|
|
ip_version |
Integer |
|
|
public_ip_address |
String |
|
|
public_ipv6_address |
String |
|
|
status |
String |
|
|
description |
String |
|
|
public_border_group |
String |
|
|
created_at |
String |
|
|
updated_at |
String |
|
|
type |
String |
功能说明:弹性公网IP类型 |
|
vnic |
VnicInfo object |
|
|
bandwidth |
PublicipBandwidthInfo object |
功能说明:公网IP绑定带宽信息 |
|
enterprise_project_id |
String |
功能说明:企业项目ID。最大长度36字节,带“-”连字符的UUID格式,或者是字符串“0”。创建弹性公网IP时,给弹性公网IP绑定企业项目ID |
|
billing_info |
String |
|
|
lock_status |
String |
|
|
associate_instance_type |
String |
|
|
associate_instance_id |
String |
功能说明:公网IP绑定的实例ID |
|
publicip_pool_id |
String |
功能说明:公网IP所属网络的ID。publicip_pool_name对应的网络ID |
|
publicip_pool_name |
String |
|
|
alias |
String |
|
|
associate_mode |
String |
|
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
private_ip_address |
String |
|
|
device_id |
String |
|
|
device_owner |
String |
|
|
vpc_id |
String |
|
|
port_id |
String |
|
|
port_profile |
String |
|
|
mac |
String |
|
|
vtep |
String |
|
|
vni |
String |
|
|
instance_id |
String |
|
|
instance_type |
String |
|
|
port_vif_details |
String |
|
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
|
|
size |
Integer |
|
|
share_type |
String |
|
|
charge_mode |
String |
|
|
name |
String |
|
|
billing_info |
String |
|
请求示例
-
更新弹性公网IP别名及描述示例
{ "publicip" : { "alias" : "abcd", "description" : "test!!!!" } } -
弹性公网IP解绑实例请求示例
{ "publicip" : { "associate_instance_type" : null, "associate_instance_id" : null } }
响应示例
状态码:200
PUT操作正常返回
{
"publicip" : {
"alias" : "abcd",
"associate_instance_id" : null,
"associate_instance_type" : null,
"bandwidth" : {
"billing_info" : "xxxx:xxxx:xxxx",
"charge_mode" : "bandwidth",
"id" : "80549ae1-cf7a-4f39-a45f-bdb8e194a1f4",
"name" : "bandwidth-bd25-test",
"share_type" : "WHOLE",
"size" : 7
},
"billing_info" : null,
"created_at" : "2020-06-18T14:05:32Z",
"description" : "test!!!!",
"enterprise_project_id" : "0",
"public_border_group" : "center",
"id" : "b0c42aa6-3d1d-4b39-9188-35ee6aa8d6f7",
"ip_version" : 4,
"lock_status" : null,
"project_id" : "060576782980d5762f9ec014dd2f1148",
"public_ip_address" : "xx.xx.xx.xx",
"public_ipv6_address" : null,
"publicip_pool_id" : "160576782980d5762f9ec014dd2f1148",
"publicip_pool_name" : "5_mobile",
"status" : "DOWN",
"type" : "弹性公网IP",
"updated_at" : "2020-06-18T14:05:32Z",
"vnic" : null
},
"request_id" : "ead9f912bd1191e3d5f0037141098d91"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
PUT操作正常返回 |
错误码
请参见错误码。