华为云用户手册

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 share_bandwidth_types Array of ShareBandwidthTypeShowResp objects 共享带宽类型对象 request_id String 本次请求的编号 page_info PageInfoOption object 分页页码信息 表4 ShareBandwidthTypeShowResp 参数 参数类型 描述 id String 支持带宽类型的id 最小长度：0 最大长度：36 bandwidth_type String 带宽类型 最小长度：0 最大长度：36 public_border_group String 中心站点or边缘站点，默认展示 最小长度：0 最大长度：64 created_at String 创建时间 最小长度：0 最大长度：64 updated_at String 更新时间 最小长度：0 最大长度：64 name_en String 带宽类型的英文表述 最小长度：0 最大长度：256 name_zh String 带宽类型的中文表述 最小长度：0 最大长度：256 description String 带宽类型描述信息 最小长度：0 最大长度：1024 表5 PageInfoOption 参数 参数类型 描述 previous_marker String 翻页时，作为前一页的marker取值 最小长度：0 最大长度：36 next_marker String 翻页时，作为后一页的marker取值 最小长度：0 最大长度：36 current_count Integer 当前页的数据总数 最小值：0 最大值：99999 状态码： 400 表6 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 error_msg String 服务异常错误信息描述 最小长度：0 最大长度：1024 error_code String 服务异常错误信息编码 最小长度：0 最大长度：64 状态码： 401 表7 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 error_msg String 服务异常错误信息描述 最小长度：0 最大长度：1024 error_code String 服务异常错误信息编码 最小长度：0 最大长度：64 状态码： 403 表8 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 error_msg String 服务异常错误信息描述 最小长度：0 最大长度：1024 error_code String 服务异常错误信息编码 最小长度：0 最大长度：64 状态码： 404 表9 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 error_msg String 服务异常错误信息描述 最小长度：0 最大长度：1024 error_code String 服务异常错误信息编码 最小长度：0 最大长度：64 状态码： 405 表10 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 error_msg String 服务异常错误信息描述 最小长度：0 最大长度：1024 error_code String 服务异常错误信息编码 最小长度：0 最大长度：64 状态码： 406 表11 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 error_msg String 服务异常错误信息描述 最小长度：0 最大长度：1024 error_code String 服务异常错误信息编码 最小长度：0 最大长度：64 状态码： 407 表12 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 error_msg String 服务异常错误信息描述 最小长度：0 最大长度：1024 error_code String 服务异常错误信息编码 最小长度：0 最大长度：64 状态码： 408 表13 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 error_msg String 服务异常错误信息描述 最小长度：0 最大长度：1024 error_code String 服务异常错误信息编码 最小长度：0 最大长度：64 状态码： 409 表14 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 error_msg String 服务异常错误信息描述 最小长度：0 最大长度：1024 error_code String 服务异常错误信息编码 最小长度：0 最大长度：64 状态码： 500 表15 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 error_msg String 服务异常错误信息描述 最小长度：0 最大长度：1024 error_code String 服务异常错误信息编码 最小长度：0 最大长度：64 状态码： 501 表16 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 error_msg String 服务异常错误信息描述 最小长度：0 最大长度：1024 error_code String 服务异常错误信息编码 最小长度：0 最大长度：64 状态码： 502 表17 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 error_msg String 服务异常错误信息描述 最小长度：0 最大长度：1024 error_code String 服务异常错误信息编码 最小长度：0 最大长度：64 状态码： 503 表18 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 error_msg String 服务异常错误信息描述 最小长度：0 最大长度：1024 error_code String 服务异常错误信息编码 最小长度：0 最大长度：64 状态码： 504 表19 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 error_msg String 服务异常错误信息描述 最小长度：0 最大长度：1024 error_code String 服务异常错误信息编码 最小长度：0 最大长度：64

URI GET /v3/{project_id}/eip/share-bandwidth-types 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 功能说明：项目id 最小长度：0 最大长度：32 表2 Query参数 参数 是否必选 参数类型 描述 fields 否 String 功能说明：查询字段，形式为"fields=id&fields=bandwidth_type&..." 支持字段：id/bandwidth_type/name_en/name_zh/created_at/update_at/public_border_group/description 最小长度：0 最大长度：1024 id 否 String 功能说明：支持带宽类型的id 最小长度：0 最大长度：36 bandwidth_type 否 String 功能说明：带宽支持类型 最小长度：1 最大长度：36 name_en 否 String 功能说明：带宽类型英文表述 最小长度：0 最大长度：256 name_zh 否 String 功能说明：带宽类型中文表述 最小长度：0 最大长度：256 public_border_group 否 String 功能说明：带宽类型所处位置，中心站点or边缘站点 最小长度：0 最大长度：36 sort_key 否 String 功能说明：排序字段，形式为"sort_key=id&sort_dir=asc" 支持字段：id/bandwidth_type/public_border_group 最小长度：0 最大长度：1024 sort_dir 否 String 功能说明：排序方向 取值范围：asc、desc 最小长度：0 最大长度：1024 limit 否 Integer 功能说明：每页返回的个数 取值范围：0~[2000]，其中2000为局点差异项，具体取值由局点决定 最小值：0 最大值：2000

浮动IP（Openstack Neutron API） 权限 对应API接口 授权项(Action) IAM 项目(Project) 企业项目(Enterprise Project) 查询浮动IP列表 GET /v2.0/floatingips vpc:floatingIps:get √ × 查询浮动IP GET /v2.0/floatingips/{floatingip_id} vpc:floatingIps:get √ × 创建浮动IP POST /v2.0/floatingips vpc:floatingIps:create √ × 更新浮动IP PUT /v2.0/floatingips/{floatingip_id} vpc:floatingIps:update √ × 删除浮动IP DELETE /v2.0/floatingips/{floatingip_id} vpc:floatingIps:delete √ × 父主题： 权限策略和授权项

响应参数 状态码： 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 网关超时

响应示例 状态码： 200 GET和PUT操作正常返回 { "quotas" : { "resources" : [ { "type" : "vpc", "used" : 4, "quota" : 150, "min" : 0 }, { "type" : "securityGroup", "used" : 1, "quota" : 400, "min" : 0 }, { "type" : "securityGroupRule", "used" : 6, "quota" : 5000, "min" : 0 }, { "type" : "publicIp", "used" : 2, "quota" : 10, "min" : 0 } ] }}

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

URI GET /v1/{project_id}/quotas 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取项目ID请参见获取项目ID 最小长度：0 最大长度：32 表2 Query参数 参数 是否必选 参数类型 描述 type 否 String 功能说明：根据type过滤查询指定类型的配额 取值范围： vpc subnet securityGroup securityGroupRule publicIp vpn vpcPeer loadbalancer listener physicalConnect virtualInterface firewall shareBandwidthIP shareBandwidth address_group flow_log vpcContainRoutetable routetableContainRoutes 最小长度：0 最大长度：64

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 quotas ResourceResp object 资源配额对象 表4 ResourceResp 参数 参数类型 描述 resources Array of QuotaShowResp objects 资源配额对象 表5 QuotaShowResp 参数 参数类型 描述 type String 功能说明：根据type过滤查询指定类型的配额 取值范围： vpc subnet securityGroup securityGroupRule publicIp vpn vpcPeer loadbalancer listener physicalConnect virtualInterface firewall shareBandwidthIP shareBandwidth address_group flow_log vpcContainRoutetable routetableContainRoutes 最小长度：0 最大长度：36 used Integer 功能说明：已创建的资源个数 取值范围：0~quota数 最小值：0 最大值：999999 quota Integer 功能说明：资源的最大配额数 取值范围：各类型资源默认配额数~Integer最大值 约束：资源的默认配额数可以修改，而且配额需要提前在底层配置 参考默认配置为： vpc默认5 子网默认400 安全组默认100 安全组规则默认5000 EIP默认10 vpn默认5 vpcPeer默认50 loadbalancer默认10 listener默认10 physicalConnect默认10 virtualInterface默认50 firewall默认200 shareBandwidth默认5 shareBandwidthIP默认10 address_group默认10 flow_log默认10 vpcContainRoutetable默认1 routetableContainRoutes默认200 最小值：-1 最大值：999999 min Integer 功能说明：允许修改的配额最小值 最小值：0 最大值：999999 状态码： 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

响应示例 状态码： 200 GET和PUT操作正常返回 { "bandwidth" : { "tenant_id" : "8b7e35ad379141fc9df3e178bd64f55c", "enterprise_project_id" : "0", "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", "charge_mode" : "bandwidth", "enable_bandwidth_rules" : false, "rule_quota" : 0, "bandwidth_rules" : [ ], "id" : "3fa5b383-5a73-4dcb-a314-c6128546d855", "billing_info" : "", "status" : "NORMAL" }}

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 bandwidth BandwidthResp object 带宽对象 表5 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 表6 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 表7 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 表8 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 401 表9 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 403 表10 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 404 表11 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 405 表12 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 406 表13 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 407 表14 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 408 表15 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 409 表16 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 500 表17 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 501 表18 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 502 表19 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 503 表20 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36 状态码： 504 表21 响应Body参数 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 code String 服务异常错误信息编码 最小长度：0 最大长度：36

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 bandwidth 是 UpdateBandwidthOption object 带宽对象 表3 UpdateBandwidthOption 参数 是否必选 参数类型 描述 name 否 String 取值范围：1-64，支持数字、字母、中文、_(下划线)、-（中划线），为空表示不修改名称 功能说明：带宽名称 约束：name、size必须有一个参数有值 最小长度：1 最大长度：64 size 否 Integer 功能说明：带宽大小，单位Mbit/s。 取值范围：默认1Mbit/s~2000Mbit/s（具体范围以各区域配置为准，请参见控制台对应页面显示）。 约束：share_type是PER，该参数必须带，如果share_type是WHOLE并且id有值，该参数会忽略。 注意：调整带宽时的最小单位会根据带宽范围不同存在差异。 小于等于300Mbit/s：默认最小单位为1Mbit/s。 300Mbit/s~1000Mbit/s：默认最小单位为50Mbit/s。 大于1000Mbit/s：默认最小单位为500Mbit/s。 charge_mode 否 String 功能说明：按流量计费,按带宽计费还是按增强型95计费。 取值范围：bandwidth，traffic，95peak_plus（按增强型95计费）不返回或者为空时表示是bandwidth。 约束：只有共享带宽支持95peak_plus（按增强型95计费），按增强型95计费时需要指定保底百分比，默认是20%。 枚举值： bandwidth traffic 95peak_plus

响应示例 状态码： 200 GET和PUT操作正常返回 { "bandwidth" : { "tenant_id" : "8b7e35ad379141fc9df3e178bd64f55c", "enterprise_project_id" : "0", "billing_info" : " CS 1712121146TSQOJ:0616e2a5dc9f4985ba52ea8c0c7e273c:southchina:35f2b308f5d64441a6fa7999fbcd4321", "size" : 5, "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" : "2222", "charge_mode" : "bandwidth", "id" : "3fa5b383-5a73-4dcb-a314-c6128546d855", "enable_bandwidth_rules" : false, "rule_quota" : 0, "bandwidth_rules" : [ ], "status" : "NORMAL", "created_at" : "2020-06-03T09:01:11Z", "updated_at" : "2020-06-03T09:01:11Z" }}

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

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 bandwidth BandwidthResp object 带宽对象 表3 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 表4 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 表5 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 表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

监控指标 表1 弹性公网IP和带宽支持的监控指标 指标ID 指标名称 指标含义 取值范围 测量对象 监控周期（原始指标） upstream_bandwidth 出网带宽 该指标用于统计测试对象出云平台的网络速度（原指标为上行带宽）。 单位：比特/秒 ≥ 0 bit/s 带宽或弹性公网IP 1分钟 downstream_bandwidth 入网带宽 该指标用于统计测试对象入云平台的网络速度（原指标为下行带宽）。 单位：比特/秒 ≥ 0 bit/s 带宽或弹性公网IP 1分钟 upstream_bandwidth_usage 出网带宽使用率 该指标用于统计测量对象出云平台的带宽使用率，以百分比为单位。 0-100% 带宽或弹性公网IP 1分钟 downstream_bandwidth_usage 入网带宽使用率 该指标用于统计测量对象入云平台的带宽使用率，以百分比为单位。 0-100% 带宽或弹性公网IP 1分钟 up_stream 出网流量 该指标用于统计测试对象出云平台一分钟内累积的网络流量平均值（原指标为上行流量）。 单位：字节 ≥ 0 bytes 带宽或弹性公网IP 1分钟 down_stream 入网流量 该指标用于统计测试对象入云平台一分钟内累积的网络流量平均值（原指标为下行流量）。 单位：字节 ≥ 0 bytes 带宽或弹性公网IP 1分钟

概述 欢迎使用弹性公网IP（Elastic IP，EIP）。EIP提供独立的公网IP资源，包括公网IP地址与公网出口带宽服务。可以与弹性云服务器、裸金属服务器、虚拟IP、弹性负载均衡、NAT网关等资源灵活地绑定及解绑。拥有多种灵活的计费方式，可以满足各种业务场景的需要。 您可以使用本文档提供的API对EIP进行相关操作，如创建、查询、删除、更新等。支持的全部操作请参见API概览。 在调用EIP服务的API之前，请确保已经充分了解EIP服务相关概念，详细信息请参见《弹性公网IP用户指南》的“产品介绍”。 父主题： 使用前必读

响应示例 状态码： 200 GET操作正常返回 { "publicip" : { "created_at" : "2022-03-17T09:46:22Z", "updated_at" : "2022-03-30T02:46:04Z", "lock_status" : null, "allow_share_bandwidth_types" : [ "bgp", "sbgp", "share", "share_yidongdanxian", "share_youxuan" ], "id" : "006343a1-32bf-4361-958a-efd158153dd0", "alias" : null, "project_id" : "060576787a80d5762fa2c00f07ddfcf4", "ip_version" : 4, "public_ip_address" : "88.88.1.141", "public_ipv6_address" : null, "status" : "DOWN", "description" : "", "enterprise_project_id" : "0", "billing_info" : null, "type" : "EIP", "vnic" : { "private_ip_address" : "172.16.1.235", "device_id" : "", "device_owner" : "", "vpc_id" : "1c30f428-9741-48b2-a788-0b2f359705eb", "port_id" : "22d3576d-c042-4f3d-8c7c-1330a2724627", "mac" : "fa:16:3e:3a:22:66", "vtep" : null, "vni" : null, "instance_id" : "", "instance_type" : "", "port_profile" : null }, "bandwidth" : { "id" : "149ff19b-5de4-4436-958f-2eca39952e93", "size" : 100, "share_type" : "PER", "charge_mode" : "traffic", "name" : "bandwidth-xym-br-eqos", "billing_info" : "" }, "associate_instance_type" : "PORT", "associate_instance_id" : "22d3576d-c042-4f3d-8c7c-1330a2724627", "publicip_pool_id" : "9af5f2e5-1765-4b86-b342-ece52e785c8b", "publicip_pool_name" : "5_union", "public_border_group" : "center", "tags" : [ "key=value" ] }, "request_id" : "ce1a33a85d2e105040497a21bbe58c26"}

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

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 publicip PublicipSingleShowResp object 功能说明：弹性公网IP对象 表4 PublicipSingleShowResp 参数 参数类型 描述 id String 功能说明：弹性公网IP唯一标识 最小长度：0 最大长度：36 project_id String 功能说明：项目ID 最小长度：0 最大长度：32 ip_version Integer 功能说明：IP版本信息 取值范围： 4：公网IP地址为public_ip_address地址 6：公网IP地址为public_ipv6_address地址 枚举值： 4 6 public_ip_address String 功能说明：弹性公网IP或者IPv6端口的地址 最小长度：0 最大长度：36 public_ipv6_address String 功能说明：IPv4时无此字段，IPv6时为申请到的弹性公网IP地址 最小长度：0 最大长度：64 network_type String 功能说明：弹性公网IP的网络类型。废弃，功能由publicip_pool_name继承，默认不显示 最小长度：0 最大长度：64 status String 功能说明：弹性公网IP的状态 取值范围： FREEZED：冻结 BIND_ERROR：绑定失败 BINDING：绑定中 PENDING_DELETE：释放中 PENDING_CREATE：创建中 NOTIFYING：创建中 NOTIFY_DELETE：释放中 PENDING_UPDATE：更新中 DOWN：未绑定 ACTIVE：绑定 ELB：绑定ELB VPN：绑定VPN ERROR：失败 最小长度：0 最大长度：64 枚举值： FREEZED BIND_ERROR BINDING PENDING_DELETE PENDING_CREATE NOTIFYING NOTIFY_DELETE PENDING_UPDATE DOWN ACTIVE ELB VPN ERROR description String 功能说明：弹性公网IP描述信息 约束：用户以自定义方式标识资源，系统不感知 最小长度：0 最大长度：256 public_border_group String 功能说明：表示中心站点资源或者边缘站点资源 取值范围： center、边缘站点名称 约束：publicip只能绑定该字段相同的资源 最小长度：1 最大长度：64 created_at String 功能说明：资源创建UTC时间 格式：yyyy-MM-ddTHH:mm:ssZ 最小长度：0 最大长度：64 updated_at String 功能说明：资源更新UTC时间 格式：yyyy-MM-ddTHH:mm:ssZ 最小长度：0 最大长度：64 type String 功能说明：弹性公网IP类型 最小长度：1 最大长度：36 枚举值： EIP DUALSTACK vnic VnicInfo object 功能说明：公网IP绑定实例有PORT时，PORT的相关信息 约束：若绑定的实例不依赖PORT，该对象为null bandwidth PublicipBandwidthInfo object 功能说明：公网IP绑定带宽信息 enterprise_project_id String 功能说明：企业项目ID。最大长度36字节,带“-”连字符的UUID格式,或者是字符串“0”。创建弹性公网IP时,给弹性公网IP绑定企业项目ID。 最小长度：0 最大长度：36 billing_info String 功能说明：公网IP的订单信息 约束：包周期才会有订单信息，按需资源此字段为空 最小长度：0 最大长度：256 lock_status String 功能说明：记录公网IP当前的冻结状态 约束：metadata类型，标识欠费冻结、公安冻结 取值范围： police locked 最小长度：0 最大长度：64 associate_instance_type String 功能说明：公网IP绑定的实例类型 取值范围： PORT NATGW ELB ELBV1 VPN null 最小长度：0 最大长度：64 枚举值： PORT NATGW ELB ELBV1 VPN null associate_instance_id String 功能说明：公网IP绑定的实例ID 最小长度：0 最大长度：36 publicip_pool_id String 功能说明：公网IP所属网络的ID，publicip_pool_name对应的网络ID 最小长度：0 最大长度：36 publicip_pool_name String 功能说明：弹性公网IP的网络类型, 包括公共池类型，如5_bgp/5_sbgp...，和用户购买的专属池。 专属池见publcip_pool相关接口 最小长度：0 最大长度：64 alias String 功能说明：弹性公网IP名称 最小长度：0 最大长度：64 profile ProfileInfo object 功能说明：公网IP、元数据。（默认不显示） fake_network_type Boolean 功能说明：该字段仅仅用于表示eip的bgp类型是否是真实的静态sbgp * 1，如果为true，则该eip可以切换bgp类型 * 2； 如果为false，则该eip不可以切换bgp类型。（默认不显示） 枚举值： true false tags Array of strings 功能说明：用户标签。（默认不显示） associate_instance_metadata String 功能说明：记录实例的更上一层归属。例如associate_instance_type为PORT，此字段记录PORT的device_id和device_owner信息。仅有限场景记录。（默认不显示） 最小长度：1 最大长度：64 associate_mode String 功能说明：开启支持直通模式后展示，表示直通模式的标识。（默认不显示） 最小长度：1 最大长度：36 allow_share_bandwidth_types Array of strings 功能说明：表示此publicip可以加入的共享带宽类型列表，如果为空列表，则表示该 publicip不能加入任何共享带宽 约束：publicip只能加入到有该带宽类型的共享带宽中 最大长度：64 cascade_delete_by_instance Boolean 功能说明：表示该eip是否支持与实例同步删除。（默认不显示） 表5 VnicInfo 参数 参数类型 描述 private_ip_address String 功能说明：私网IP地址 最小长度：0 最大长度：36 device_id String 功能说明：端口所属设备ID 约束：不支持设置和更新,由系统自动维护 最小长度：0 最大长度：36 device_owner String 功能说明：设备所属 取值范围：合法设备所属 network:dhcp network:VIP_PORT network:router_interface_distributed network:router_centralized_snat 约束：不支持设置和更新,由系统自动维护 最小长度：0 最大长度：64 vpc_id String 功能说明：虚拟私有云ID 最小长度：0 最大长度：36 port_id String 功能说明：端口ID 最小长度：0 最大长度：36 port_profile String 功能说明：端口profile信息 最小长度：0 最大长度：256 mac String 功能说明：端口MAC地址 约束：由系统分配,不支持指定 最小长度：0 最大长度：64 vtep String 功能说明：VTEP IP 最小长度：0 最大长度：36 vni String 功能说明：VXLAN ID 最小长度：0 最大长度：36 instance_id String 功能说明：端口所属实例ID,例如RDS实例ID 约束：不支持设置和更新,由系统自动维护 最小长度：0 最大长度：36 instance_type String 功能说明：端口所属实例类型,例如“RDS” 约束：不支持设置和更新,由系统自动维护 最小长度：0 最大长度：36 表6 PublicipBandwidthInfo 参数 参数类型 描述 id String 功能描述：带宽ID 最小长度：0 最大长度：36 size Integer 功能描述：带宽大小 取值范围：默认5Mbit/s~2000Mbit/s 最小值：0 最大值：99999 share_type String 功能说明：带宽类型，标识是否是共享带宽 取值范围： PER：独享带宽 WHOLE：共享带宽 约束：其中IPv6暂不支持WHOLE类型带宽。 最小长度：0 最大长度：36 charge_mode String 功能说明：按流量计费还是按带宽计费 取值范围： bandwidth：按带宽计费 traffic：按流量计费 95peak_plus：按增强型95计费 最小长度：0 最大长度：36 name String 功能说明：带宽名称 取值范围：1-64个字符，支持数字、字母、中文、_(下划线)、-(中划线)、.(点) 最小长度：0 最大长度：64 billing_info String 功能说明：账单信息。如果billinginfo不为空，说明是包周期的带宽 最小长度：0 最大长度：256 表7 ProfileInfo 参数 参数类型 描述 local_network_port String 功能说明：公网IP附属的5_xxx网络（如5_bgp）中的port_id 最小长度：0 最大长度：36 standalone Boolean 功能说明：标识公网IP是否是和虚机一起创建的。true-独立创建；false-和虚机一起创建 notify_status String 功能说明：云服务标识公网IP创建进度, EIP服务内部使用 最小长度：0 最大长度：36 枚举值： PENDING_CREATE PENDING_UPDATE NOTIFYING NOTIFYED NOTIFY_DELETE create_time String 功能说明：公网IP创建时间 最小长度：0 最大长度：64 fake_network_type Boolean 功能说明：该字段仅仅用于表示eip的bgp类型是否是真实的静态sbgp * 1， 如果为true，则该eip可以切换bgp类型 * 2； 如果为false，则该eip不可以切换bgp类型 枚举值： true false create_source String 功能说明：标识IP是和哪类资源一起购买的 最小长度：0 最大长度：36 枚举值： ecs ecs_id String 功能说明：标识和公网IP一起购买的ecs的id 最小长度：0 最大长度：36 lock_status String 功能说明：公网IP加锁状态, eg："POLICE,LOCKED"。POLICE-公安冻结；LOCKED-普通冻结；普通冻结细分状态：ARREAR-欠费；DELABLE-可删除； 最小长度：0 最大长度：36 freezed_status String 功能说明：公网IP冻结状态。 最小长度：0 最大长度：36 枚举值： FREEZED UNFREEZED bandwith_info BandwidthInfoResp object 功能说明：公网IP绑定的带宽信息 表8 BandwidthInfoResp 参数 参数类型 描述 bandwidth_name String 功能说明：带宽名称 最小长度：0 最大长度：256 bandwidth_number Integer 功能说明：带宽大小 最小值：0 最大值：99999 bandwidth_type String 功能说明：带宽类型 枚举值： PER WHOLE bandwidth_id String 功能说明：带宽id 最小长度：0 最大长度：36 状态码： 400 表9 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 error_msg String 服务异常错误信息描述 最小长度：0 最大长度：1024 error_code String 服务异常错误信息编码 最小长度：0 最大长度：64 状态码： 401 表10 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 error_msg String 服务异常错误信息描述 最小长度：0 最大长度：1024 error_code String 服务异常错误信息编码 最小长度：0 最大长度：64 状态码： 403 表11 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 error_msg String 服务异常错误信息描述 最小长度：0 最大长度：1024 error_code String 服务异常错误信息编码 最小长度：0 最大长度：64 状态码： 404 表12 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 error_msg String 服务异常错误信息描述 最小长度：0 最大长度：1024 error_code String 服务异常错误信息编码 最小长度：0 最大长度：64 状态码： 405 表13 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 error_msg String 服务异常错误信息描述 最小长度：0 最大长度：1024 error_code String 服务异常错误信息编码 最小长度：0 最大长度：64 状态码： 406 表14 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 error_msg String 服务异常错误信息描述 最小长度：0 最大长度：1024 error_code String 服务异常错误信息编码 最小长度：0 最大长度：64 状态码： 407 表15 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 error_msg String 服务异常错误信息描述 最小长度：0 最大长度：1024 error_code String 服务异常错误信息编码 最小长度：0 最大长度：64 状态码： 408 表16 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 error_msg String 服务异常错误信息描述 最小长度：0 最大长度：1024 error_code String 服务异常错误信息编码 最小长度：0 最大长度：64 状态码： 409 表17 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 error_msg String 服务异常错误信息描述 最小长度：0 最大长度：1024 error_code String 服务异常错误信息编码 最小长度：0 最大长度：64 状态码： 500 表18 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 error_msg String 服务异常错误信息描述 最小长度：0 最大长度：1024 error_code String 服务异常错误信息编码 最小长度：0 最大长度：64 状态码： 501 表19 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 error_msg String 服务异常错误信息描述 最小长度：0 最大长度：1024 error_code String 服务异常错误信息编码 最小长度：0 最大长度：64 状态码： 502 表20 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 error_msg String 服务异常错误信息描述 最小长度：0 最大长度：1024 error_code String 服务异常错误信息编码 最小长度：0 最大长度：64 状态码： 503 表21 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 error_msg String 服务异常错误信息描述 最小长度：0 最大长度：1024 error_code String 服务异常错误信息编码 最小长度：0 最大长度：64 状态码： 504 表22 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 error_msg String 服务异常错误信息描述 最小长度：0 最大长度：1024 error_code String 服务异常错误信息编码 最小长度：0 最大长度：64

URI GET /v3/{project_id}/eip/publicips/{publicip_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 最小长度：0 最大长度：32 publicip_id 是 String 弹性公网IP的ID 最小长度：0 最大长度：36 表2 Query参数 参数 是否必选 参数类型 描述 fields 否 Array 功能说明：查询字段，形式为"fields=id&fields=owner&..." 支持字段：id/project_id/ip_version/type/public_ip_address/public_ipv6_address/network_type/status/description/created_at/updated_at/vnic/bandwidth/associate_instance_type/associate_instance_id/lock_status/billing_info/tags/enterprise_project_id/publicip_pool_name/allow_share_bandwidth_types/alias/publicip_pool_id/public_border_group

响应示例 状态码： 200 GET和PUT操作正常返回 { "publicip_types" : [ { "id" : "143fe300-78bc-4e2b-ae4b-d7a2ae7f2197", "type" : "5_bgp" }, { "id" : "71d56cb8-e86e-403b-8ace-8551ff075986", "type" : "5_test" }, { "id" : "985579ea-be40-409e-82b0-68d8acc10865", "type" : "5_union" }, { "id" : "caaef6af-6662-45b0-bd55-519673265a42", "type" : "5_telcom" } ]}

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

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

响应示例 状态码： 200 GET操作正常返回 { "job_id" : "ff808082843684110184e155fdb36461", "job_type" : "createBatchPublicip", "begin_time" : "2022-12-05T08:10:19.951Z", "end_time" : "2022-12-05T08:10:21.864Z", "status" : "SUC CES S", "error_code" : null, "fail_reason" : null, "entities" : { "sub_jobs" : [ ] }}

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 job_id String job id job_type String job类型 begin_time String 创建时间 end_time String 创建完成时间 status String job状态 error_code String 错误码 fail_reason String 错误信息 entities SubJobsInfo object job信息体，自身循环体 表3 SubJobsInfo 参数 参数类型 描述 sub_jobs Array of objects 子job信息，类型与主job一致

响应示例 状态码： 200 Get操作正常返回 { "publicip_pools" : [ { "id" : "f588ccfa-8750-4d7c-bf5d-2ede24414706", "name" : "test_pool_xxx", "status" : "active", "shared" : true, "is_common" : false, "enterprise_project_id" : 0, "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-17T09:25:53Z", "description" : "test", "public_border_group" : "center", "allow_share_bandwidth_types" : [ "share" ] } ], "request_id" : "4a06c169-cc67-4d94-a786-2d70ef09b100", "page_info" : { "previous_marker" : "f588ccfa-8750-4d7c-bf5d-2ede24414706", "current_count" : 1 }}

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

URI GET /v3/{project_id}/eip/publicip-pools 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 功能说明：项目ID 最小长度：0 最大长度：32 表2 Query参数 参数 是否必选 参数类型 描述 marker 否 String 功能说明：分页查询起始的资源ID，为空时为查询第一页 最小长度：0 最大长度：36 limit 否 Integer 功能说明：每页返回的个 数取值范围：0~[2000]，其中2000为局点差异项，具体取值由局点决定 最小值：0 最大值：2000 fields 否 String 功能说明：查询字段，形式为"fields=id&fields=name&..." 支持字段：id/name/size/used/project_id/status/billing_info/created_at/updated_at/type/shared/is_common/description/tags/enterprise_project_id/allow_share_bandwidth_types/public_border_group 最小长度：0 最大长度：1024 sort_key 否 String 功能说明：排序字段，形式为"sort_key=id&sort_dir=asc" 支持字段：id/name/created_at/updated_at/public_border_group 最小长度：0 最大长度：36 sort_dir 否 String 功能说明：排序方向 取值范围：asc、desc 最小长度：0 最大长度：16 id 否 String 功能说明：根据id过滤 最小长度：0 最大长度：36 name 否 String 功能说明：根据name过滤 最小长度：0 最大长度：128 size 否 Integer 功能说明：根据size过滤 最小值：0 最大值：999999 status 否 String 功能说明：根据status过滤 最小长度：0 最大长度：36 type 否 String 功能说明：根据type过滤 最小长度：0 最大长度：36 description 否 String 功能说明：根据description过滤 最小长度：0 最大长度：1024 public_border_group 否 String 功能说明：根据public_border_group过滤 最小长度：0 最大长度：64