华为云用户手册

状态码 状态码 描述 200 GET操作正常返回 400 服务器未能处理请求 401 被请求的页面需要用户名和密码 403 对被请求页面的访问被禁止 404 服务器无法找到被请求的页面 405 请求中指定的方法不被允许 406 服务器生成的响应无法被客户端所接受 407 用户必须首先使用代理服务器进行验证，这样请求才会被处理 408 请求超出了服务器的等待时间 409 由于冲突，请求无法被完成 500 请求未完成。服务异常 501 请求未完成。服务器不支持所请求的功能 502 请求未完成。服务器从上游服务器收到一个无效的响应 503 请求未完成。系统暂时异常 504 网关超时

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 tags Array of TagResp objects 标签列表 表3 TagResp 参数 参数类型 描述 key String 键 不能为空。 长度不超过36个字符。 由英文字母、数字、下划线、中划线、中文字符组成 同一资源的key值不能重复。 最大长度：127 values Array of strings 值列表 长度不超过43个字符。 由英文字母、数字、下划线、中划线、中文字符组成 最大长度：43 状态码： 400 表4 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 401 表5 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 403 表6 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 404 表7 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 405 表8 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 406 表9 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 407 表10 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 408 表11 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 409 表12 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 500 表13 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 501 表14 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 502 表15 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 503 表16 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 504 表17 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36

状态码 状态码 描述 204 DELETE操作正常返回 400 服务器未能处理请求 401 被请求的页面需要用户名和密码 403 对被请求页面的访问被禁止 404 服务器无法找到被请求的页面 405 请求中指定的方法不被允许 406 服务器生成的响应无法被客户端所接受 407 用户必须首先使用代理服务器进行验证，这样请求才会被处理 408 请求超出了服务器的等待时间 409 由于冲突，请求无法被完成 500 请求未完成。服务异常 501 请求未完成。服务器不支持所请求的功能 502 请求未完成。服务器从上游服务器收到一个无效的响应 503 请求未完成。系统暂时异常 504 网关超时

响应参数 状态码： 400 表2 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 401 表3 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 403 表4 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 404 表5 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 405 表6 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 406 表7 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 407 表8 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 408 表9 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 409 表10 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 500 表11 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 501 表12 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 502 表13 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 503 表14 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 504 表15 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36

状态码 状态码 描述 204 DELETE操作正常返回 400 服务器未能处理请求 401 被请求的页面需要用户名和密码 403 对被请求页面的访问被禁止 404 服务器无法找到被请求的页面 405 请求中指定的方法不被允许 406 服务器生成的响应无法被客户端所接受 407 用户必须首先使用代理服务器进行验证，这样请求才会被处理 408 请求超出了服务器的等待时间 409 由于冲突，请求无法被完成 500 请求未完成。服务异常 501 请求未完成。服务器不支持所请求的功能 502 请求未完成。服务器从上游服务器收到一个无效的响应 503 请求未完成。系统暂时异常 504 网关超时

响应参数 状态码： 400 表2 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 401 表3 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 403 表4 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 404 表5 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 405 表6 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 406 表7 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 407 表8 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 408 表9 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 409 表10 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 500 表11 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 501 表12 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 502 表13 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 503 表14 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 504 表15 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36

响应示例 状态码： 200 GET操作正常返回 { "publicips" : [ { "tenant_id" : "8b7e35ad379141fc9df3e178bd64f55c", "bandwidth_name" : "bandwidth-test", "public_ip_address" : "161.xx.xx.9", "create_time" : "2015-07-16 04:22:32", "profile" : { "user_id" : "35f2b308f5d64441a6fa7999fbcd4321", "product_id" : "00301-48027-0--0", "region_id" : "xxx", "order_id" : "xxxxxxxxx" }, "type" : "5_bgp", "bandwidth_id" : "3fa5b383-5a73-4dcb-a314-c6128546d855", "bandwidth_size" : 5, "enterprise_project_id" : "b261ac1f-2489-4bc7-b31b-c33c3346a439", "ip_version" : 4, "private_ip_address" : "192.168.10.5", "bandwidth_share_type" : "PER", "id" : "6285e7be-fd9f-497c-bc2d-dd0bdea6efe0", "status" : "ACTIVE", "port_id" : "4977b983-cd4f-4ecc-93a1-cb52d848a9b3", "public_border_group" : "center", "allow_share_bandwidth_types" : [ "share" ] }, { "tenant_id" : "8b7e35ad379141fc9df3e178bd64f55c", "bandwidth_name" : "bandwidth-test1", "public_ip_address" : "161.xx.xx.10", "create_time" : "2015-07-16 04:23:03", "profile" : { }, "type" : "5_bgp", "bandwidth_id" : "a79fd11a-047b-4f5b-8f12-99c178cc780a", "bandwidth_size" : 5, "enterprise_project_id" : "0", "ip_version" : 4, "bandwidth_share_type" : "PER", "id" : "80d5b82e-43b9-4f82-809a-37bec5793bd4", "status" : "DOWN", "public_border_group" : "center", "allow_share_bandwidth_types" : [ "share" ] } ]}

状态码 状态码 描述 200 GET操作正常返回 400 服务器未能处理请求 401 被请求的页面需要用户名和密码 403 对被请求页面的访问被禁止 404 服务器无法找到被请求的页面 405 请求中指定的方法不被允许 406 服务器生成的响应无法被客户端所接受 407 用户必须首先使用代理服务器进行验证，这样请求才会被处理 408 请求超出了服务器的等待时间 409 由于冲突，请求无法被完成 500 请求未完成。服务异常 501 请求未完成。服务器不支持所请求的功能 502 请求未完成。服务器从上游服务器收到一个无效的响应 503 请求未完成。系统暂时异常 504 网关超时

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 publicips Array of PublicipShowResp objects 弹性公网IP对象 表4 PublicipShowResp 参数 参数类型 描述 bandwidth_id String 功能说明：EIP对应带宽ID 最大长度：36 bandwidth_name String 功能说明：带宽名称 最小长度：1 最大长度：64 bandwidth_share_type String 功能说明：表示共享带宽或者独享带宽 取值范围： WHOLE：共享带宽 PER：独享带宽 约束：其中IPv6暂不支持WHOLE类型带宽。 枚举值： WHOLE PER bandwidth_size Integer 功能说明：带宽大小，单位为Mbit/s。 最小值：0 create_time String 功能说明：EIP申请时间（UTC） enterprise_project_id String 企业项目ID。最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。 创建弹性公网IP时，给弹性公网IP绑定企业项目ID。 不指定该参数时，默认值是 0 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。 最大长度：36 id String 功能说明：EIP唯一标识 最大长度：36 port_id String 功能说明：端口id。 约束：只有绑定了的EIP查询才会返回该参数 最大长度：36 private_ip_address String 功能说明：绑定弹性公网IP的私有IP地址 约束：只有绑定了的弹性公网IP查询才会返回该参数 profile ProfileResp object 功能说明：额外参数，包括订单id、产品id等信息 约束：如果profile不为空，说明是包周期的EIP public_ip_address String 功能说明：IPv4时是申请到的EIP地址，IPv6时是IPv6地址对应的IPv4地址 最大长度：15 status String 功能说明：弹性公网IP的状态 取值范围 FREEZED：冻结 BIND_ERROR：绑定失败 BINDING：绑定中 PENDING_DELETE：释放中 PENDING_CREATE：创建中 NOTIFYING：创建中 NOTIFY_DELETE：释放中 PENDING_UPDATE：更新中 DOWN：未绑定 ACTIVE：绑定 ELB：绑定ELB VPN：绑定VPN ERROR：失败 枚举值： FREEZED BIND_ERROR BINDING PENDING_DELETE PENDING_CREATE NOTIFYING NOTIFY_DELETE PENDING_UPDATE DOWN ACTIVE ELB VPN ERROR tenant_id String 功能说明：项目ID 最大长度：36 type String 功能说明：EIP的类型 取值范围：5_bgp（全动态BGP），5_sbgp（静态BGP），5_youxuanbgp（优选BGP） 华南-广州：5_bgp、5_sbgp 华东-上海一：5_bgp、5_sbgp 华东-上海二：5_bgp、5_sbgp 华北-北京一：5_bgp、5_sbgp 中国-香港：5_bgp、5_youxuanbgp 亚太-曼谷：5_bgp 亚太-新加坡：5_bgp 非洲-约翰内斯堡：5_bgp 西南-贵阳一：5_sbgp 华北-北京四：5_bgp、5_sbgp 拉美-圣地亚哥：5_bgp 拉美-圣保罗一：5_bgp 拉美-墨西哥城一：5_bgp 拉美-布宜诺斯艾利一：5_bgp 拉美-利马一：5_bgp 拉美-圣地亚哥二： 5_bgp 约束： 必须是系统具体支持的类型。 publicip_id为IPv4端口，所以"type"字段未给定时，默认为5_bgp。 最大长度：36 public_ipv6_address String 功能说明：IPv4时无此字段，IPv6时为申请到的EIP地址 最大长度：39 ip_version Integer 功能说明：IP版本信息 取值范围是4和6 4：IPv4 6：IPv6 枚举值： 4 6 public_border_group String 功能说明：表示中心站点资源或者边缘站点资源,对接了边缘站点的区域才会返回该字段 取值范围： center、边缘站点名称 约束：publicip只能绑定该字段相同的资源 最小长度：1 最大长度：64 allow_share_bandwidth_types Array of strings 功能说明：表示此publicip可以加入的共享带宽类型列表，如果列表为空，则表示该publicip不能加入任何共享带宽 约束：publicip只能加入到有该带宽类型的共享带宽中 最大长度：64 alias String 功能说明：弹性公网IP名称 取值范围：1-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点） 最大长度：64 表5 ProfileResp 参数 参数类型 描述 order_id String 订单的id 最大长度：36 product_id String 产品的id 最大长度：36 region_id String region的id 最大长度：36 user_id String 用户的id 最大长度：36 状态码： 400 表6 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 401 表7 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 403 表8 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 404 表9 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 405 表10 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 406 表11 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 407 表12 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 408 表13 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 409 表14 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 500 表15 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 501 表16 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 502 表17 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 503 表18 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 504 表19 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36

URI GET /v1/{project_id}/publicips 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取项目ID请参见获取项目ID 表2 Query参数 参数 是否必选 参数类型 描述 marker 否 String 功能说明：取值为上一页数据的最后一条记录的id，为空时为查询第一页 最大长度：36 limit 否 Integer 功能说明：每页返回的个数 取值范围：0~intmax 最小值：0 ip_version 否 Integer 功能说明：IP地址版本信息，4：IPv4，6：IPv6 枚举值： 4 6 enterprise_project_id 否 String 功能说明：企业项目ID。可以使用该字段过滤某个企业项目下的EIP。 取值范围：最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。“0”表示默认企业项目。若需要查询当前用户所有企业项目绑定的弹性公网IP，请传参all_granted_eps。 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。 port_id 否 Array 功能说明：绑定弹性公网IP的端口id public_ip_address 否 Array 功能说明：IPv4时是申请到的弹性公网IP地址，IPv6时是IPv6地址对应的IPv4地址 private_ip_address 否 Array 功能说明：关联端口的私有IP地址 id 否 Array 功能说明：弹性公网IP唯一标识 allow_share_bandwidth_type_any 否 Array 功能说明：共享带宽类型，根据任一共享带宽类型过滤EIP列表。可以指定多个带宽类型，不同的带宽类型间用逗号分隔。

状态码 状态码 描述 200 GET和PUT操作正常返回 400 服务器未能处理请求 401 被请求的页面需要用户名和密码 403 对被请求页面的访问被禁止 404 服务器无法找到被请求的页面 405 请求中指定的方法不被允许 406 服务器生成的响应无法被客户端所接受 407 用户必须首先使用代理服务器进行验证，这样请求才会被处理 408 请求超出了服务器的等待时间 409 由于冲突，请求无法被完成 500 请求未完成。服务异常 501 请求未完成。服务器不支持所请求的功能 502 请求未完成。服务器从上游服务器收到一个无效的响应 503 请求未完成。系统暂时异常 504 网关超时

响应示例 状态码： 200 GET和PUT操作正常返回 { "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" }}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 publicip PublicipUpdateResp object 更新弹性公网IP的返回对象 表5 PublicipUpdateResp 参数 参数类型 描述 bandwidth_id String 功能说明：EIPIP对应带宽ID 最大长度：36 bandwidth_name String 功能说明：带宽名称 最小长度：1 最大长度：64 bandwidth_share_type String 功能说明：EIP的带宽类型 取值范围：PER，WHOLE。 WHOLE表示共享带宽 PER表示独享带宽 约束：其中IPv6暂不支持WHOLE类型带宽。 枚举值： WHOLE PER bandwidth_size Integer 功能说明：带宽大小，单位为Mbit/s。 最小值：0 create_time String 功能说明：EIP申请时间（UTC） enterprise_project_id String 企业项目ID。最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。 创建弹性公网IP时，给弹性公网IP绑定企业项目ID。 不指定该参数时，默认值是 0 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。 最大长度：36 id String 功能说明：EIP唯一标识 最大长度：36 port_id String 功能说明：端口id。 约束：只有绑定了的EIP查询才会返回该参数 最大长度：36 private_ip_address String 功能说明：绑定EIP的私有IP地址 约束：只有绑定了的EIP查询才会返回该参数 profile ProfileResp object 功能说明：额外参数，包括订单id、产品id等信息 约束：如果profile不为空，说明是包周期的EIP public_ip_address String 功能说明：IPv4时是申请到的EIP地址，IPv6时是IPv6地址对应的IPv4地址 最大长度：15 status String 功能说明：EIP的状态 取值范围： FREEZED：冻结 BIND_ERROR：绑定失败 BINDING：绑定中 PENDING_DELETE：释放中 PENDING_CREATE：创建中 NOTIFYING：创建中 NOTIFY_DELETE：释放中 PENDING_UPDATE：更新中 DOWN：未绑定 ACTIVE：绑定 ELB：绑定ELB VPN：绑定VPN ERROR：失败 枚举值： FREEZED BIND_ERROR BINDING PENDING_DELETE PENDING_CREATE NOTIFYING NOTIFY_DELETE PENDING_UPDATE DOWN ACTIVE ELB VPN ERROR tenant_id String 功能说明：项目ID 最大长度：36 type String 功能说明：EIP的类型 取值范围：5_bgp（全动态BGP），5_sbgp（静态BGP），5_youxuanbgp（优选BGP） 华南-广州：5_bgp、5_sbgp 华东-上海一：5_bgp、5_sbgp 华东-上海二：5_bgp、5_sbgp 华北-北京一：5_bgp、5_sbgp 中国-香港：5_bgp、5_youxuanbgp 亚太-曼谷：5_bgp 亚太-新加坡：5_bgp 非洲-约翰内斯堡：5_bgp 西南-贵阳一：5_sbgp 华北-北京四：5_bgp、5_sbgp 拉美-圣地亚哥：5_bgp 拉美-圣保罗一：5_bgp 拉美-墨西哥城一：5_bgp 拉美-布宜诺斯艾利一：5_bgp 拉美-利马一：5_bgp 拉美-圣地亚哥二： 5_bgp 约束： 必须是系统具体支持的类型。 publicip_id为IPv4端口，所以"type"字段未给定时，默认为5_bgp。 最大长度：36 public_ipv6_address String 功能说明：IPv4时无此字段，IPv6时为申请到的EIP地址 最大长度：39 ip_version Integer 功能说明：IP版本信息 取值范围是4和6 4：IPv4 6：IPv6 枚举值： 4 6 alias String 功能说明：弹性公网IP名称 取值范围：1-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点） 最大长度：64 表6 ProfileResp 参数 参数类型 描述 order_id String 订单的id 最大长度：36 product_id String 产品的id 最大长度：36 region_id String region的id 最大长度：36 user_id String 用户的id 最大长度：36 状态码： 400 表7 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 401 表8 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 403 表9 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 404 表10 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 405 表11 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 406 表12 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 407 表13 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 408 表14 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 409 表15 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 500 表16 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 501 表17 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 502 表18 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 503 表19 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 504 表20 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 publicip 是 UpdatePublicipOption object EIP对象 表3 UpdatePublicipOption 参数 是否必选 参数类型 描述 port_id 否 String 功能说明：端口id 约束： 必须是存在的端口id，如果不带该参数或者值为空时为解除绑定EIP，如果该端口不存在或端口已绑定EIP则会提示出错。 和ip_version字段互斥，不能同时更新。 如果alias和port_id都携带，只有alias生效。 最大长度：36 ip_version 否 Integer 功能说明：IP版本信息 取值范围：4和6 4：IPv4 6：IPv6 约束： 必须是系统支持的IP版本类型 和port_id互斥，不能同时更新。 枚举值： 4 6 alias 否 String 功能说明：弹性公网IP名称 取值范围：1-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点） 约束：如果alias和port_id都携带，只有alias生效。 最大长度：64

状态码 状态码 描述 200 POST操作正常返回 400 服务器未能处理请求 401 被请求的页面需要用户名和密码 403 对被请求页面的访问被禁止 404 服务器无法找到被请求的页面 405 请求中指定的方法不被允许 406 服务器生成的响应无法被客户端所接受 407 用户必须首先使用代理服务器进行验证，这样请求才会被处理 408 请求超出了服务器的等待时间 409 由于冲突，请求无法被完成 500 请求未完成。服务异常 501 请求未完成。服务器不支持所请求的功能 502 请求未完成。服务器从上游服务器收到一个无效的响应 503 请求未完成。系统暂时异常 504 网关超时

状态码 状态码 描述 200 GET和PUT操作正常返回 400 服务器未能处理请求 401 被请求的页面需要用户名和密码 403 对被请求页面的访问被禁止 404 服务器无法找到被请求的页面 405 请求中指定的方法不被允许 406 服务器生成的响应无法被客户端所接受 407 用户必须首先使用代理服务器进行验证，这样请求才会被处理 408 请求超出了服务器的等待时间 409 由于冲突，请求无法被完成 500 请求未完成。服务异常 501 请求未完成。服务器不支持所请求的功能 502 请求未完成。服务器从上游服务器收到一个无效的响应 503 请求未完成。系统暂时异常 504 网关超时

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 bandwidth BandwidthResp object 带宽对象（按需场景和包周期只更新name时，返回该对象） order_id String 订单号（包周期场景返回该字段） 最大长度：36 表6 BandwidthResp 参数 参数类型 描述 bandwidth_type String 功能说明：带宽类型，共享带宽默认为share。 取值范围：share，bgp，sbgp等。 share：共享带宽 bgp：动态bgp sbgp：静态bgp 最小长度：1 最大长度：36 billing_info String 功能说明：账单信息，如果billinginfo不为空，说明是包周期的带宽 最小长度：0 最大长度：255 charge_mode String 功能说明：按流量计费,按带宽计费还是按增强型95计费。 取值范围：bandwidth（按带宽计费），traffic（按流量计费），95peak_plus（按增强型95计费），不返回或者为空时表示是bandwidth。 约束：只有共享带宽支持95peak_plus（按增强型95计费），按增强型95计费时需要指定保底百分比，默认是20%。 枚举值： bandwidth traffic 95peak_plus id String 功能说明：带宽唯一标识 最大长度：36 name String 功能说明：带宽名称 取值范围：1-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点） 最小长度：1 最大长度：64 publicip_info Array of PublicipInfoResp objects 功能说明：带宽对应的弹性公网IP信息 约束：WHOLE类型的带宽支持多个EIP，PER类型的带宽只能对应一个EIP share_type String 功能说明：共享带宽类型，标识是否是共享带宽 取值范围：PER，WHOLE（PER为独占带宽，WHOLE是共享带宽）。 枚举值： WHOLE PER size Integer 功能说明：带宽大小 取值范围：默认1Mbit/s~2000Mbit/s（具体范围以各区域配置为准，请参见控制台对应页面显示）。 tenant_id String 功能说明：用户所属租户ID 最大长度：36 enterprise_project_id String 企业项目ID。最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。 创建弹性公网IP时，给弹性公网IP绑定企业项目ID。 不指定该参数时，默认值是 0 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。 最大长度：36 status String 功能说明：带宽的状态 取值范围： FREEZED：冻结 NORMAL：正常 枚举值： FREEZED NORMAL enable_bandwidth_rules Boolean 功能说明：是否开启企业级qos 取值范围：true/false，该字段仅在上海1局点返回 rule_quota Integer 功能说明：带宽支持的最大分组规则数。（该字段仅在上海1局点返回） 最小值：0 最大值：1024 bandwidth_rules Array of BandWidthRules objects 功能说明：带宽规则对象（该字段仅在上海1局点返回） created_at String 功能说明：资源创建时间，UTC时间 格式： yyyy-MM-ddTHH:mm:ss updated_at String 功能说明：资源更新时间，UTC时间 格式： yyyy-MM-ddTHH:mm:ss public_border_group String 功能说明：表示中心站点资源或者边缘站点资源 取值范围： center、边缘站点名称 约束：共享带宽只能绑定与该字段相同的publicip 最小长度：1 最大长度：64 表7 BandWidthRules 参数 参数类型 描述 id String 功能说明：带宽规则ID 最大长度：36 name String 功能说明：带宽规则名称 最小长度：0 最大长度：64 admin_state_up Boolean 功能说明：配置状态，为False时配置不生效。 egress_size Integer 功能说明：出网带宽最大值，单位Mbps 取值范围[0,n]，其中n为所属带宽的带宽大小（size字段）。0表示设置为最大带宽 最小值：0 缺省值：0 egress_guarented_size Integer 功能说明：出网保障带宽大小，单位Mbps 取值范围[0,x]，其中x为所属带宽剩余的保障额 最小值：0 缺省值：0 publicip_info Array of PublicipInfoResp objects 功能说明：带宽对应的弹性公网IP信息 约束：WHOLE类型的带宽支持多个弹性公网IP，PER类型的带宽只能对应一个弹性公网IP 表8 PublicipInfoResp 参数 参数类型 描述 publicip_address String 功能说明：功能说明：EIP或者IPv6端口的地址 最大长度：15 publicip_id String 功能说明：带宽对应的EIP或者IPv6端口的唯一标识 最大长度：36 publicip_type String 功能说明：EIP的类型 取值范围：5_bgp（全动态BGP），5_sbgp（静态BGP），5_youxuanbgp（优选BGP） 华南-广州：5_bgp、5_sbgp 华东-上海一：5_bgp、5_sbgp 华东-上海二：5_bgp、5_sbgp 华北-北京一：5_bgp、5_sbgp 中国-香港：5_bgp、5_youxuanbgp 亚太-曼谷：5_bgp 亚太-新加坡：5_bgp 非洲-约翰内斯堡：5_bgp 西南-贵阳一：5_sbgp 华北-北京四：5_bgp、5_sbgp 拉美-圣地亚哥：5_bgp 拉美-圣保罗一：5_bgp 拉美-墨西哥城一：5_bgp 拉美-布宜诺斯艾利一：5_bgp 拉美-利马一：5_bgp 拉美-圣地亚哥二： 5_bgp 约束： 必须是系统具体支持的类型。 publicip_id为IPv4端口，所以"type"字段未给定时，默认为5_bgp。 最大长度：36 publicipv6_address String 功能说明：IPv4时无此字段，IPv6时为申请到的EIP地址 最大长度：39 ip_version Integer 功能说明：IP版本信息 取值范围： 4：IPv4 6：IPv6 枚举值： 4 6 状态码： 400 表9 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 401 表10 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 403 表11 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 404 表12 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 405 表13 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 406 表14 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 407 表15 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 408 表16 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 409 表17 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 500 表18 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 501 表19 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 502 表20 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 503 表21 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 504 表22 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36

响应示例 状态码： 200 GET和PUT操作正常返回 { "bandwidth" : { "tenant_id" : "8b7e35ad379141fc9df3e178bd64f55c", "size" : 10, "share_type" : "PER", "bandwidth_type" : "bgp", "publicip_info" : [ { "publicip_id" : "6285e7be-fd9f-497c-bc2d-dd0bdea6efe0", "ip_version" : 4, "publicip_type" : "5_bgp", "publicip_address" : "161.xx.xx.9" } ], "name" : "bandwidth123", "id" : "3fa5b383-5a73-4dcb-a314-c6128546d855", "charge_mode" : "bandwidth", "enable_bandwidth_rules" : false, "rule_quota" : 0, "bandwidth_rules" : [ ], "billing_info" : "", "status" : "NORMAL" }, "order_id" : "xxxx"}

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 bandwidth 是 UpdatePrePaidBandwidthOption object 带宽对象 extendParam 否 UpdatePrePaidBandwidthExtendParamOption object 扩展参数，用于包周期资源申请。 表3 UpdatePrePaidBandwidthOption 参数 是否必选 参数类型 描述 name 否 String 功能说明：带宽名称 取值范围：1-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点），为空表示不修改名称 约束：和参数size必须有一个参数有值 最小长度：1 最大长度：64 size 否 Integer 功能说明：带宽大小，包周期的带宽只能改大 取值范围：默认1Mbit/s～2000Mbit/s（具体范围以各区域配置为准，请参见控制台对应页面显示），不带此参数时表示不修改大小。 约束：和参数name必须有一个参数有值。 注意：调整带宽时的最小单位会根据带宽范围不同存在差异。 小于等于300Mbit/s：默认最小单位为1Mbit/s。 300Mbit/s~1000Mbit/s：默认最小单位为50Mbit/s。 大于1000Mbit/s：默认最小单位为500Mbit/s。 表4 UpdatePrePaidBandwidthExtendParamOption 参数 是否必选 参数类型 描述 is_auto_pay 否 Boolean 功能说明：下单订购后，是否自动从客户的账户中支付，而不需要客户手动去进行支付；系统默认是“非自动支付”。 取值范围： true：是（自动支付） false：否（默认值，需要客户手动去支付） 约束：自动支付时，只能使用账户的现金支付；如果要使用代金券，请选择不自动支付，然后在用户费用中心，选择代金券支付。 缺省值：false

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 tags Array of ResourceTagResp objects 标签列表 表3 ResourceTagResp 参数 参数类型 描述 key String 功能说明：标签名称 约束： 不能为空。 长度不超过36个字符。 由英文字母、数字、下划线、中划线、中文字符组成 同一资源的key值不能重复。 最小长度：0 最大长度：36 value String 功能说明：标签值 约束： 长度不超过43个字符。 由英文字母、数字、下划线、中划线、中文字符组成 同一资源的key值不能重复 最小长度：0 最大长度：43 状态码： 400 表4 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 401 表5 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 403 表6 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 404 表7 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 405 表8 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 406 表9 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 407 表10 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 408 表11 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 409 表12 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 500 表13 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 501 表14 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 502 表15 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 503 表16 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 504 表17 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36

状态码 状态码 描述 200 GET操作正常返回 400 服务器未能处理请求 401 被请求的页面需要用户名和密码 403 对被请求页面的访问被禁止 404 服务器无法找到被请求的页面 405 请求中指定的方法不被允许 406 服务器生成的响应无法被客户端所接受 407 用户必须首先使用代理服务器进行验证，这样请求才会被处理 408 请求超出了服务器的等待时间 409 由于冲突，请求无法被完成 500 请求未完成。服务异常 501 请求未完成。服务器不支持所请求的功能 502 请求未完成。服务器从上游服务器收到一个无效的响应 503 请求未完成。系统暂时异常 504 网关超时

状态码 状态码 描述 204 POST操作正常返回 400 服务器未能处理请求 401 被请求的页面需要用户名和密码 403 对被请求页面的访问被禁止 404 服务器无法找到被请求的页面 405 请求中指定的方法不被允许 406 服务器生成的响应无法被客户端所接受 407 用户必须首先使用代理服务器进行验证，这样请求才会被处理 408 请求超出了服务器的等待时间 409 由于冲突，请求无法被完成 500 请求未完成。服务异常 501 请求未完成。服务器不支持所请求的功能 502 请求未完成。服务器从上游服务器收到一个无效的响应 503 请求未完成。系统暂时异常 504 网关超时

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 tag 是 ResourceTagOption object tag对象 表3 ResourceTagOption 参数 是否必选 参数类型 描述 key 是 String 功能说明：标签名称 约束： 不能为空。 长度不超过36个字符。 由英文字母、数字、下划线、中划线、中文字符组成 同一资源的key值不能重复。 最大长度：36 value 是 String 功能说明：标签值 约束： 长度不超过43个字符。 由英文字母、数字、下划线、中划线、中文字符组成 同一资源的key值不能重复。 最大长度：43

响应参数 状态码： 400 表4 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 401 表5 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 403 表6 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 404 表7 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 405 表8 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 406 表9 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 407 表10 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 408 表11 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 409 表12 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 500 表13 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 501 表14 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 502 表15 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 503 表16 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 504 表17 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36

状态码 状态码 描述 200 POST操作正常返回 400 服务器未能处理请求 401 被请求的页面需要用户名和密码 403 对被请求页面的访问被禁止 404 服务器无法找到被请求的页面 405 请求中指定的方法不被允许 406 服务器生成的响应无法被客户端所接受 407 用户必须首先使用代理服务器进行验证，这样请求才会被处理 408 请求超出了服务器的等待时间 409 由于冲突，请求无法被完成 500 请求未完成。服务异常 501 请求未完成。服务器不支持所请求的功能 502 请求未完成。服务器从上游服务器收到一个无效的响应 503 请求未完成。系统暂时异常 504 网关超时

状态码 状态码 描述 200 POST操作正常返回 400 服务器未能处理请求 401 被请求的页面需要用户名和密码 403 对被请求页面的访问被禁止 404 服务器无法找到被请求的页面 405 请求中指定的方法不被允许 406 服务器生成的响应无法被客户端所接受 407 用户必须首先使用代理服务器进行验证，这样请求才会被处理 408 请求超出了服务器的等待时间 409 由于冲突，请求无法被完成 500 请求未完成。服务异常 501 请求未完成。服务器不支持所请求的功能 502 请求未完成。服务器从上游服务器收到一个无效的响应 503 请求未完成。系统暂时异常 504 网关超时

请求示例 将id为d91b0028-6f6b-4478-808a-297b75b6812a、1d184b2c-4ec9-49b5-a3f9-27600a76ba3f的弹性公网IP插入共享带宽，支持多个弹性公网IP插入共享带宽。 { "bandwidth" : { "publicip_info" : [ { "publicip_id" : "d91b0028-6f6b-4478-808a-297b75b6812a", "publicip_type" : "5_dualStack" }, { "publicip_id" : "1d184b2c-4ec9-49b5-a3f9-27600a76ba3f" } ] }}

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 bandwidth BandwidthRespInsert object 带宽对象 表6 BandwidthRespInsert 参数 参数类型 描述 bandwidth_type String 功能说明：带宽类型，共享带宽默认为share。 取值范围：share，bgp，sbgp等。 share：共享带宽 bgp：动态bgp sbgp：静态bgp 最小长度：1 最大长度：36 charge_mode String 功能说明：按流量计费,按带宽计费还是按增强型95计费。 取值范围：bandwidth（按带宽计费），traffic（按流量计费），95peak_plus（按增强型95计费），不返回或者为空时表示是bandwidth。 约束：只有共享带宽支持95peak_plus（按增强型95计费），按增强型95计费时需要指定保底百分比，默认是20%。 枚举值： bandwidth traffic 95peak_plus id String 功能说明：带宽唯一标识 最大长度：36 name String 功能说明：带宽名称 取值范围：1-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点） 最小长度：1 最大长度：64 publicip_info Array of PublicipInfoResp objects 功能说明：带宽对应的弹性公网IP信息 约束：WHOLE类型的带宽支持多个弹性公网IP，PER类型的带宽只能对应一个弹性公网IP billing_info String 功能说明：账单信息，如果billinginfo不为空，说明是包周期的带宽 最小长度：0 最大长度：255 share_type String 功能说明：带宽类型，标识是否是共享带宽 取值范围：WHOLE，PER WHOLE表示共享带宽 PER表示独享带宽 枚举值： WHOLE PER size Integer 功能说明：带宽大小。 取值范围：默认5Mbit/s~2000Mbit/s（具体范围以各区域配置为准，请参见控制台对应页面显示）。 tenant_id String 功能说明：用户所属租户ID 最大长度：36 enterprise_project_id String 企业项目ID。最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。 创建共享带宽时，给共享带宽绑定企业项目ID。 不指定该参数时，默认值是 0 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。 最大长度：36 status String 功能说明：带宽的状态 取值范围： FREEZED：冻结 NORMAL：正常 枚举值： FREEZED NORMAL enable_bandwidth_rules Boolean 功能说明：是否开启企业级qos 取值范围：true/false rule_quota Integer 功能说明：带宽支持的最大分组规则数。 最小值：0 最大值：1024 bandwidth_rules Array of BandWidthRules objects 功能说明：带宽规则对象 表7 BandWidthRules 参数 参数类型 描述 id String 功能说明：带宽规则ID 最大长度：36 name String 功能说明：带宽规则名称 最小长度：0 最大长度：64 admin_state_up Boolean 功能说明：配置状态，为False时配置不生效。 egress_size Integer 功能说明：出网带宽最大值，单位Mbps 取值范围[0,n]，其中n为所属带宽的带宽大小（size字段）。0表示设置为最大带宽 最小值：0 缺省值：0 egress_guarented_size Integer 功能说明：出网保障带宽大小，单位Mbps 取值范围[0,x]，其中x为所属带宽剩余的保障额 最小值：0 缺省值：0 publicip_info Array of PublicipInfoResp objects 功能说明：带宽对应的弹性公网IP信息 约束：WHOLE类型的带宽支持多个弹性公网IP，PER类型的带宽只能对应一个弹性公网IP 表8 PublicipInfoResp 参数 参数类型 描述 publicip_address String 功能说明：功能说明：EIP或者IPv6端口的地址 最大长度：15 publicip_id String 功能说明：带宽对应的EIP或者IPv6端口的唯一标识 最大长度：36 publicip_type String 功能说明：EIP的类型 取值范围：5_bgp（全动态BGP），5_sbgp（静态BGP），5_youxuanbgp（优选BGP） 华南-广州：5_bgp、5_sbgp 华东-上海一：5_bgp、5_sbgp 华东-上海二：5_bgp、5_sbgp 华北-北京一：5_bgp、5_sbgp 中国-香港：5_bgp、5_youxuanbgp 亚太-曼谷：5_bgp 亚太-新加坡：5_bgp 非洲-约翰内斯堡：5_bgp 西南-贵阳一：5_sbgp 华北-北京四：5_bgp、5_sbgp 拉美-圣地亚哥：5_bgp 拉美-圣保罗一：5_bgp 拉美-墨西哥城一：5_bgp 拉美-布宜诺斯艾利一：5_bgp 拉美-利马一：5_bgp 拉美-圣地亚哥二： 5_bgp 约束： 必须是系统具体支持的类型。 publicip_id为IPv4端口，所以"type"字段未给定时，默认为5_bgp。 最大长度：36 publicipv6_address String 功能说明：IPv4时无此字段，IPv6时为申请到的EIP地址 最大长度：39 ip_version Integer 功能说明：IP版本信息 取值范围： 4：IPv4 6：IPv6 枚举值： 4 6 状态码： 400 表9 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 401 表10 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 403 表11 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 404 表12 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 405 表13 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 406 表14 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 407 表15 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 408 表16 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 409 表17 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 500 表18 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 501 表19 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 502 表20 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 503 表21 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 504 表22 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36

响应示例 状态码： 200 POST操作正常返回 { "bandwidth" : { "tenant_id" : "8b7e35ad379141fc9df3e178bd64f55c", "billing_info" : "CS1712121146TSQOJ:0616e2a5dc9f4985ba52ea8c0c7e273c:southchina:35f2b308f5d64441a6fa7999fbcd4321", "size" : 10, "share_type" : "WHOLE", "bandwidth_type" : "share", "publicip_info" : [ { "publicip_id" : "d91b0028-6f6b-4478-808a-297b75b6812a", "ip_version" : 4, "publicip_type" : "5_dualStack", "publicip_address" : "::ffff:192.168.89.9" }, { "publicip_id" : "1d184b2c-4ec9-49b5-a3f9-27600a76ba3f", "ip_version" : 4, "publicip_type" : "5_bgp", "publicip_address" : "99.xx.xx.82" } ], "name" : "bandwidth123", "enable_bandwidth_rules" : false, "rule_quota" : 0, "bandwidth_rules" : [ ], "charge_mode" : "bandwidth", "id" : "3fa5b383-5a73-4dcb-a314-c6128546d855" }}

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 bandwidth 是 AddPublicipsIntoSharedBandwidthOption object 带宽对象 表3 AddPublicipsIntoSharedBandwidthOption 参数 是否必选 参数类型 描述 publicip_info 是 Array of InsertPublicipInfo objects 功能说明：要插入共享带宽的EIP信息或者IPv6端口 约束：WHOLE类型的带宽支持多个EIP或者IPv6端口，跟租户的配额相关，默认一个共享带宽的配额为20 表4 InsertPublicipInfo 参数 是否必选 参数类型 描述 publicip_type 否 String 功能说明：EIP的类型 取值范围：5_bgp（全动态BGP），5_sbgp（静态BGP），5_youxuanbgp（优选BGP） 华南-广州：5_bgp、5_sbgp 华东-上海一：5_bgp、5_sbgp 华东-上海二：5_bgp、5_sbgp 华北-北京一：5_bgp、5_sbgp 中国-香港：5_bgp、5_youxuanbgp 亚太-曼谷：5_bgp 亚太-新加坡：5_bgp 非洲-约翰内斯堡：5_bgp 西南-贵阳一：5_sbgp 华北-北京四：5_bgp、5_sbgp 拉美-圣地亚哥：5_bgp 拉美-圣保罗一：5_bgp 拉美-墨西哥城一：5_bgp 拉美-布宜诺斯艾利一：5_bgp 拉美-利马一：5_bgp 拉美-圣地亚哥二： 5_bgp 约束： 必须是系统具体支持的类型。 publicip_id为IPv4端口，所以"type"字段未给定时，默认为5_bgp。 最大长度：36 publicip_id 是 String 功能说明：带宽对应的EIP或者IPv6端口PORT的唯一标识 最大长度：36