请求参数
● PER bandwidth_siz
4.1.4 更新 EIP
状态码
状态码 描述
200 GET和PUT操作正常返回 400 服务器未能处理请求
401 被请求的页面需要用户名和密码 403 对被请求页面的访问被禁止 404 服务器无法找到被请求的页面 405 请求中指定的方法不被允许
406 服务器生成的响应无法被客户端所接受
407 用户必须首先使用代理服务器进行验证,这样请求才会被处理 408 请求超出了服务器的等待时间
409 由于冲突,请求无法被完成 500 请求未完成。服务异常
501 请求未完成。服务器不支持所请求的功能
502 请求未完成。服务器从上游服务器收到一个无效的响应 503 请求未完成。系统暂时异常
504 网关超时
错误码
请参见错误码。
4.1.4 更新 EIP
功能介绍
更新EIP,将EIP跟一个网卡绑定或者解绑定,转换IP地址版本类型。
调试
您可以在API Explorer中调试该接口。
URI
PUT /v1/{project_id}/publicips/{publicip_id}
表4-61 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID publicip_id 是 String EIP唯一标识
请求参数
表4-62 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取用户Token接口获取(响应 消息头中X-Subject-Token的 值)
表4-63 请求 Body 参数
参数 是否必选 参数类型 描述
publicip 是 UpdatePublic ipOption object
EIP对象
表4-64 UpdatePublicipOption
参数 是否必选 参数类型 描述
port_id 否 String ● 功能说明:端口id
● 约束:必须是存在的端口 id,如果不带该参数或者值 为空时为解除绑定EIP,如果 该端口不存在或端口已绑定 EIP则会提示出错。和 ip_version字段互斥,不能同 时更新。
参数 是否必选 参数类型 描述
ip_version 否 Integer ● 功能说明:IP版本信息
● 取值范围:4和6 – 4:IPv4 – 6:IPv6
● 约束:
– 必须是系统支持的IP版本 类型
– 和port_id互斥,不能同时 更新。
枚举值:
● 4
● 6
alias 否 String ● 功能说明:弹性公网IP名称
● 取值范围:1-64个字符,支 持数字、字母、中文、_(下 划线)、-(中划线)、.
(点)
响应参数
状态码: 200
表4-65 响应 Body 参数
参数 参数类型 描述
publicip PublicipUpda
teResp object 更新弹性公网IP的返回对象
表4-66 PublicipUpdateResp
参数 参数类型 描述
bandwidth_id String EIPIP对应带宽ID bandwidth_na
me String 带宽名称
参数 参数类型 描述 bandwidth_sh
are_type String ● 功能说明:EIP的带宽类型
● 取值范围:PER,WHOLE。
– WHOLE表示共享带宽 – PER表示独享带宽
● 约束:其中IPv6暂不支持WHOLE类型带宽。
枚举值:
● WHOLE
● PER bandwidth_siz
e Integer 带宽大小,单位为Mbit/s。
create_time String EIP申请时间(UTC)
enterprise_pro
ject_id String ● 企业项目ID。最大长度36字节,带“-”连字 符的UUID格式,或者是字符串“0”。
id String EIP唯一标识
port_id String ● 功能说明:端口id。
● 约束:只有绑定了的EIP查询才会返回该参数 private_ip_ad
dress String ● 功能说明:绑定EIP的私有IP地址
● 约束:只有绑定了的EIP查询才会返回该参数 profile ProfileResp
object 功能说明:额外参数,包括订单id、产品id等信 息 约束:如果profile不为空,说明是包周期的EIP public_ip_add
ress String IPv4时是申请到的EIP地址,IPv6时是IPv6地址对 应的IPv4地址
参数 参数类型 描述
status String ● 功能说明:EIP的状态
● 取值范围:冻结FREEZED,绑定失败 BIND_ERROR,绑定中BINDING,释放中 PENDING_DELETE, 创建中
PENDING_CREATE,创建中NOTIFYING,释 放中NOTIFY_DELETE,更新中
PENDING_UPDATE, 未绑定DOWN ,绑定 ACTIVE,绑定ELB,绑定VPN,失败ERROR。
枚举值:
● FREEZED
● BIND_ERROR
● BINDING
● PENDING_DELETE
● PENDING_CREATE
● NOTIFYING
● NOTIFY_DELETE
● PENDING_UPDATE
● DOWN
● ACTIVE
● ELB
● ERROR
● VPN tenant_id String 项目ID
参数 参数类型 描述
type String ● 功能说明:EIP的类型
● 取值范围:5_telcom(电信),5_union(联 通),5_bgp(全动态BGP),5_sbgp(静态 BGP),5_ipv6
– 华南-广州:5_bgp、5_sbgp – 华东-上海一:5_bgp、5_sbgp – 华东-上海二:5_bgp、5_sbgp
– 华北-北京一:5_bgp、5_sbgp、5_ipv6 – 中国-香港:5_bgp
– 亚太-曼谷:5_bgp – 亚太-新加坡:5_bgp – 非洲-约翰内斯堡:5_bgp – 西南-贵阳一:5_bgp、5_sbgp – 华北-北京四:5_bgp、5_sbgp – 拉美-圣地亚哥:5_bgp
– publicip_id为IPv4端口,所以"type"字段未 给定时,默认为5_bgp。
public_ipv6_a
ddress String IPv4时无此字段,IPv6时为申请到的EIP地址 ip_version Integer IP版本信息,取值范围是4和6 4:表示IPv4 6:表
示IPv6 枚举值:
● 4
● 6
alias String ● 功能说明:弹性公网IP名称
● 取值范围:1-64个字符,支持数字、字母、中 文、_(下划线)、-(中划线)、.(点)
表4-67 ProfileResp
参数 参数类型 描述
order_id String 订单的id product_id String 产品的id region_id String region的id user_id String 用户的id
状态码: 400
表4-68 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码: 401
表4-69 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码: 403
表4-70 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码: 404
表4-71 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码: 405
表4-72 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码: 406
表4-73 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码: 407
表4-74 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码: 408
表4-75 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码: 409
表4-76 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码: 500
表4-77 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码: 501
表4-78 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码: 502
表4-79 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
状态码: 503
表4-80 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述
参数 参数类型 描述
code String 服务异常错误信息编码
状态码: 504
表4-81 响应 Body 参数
参数 参数类型 描述
message String 服务异常错误信息描述 code String 服务异常错误信息编码
请求示例
● {
"publicip" : {
"port_id" : "f588ccfa-8750-4d7c-bf5d-2ede24414706"
}}
{ "application/json-1" : { "publicip" : {
"tenant_id" : "8b7e35ad379141fc9df3e178bd64f55c", "bandwidth_size" : 6,
"public_ip_address" : "161.xx.xx.7", "create_time" : "2015-07-16 04:10:52", "ip_version" : 4,
"port_id" : "f588ccfa-8750-4d7c-bf5d-2ede24414706", "id" : "f588ccfa-8750-4d7c-bf5d-2ede24414706", "type" : "5_bgp",
"status" : "PENDING_UPDATE"
}
}, "application/json-2" : { "publicip" : {
"tenant_id" : "8b7e35ad379141fc9df3e178bd64f55c", "bandwidth_size" : 6,
"public_ip_address" : "161.xx.xx.7",
"public_ipv6_address" : "2a00:xx.xx.xx::x:4833", "create_time" : "2015-07-16 04:10:52", "ip_version" : 6,
"port_id" : "f588ccfa-8750-4d7c-bf5d-2ede24414706", "id" : "f588ccfa-8750-4d7c-bf5d-2ede24414706", "type" : "5_bgp",
"status" : "PENDING_UPDATE"
} }}
状态码
状态码 描述
200 GET和PUT操作正常返回 400 服务器未能处理请求
401 被请求的页面需要用户名和密码 403 对被请求页面的访问被禁止 404 服务器无法找到被请求的页面 405 请求中指定的方法不被允许
406 服务器生成的响应无法被客户端所接受
407 用户必须首先使用代理服务器进行验证,这样请求才会被处理 408 请求超出了服务器的等待时间
409 由于冲突,请求无法被完成 500 请求未完成。服务异常
501 请求未完成。服务器不支持所请求的功能
502 请求未完成。服务器从上游服务器收到一个无效的响应 503 请求未完成。系统暂时异常
504 网关超时
错误码
请参见错误码。