华为云用户手册

500M免费额度怎么算？ 云日志服务的计费功能包括：1、日志读写和索引；2、日志存储。每月各赠送500M免费额度，具体说明如下： 日志读写、索引：按流量计费，每月免费赠送您500M额度，超过后按需收费。 日志存储：按存储空间计费，每月赠送您500M额度，超过后按需收费。 收费详情请参见：LTS产品价格详情。 如果每月免费赠送的额度已经可以满足您的使用需求，超过后希望暂停日志采集，请参见：如何停止日志采集（停止计费）。 父主题： 计费

日志如何计费，日志索引流量是什么？ 日志包含3个计费量纲：日志读写流量、日志索引流量和日志存储空间，LTS每月各赠送500M免费额度，具体单价请参考官网日志计费说明。 日志读写流量：读写流量根据传输的流量计算，传输流量为压缩后的日志大小，日志一般有5倍压缩率。 示例：原始日志为10GB，实际压缩大小为 2GB，则以2GB 计费。 日志索引流量：原始日志数据默认都会建立全文索引，创建索引（对日志分词处理）后，才能搜索日志，在写入时一次性收取流量费用。 示例：原始日志为10GB，需要索引的流量为10GB，产生索引流量费用3.2元。 日志存储空间：日志存储空间为压缩后的日志数据、索引数据、副本数据之和，这些空间约等于原始日志数据大小。 示例：原始日志为10GB，那么一天存储最大收费为 0.000479*24*10=0.12元（金额如果遇小数点，则保留小数点后两位，第三位四舍五入。如遇四舍五入后不足￥0.01 元，则按￥0.01 元展示）。 父主题： 计费

场景信息 A公司是华为云用户，其在华为云上部署了2个应用，并购买了云服务ELB和WAF。 应用1：天气预报应用，名为WeatherPrediction，该应用部署在云主机上，由3个微服务组成，分别是前端weatherWeb，后台weatherBackend，算法weatherAlgorithm，每个微服务的运行日志都需要收集到LTS。应用1部署在测试和生产两个环境的不同机器上。 应用2：在线音乐应用，名为MusicApp，该应用部署在CCE集群中，由2个无状态工作负载组成，分别是前端MusicWeb，后台MusicBackend，每个工作负载都有自己的应用日志需要收集到LTS。应用2有测试和生产两个环境，分别部署在CCE-Test和CCE-Prod两个集群上。 云服务日志：A公司希望将ELB和WAF的日志集中到LTS分析

规划建议 云主机部署的应用 建议每个应用对应一个日志组，应用下的每个微服务的一种日志对应一个日志流。 在A公司场景下，可为天气预报应用创建两个对应的日志组WeatherPrediction-Test、WeatherPrediction-Prod，分别对应测试、生产环境；在每个日志组下创建3个日志流，生产环境下的3个微服务对应的日志流分别是：WeatherWebProd、WeatherAlgorithm-Prod 、WeatherBackend_Prod。 容器部署的应用 建议每个CCE集群对应一个日志组（例如为每个CCE集群创建一个名为k8s-log-{clusterId}的日志组），该集群下的每个工作负载的一种日志对应一个日志流。 在A公司场景下，有测试和生产两个CCE集群，因此可创建两个对应的日志组k8s-log-{TestClusterId}、k8s-log-{ProdClusterId}，分别对应测试、生产集群；在每个日志组下创建2个日志流，例如生产集群下的2个工作负载对应的日志流分别是：MusicWeb-Prod、MusicBackend-Prod。 云服务的日志 建议为每种云服务创建一个日志组，该云服务的一个实例的日志对应一个日志流。 例如：为ELB创建一个名为ELB的日志组，为A公司购买的每个ELB实例创建一个对应的日志流。

请求示例 将id为d91b0028-6f6b-4478-808a-297b75b6812a、1d184b2c-4ec9-49b5-a3f9-27600a76ba3f的弹性公网IP移出按流量计费的共享带宽，支持多个弹性公网IP移除共享带宽。 { "bandwidth" : { "size" : 22, "publicip_info" : [ { "publicip_id" : "d91b0028-6f6b-4478-808a-297b75b6812a", "publicip_type" : "5_dualStack" }, { "publicip_id" : "1d184b2c-4ec9-49b5-a3f9-27600a76ba3f" } ], "charge_mode" : "traffic" }}

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

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 bandwidth 是 RemoveFromSharedBandwidthOption object 带宽对象 表3 RemoveFromSharedBandwidthOption 参数 是否必选 参数类型 描述 charge_mode 是 String 功能说明：EIP从共享带宽移除后，会为此EIP创建独占带宽进行计费。 此参数表示EIP从共享带宽移除后，使用的独占带宽的计费类型。（bandwidth/traffic） 枚举值： bandwidth traffic publicip_info 是 Array of RemovePublicipInfo objects 功能说明：要从共享带宽中移除的EIP信息 约束：WHOLE类型的带宽支持多个EIP，跟租户的配额相关，默认一个共享带宽的配额为20 size 是 Integer 功能说明：EIP从共享带宽移除后，会为此EIP创建独占带宽进行计费。此参数表示EIP从共享带宽移除后，使用的独占带宽的带宽大小。（M） 取值范围：默认1Mbit/s~2000Mbit/s（具体范围以各区域配置为准，请参见控制台对应页面显示）。 表4 RemovePublicipInfo 参数 是否必选 参数类型 描述 publicip_type 否 String 功能说明：若publicip_id为弹性公网IP的id，则该字段可自动忽略。若publicip_id为IPv6端口PORT的id，则该字段必填：5_dualStack(目前仅北京4局点支持) 最大长度：36 publicip_id 是 String 功能说明：带宽对应的弹性公网IP或IPv6端口PORT的唯一标识 最大长度：36

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

响应示例 状态码： 200 POST操作正常返回 { "bandwidths" : [ { "tenant_id" : "8b7e35ad379141fc9df3e178bd64f55c", "billing_info" : "CS1712121146TSQOJ:0616e2a5dc9f4985ba52ea8c0c7e273c:southchina:35f2b308f5d64441a6fa7999fbcd4321", "size" : 10, "share_type" : "WHOLE", "bandwidth_type" : "share", "publicip_info" : [ ], "name" : "bandwidth123", "charge_mode" : "bandwidth", "id" : "3fa5b383-5a73-4dcb-a314-c6128546d855", "status" : "NORMAL" }, { "tenant_id" : "8b7e35ad379141fc9df3e178bd64f55c", "billing_info" : "CS1712121146TSQOJ:0616e2a5dc9f4985ba52ea8c0c7e273c:southchina:35f2b308f5d64441a6fa7999fbcd4321", "size" : 10, "share_type" : "WHOLE", "bandwidth_type" : "share", "publicip_info" : [ ], "name" : "bandwidth123", "charge_mode" : "bandwidth", "id" : "d91b0028-6f6b-4478-808a-297b75b6812a", "status" : "NORMAL" } ]}

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 bandwidths Array of BatchBandwidthResp objects 批创的带宽对象的列表 表5 BatchBandwidthResp 参数 参数类型 描述 bandwidth_type String 功能说明：带宽类型，共享带宽默认为share。 取值范围：share，bgp，sbgp等。 share：共享带宽 bgp：动态bgp sbgp：静态bgp 最小长度：1 最大长度：36 billing_info String 功能说明：账单信息，如果billing_info不为空，说明是包周期的带宽 最小长度：0 最大长度：255 charge_mode String 功能说明：按流量计费还是按带宽计费 取值范围：bandwidth（按带宽计费），traffic（按流量计费），不返回或者为空时表示是bandwidth。 约束：共享带宽仅支持按带宽计费。 枚举值： bandwidth traffic 95peak_plus id String 功能说明：带宽唯一标识 最大长度：36 name String 功能说明：带宽名称 取值范围：1-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点） 最小长度：1 最大长度：64 publicip_info Array of PublicipInfoResp objects 功能说明：带宽对应的弹性公网IP信息 约束：WHOLE类型的带宽支持多个弹性公网IP，PER类型的带宽只能对应一个弹性公网IP share_type String 功能说明：带宽类型，标识是否是共享带宽 取值范围：WHOLE，PER WHOLE表示共享带宽 PER表示独享带宽 枚举值： WHOLE PER size Integer 功能说明：带宽大小 取值范围：5Mbit/s~2000Mbit/s（具体范围以各区域配置为准，请参见控制台对应页面显示） tenant_id String 功能说明：用户所属租户ID 最大长度：36 status String 功能说明：带宽的状态 取值范围： FREEZED：冻结 NORMAL：正常 枚举值： FREEZED NORMAL public_border_group String 功能说明：表示中心站点资源或者边缘站点资源 取值范围： center、边缘站点名称 约束限制：只能绑定与该字段相同的publicip资源 最小长度：1 最大长度：64 表6 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 表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参数 参数 是否必选 参数类型 描述 bandwidth 是 BatchCreateBandwidthOption object 带宽对象 表3 BatchCreateBandwidthOption 参数 是否必选 参数类型 描述 count 是 Integer 取值范围：正整数 功能说明：批创的共享带宽的个数 说明： 如果传入的参数为小数（如 2.2）或者字符类型（如“2”），会自动强制转换为整数。 约束：表示批量创建的共享带宽数目, 该参数和租户配额数目有关，默认配额为5，批创个数不大于租户共享带宽的可用配额。 最小值：1 name 是 String 取值范围：1-64，支持数字、字母、中文、_(下划线)、-（中划线）、.（点） 功能说明：带宽名称 最小长度：1 最大长度：64 size 是 Integer 功能说明：带宽大小。共享带宽的大小有最小值限制，默认为5M，可能因局点不同而不同。 取值范围：默认5Mbit/s~2000Mbit/s（具体范围以各区域配置为准，请参见控制台对应页面显示）。 约束：如果传入的参数为小数（如 10.2）或者字符类型（如“10”），会自动强制转换为整数。 注意：调整带宽时的最小单位会根据带宽范围不同存在差异。 小于等于300Mbit/s：默认最小单位为1Mbit/s。 300Mbit/s~1000Mbit/s：默认最小单位为50Mbit/s。 大于1000Mbit/s：默认最小单位为500Mbit/s。 public_border_group 否 String 功能说明：表示中心站点资源或者边缘站点资源 取值范围： center、边缘站点名称 约束：共享带宽只能插入与该字段相同的publicip 最小长度：1 最大长度：64

状态码 状态码 描述 200 OK 400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found 405 Method Not Allowed 406 Not Acceptable 407 Proxy Authentication Required 408 Request Timeout 500 Internal Server Error 501 Not Implemented 502 Bad Gateway 503 Service Unavailable 504 Gateway Timeout

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

状态码 表1 正常返回值 正常返回码 类型 说明 200 OK GET、PUT、POST操作正常返回 201 Created OpenStack Neutron API、API V3的POST操作正常返回 204 No Content DELETE操作正常返回 表2 异常返回值 返回值 说明 400 Bad Request 服务器未能处理请求。 401 Unauthorized 被请求的页面需要用户名和密码。 403 Forbidden 对被请求页面的访问被禁止。 404 Not Found 服务器无法找到被请求的页面。 405 Method Not Allowed 请求中指定的方法不被允许。 406 Not Acceptable 服务器生成的响应无法被客户端所接受。 407 Proxy Authentication Required 用户必须首先使用代理服务器进行验证，这样请求才会被处理。 408 Request Timeout 请求超出了服务器的等待时间。 409 Conflict 由于冲突，请求无法被完成。 500 Internal Server Error 请求未完成。服务异常。 501 Not Implemented 请求未完成。服务器不支持所请求的功能。 502 Bad Gateway 请求未完成。服务器从上游服务器收到一个无效的响应。 503 Service Unavailable 请求未完成。系统暂时异常。 504 Gateway Timeout 网关超时。 父主题： 附录

调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目列表API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects”，其中{Endpoint}为IAM的终端节点，可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下，其中projects下的“id”即为项目ID。 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "project_name", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" }}

请求示例 将ID为fe2a11c7-c880-49f7-b1e0-e151df2cc836的按需弹性公网IP转为包周期弹性公网IP，订购周期为1个月，不自动续费。 { "publicip_ids" : [ "fe2a11c7-c880-49f7-b1e0-e151df2cc836" ], "extendParam" : { "charge_mode" : "prePaid", "period_type" : "month", "period_num" : 1, "is_auto_renew" : false, "is_auto_pay" : true }}

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

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

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 publicip_ids 是 Array 待按需转包IP列表 extendParam 是 CreatePrePaidPublicipExtendParamOption object 按需转包周期参数 表3 CreatePrePaidPublicipExtendParamOption 参数 是否必选 参数类型 描述 charge_mode 否 String 功能说明：付费方式（预付费、按需付费；预付费，即包周期付费） 取值范围： prePaid -预付费，即包年包月； postPaid-后付费，即按需付费； 后付费的场景下，extendParam的其他字段都会被忽略。 缺省值：postPaid 枚举值： prePaid postPaid period_type 否 String 功能说明：订购资源的周期类型（包年、包月等） 取值范围： month-月 year-年 约束：如果用包周期共享带宽创建时（即携带共享带宽id创建EIP）此字段可不填。付费方式是预付费且不是使用共享带宽创建IP时，该字段必选； 使用共享带宽创建IP时，带宽资源到期时间与IP的到期时间相同。 枚举值： month year period_num 否 Integer 功能说明：订购周期数 取值范围：(后续会随运营策略变化) period_type为month时，为[1,9] period_type为year时，为[1,3] 约束：同period_type约束。 最小值：1 最大值：9 is_auto_renew 否 Boolean 功能说明：是否自动续订 取值范围： false：不自动续订 true：自动续订 约束：到期后，默认自动续订1个月（自动续订时间后续可能会变化），详情可联系客服咨询。 缺省值：false is_auto_pay 否 Boolean 功能说明：下单订购后，是否自动从客户的账户中支付 取值范围： true：自动支付，从账户余额自动扣费 false：只提交订单不支付，需要客户手动去支付 约束：自动支付时，只能使用账户的现金支付；如果要使用代金券，请选择不自动支付，然后在用户费用中心，选择代金券支付。 缺省值：false

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 bandwidth_ids 是 Array 待按需转包带宽列表 extendParam 是 CreatePrePaidPublicipExtendParamOption object 按需转包周期参数 表3 CreatePrePaidPublicipExtendParamOption 参数 是否必选 参数类型 描述 charge_mode 否 String 功能说明：付费方式（预付费、按需付费；预付费，即包周期付费） 取值范围： prePaid -预付费，即包年包月； postPaid-后付费，即按需付费； 后付费的场景下，extendParam的其他字段都会被忽略。 缺省值：postPaid 枚举值： prePaid postPaid period_type 否 String 功能说明：订购资源的周期类型（包年、包月等） 取值范围： month-月 year-年 约束：如果用包周期共享带宽创建时（即携带共享带宽id创建EIP）此字段可不填。付费方式是预付费且不是使用共享带宽创建IP时，该字段必选； 使用共享带宽创建IP时，带宽资源到期时间与IP的到期时间相同。 枚举值： month year period_num 否 Integer 功能说明：订购周期数 取值范围：(后续会随运营策略变化) period_type为month时，为[1,9] period_type为year时，为[1,3] 约束：同period_type约束。 最小值：1 最大值：9 is_auto_renew 否 Boolean 功能说明：是否自动续订 取值范围： false：不自动续订 true：自动续订 约束：到期后，默认自动续订1个月（自动续订时间后续可能会变化），详情可联系客服咨询。 缺省值：false is_auto_pay 否 Boolean 功能说明：下单订购后，是否自动从客户的账户中支付 取值范围： true：自动支付，从账户余额自动扣费 false：只提交订单不支付，需要客户手动去支付 约束：自动支付时，只能使用账户的现金支付；如果要使用代金券，请选择不自动支付，然后在用户费用中心，选择代金券支付。 缺省值：false

请求示例 将ID为fe2a11c7-c880-49f7-b1e0-e151df2cc836的按需带宽转为包周期带宽，订购周期为1个月，不自动续费。 POST /v2.0/{project_id}/bandwidths/change-to-period{ "bandwidth_ids" : [ "fe2a11c7-c880-49f7-b1e0-e151df2cc836" ], "extendParam" : { "charge_mode" : "prePaid", "period_type" : "month", "period_num" : 1, "is_auto_renew" : false, "is_auto_pay" : true }}

状态码 状态码 描述 200 OK 400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found 405 Method Not Allowed 406 Not Acceptable 407 Proxy Authentication Required 408 Request Timeout 409 Conflict 500 Internal Server Error 501 Not Implemented 502 Bad Gateway 503 Service Unavailable 504 Gateway Timeout

状态码 状态码 描述 200 OK 400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found 405 Method Not Allowed 406 Not Acceptable 407 Proxy Authentication Required 408 Request Timeout 409 Conflict 500 Internal Server Error 501 Not Implemented 503 Service Unavailable 504 Gateway Timeout

请求示例 批量解绑id为59e55560-4d2c-40d5-b757-0f5c97b701e4、e83cae01-e68f-4627-84b3-d2d5c4c836bd的弹性公网IP。 /v2/{project_id}/batchpublicips{ "publicip_ids" : [ "59e55560-4d2c-40d5-b757-0f5c97b701e4", "e83cae01-e68f-4627-84b3-d2d5c4c836bd" ]}

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

请求示例 弹性公网IP绑定实例，传入实例ip和实例类型。 POST /v3/{project_id}/eip/publicips/{publicip_id}/associate-instance{ "publicip" : { "associate_instance_id" : "921b9dc7-8151-41e1-b83c-d50fe959592a", "associate_instance_type" : "PORT" }}

响应示例 状态码： 200 POST操作正常返回 { "publicip" : { "alias" : "abcd", "associate_instance_id" : "921b9dc7-8151-41e1-b83c-d50fe959592a", "associate_instance_type" : "PORT", "bandwidth" : { "billing_info" : "xxxx: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" : "ACTIVE", "type" : "EIP", "updated_at" : "2020-06-18T14:05:32Z", "vnic" : { "device_id" : "78aa6d7f-7111-434e-9a93-0dc6fdacff63", "device_owner" : "network:nat_gateway", "instance_id" : "", "instance_type" : "", "mac" : "fa:16:3e:83:6b:0a", "port_id" : "921b9dc7-8151-41e1-b83c-d50fe959592a", "port_profile" : null, "private_ip_address" : "xx.xx.xx.xx", "vni" : null, "vpc_id" : "a26c231a-cf6f-48d3-83db-1e261d0e235a", "vtep" : null } }, "request_id" : "ead9f912bd1191e3d5f0037141098d91"}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 publicip PublicipInstanceResp object 绑定弹性公网IP的返回对象 表5 PublicipInstanceResp 参数 参数类型 描述 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 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 ERROR VPN description String 功能说明：弹性公网IP描述信息 约束：用户以自定义方式标识资源，系统不感知 最小长度：1 最大长度：255 public_border_group String 功能说明：表示中心站点资源或者边缘站点资源 取值范围： center、边缘站点名称 约束：publicip只能绑定该字段相同的资源 最小长度：1 最大长度：64 created_at String 功能说明：资源创建UTC时间 格式:yyyy-MM-ddTHH:mm:ssZ updated_at String 功能说明：资源更新UTC时间 格式:yyyy-MM-ddTHH:mm:ssZ 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 最大长度：64 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 表6 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 表7 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 状态码： 400 表8 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 error_msg String 服务异常错误信息描述 最小长度：0 最大长度：1024 error_code String 服务异常错误信息编码 最小长度：0 最大长度：64 状态码： 401 表9 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 error_msg String 服务异常错误信息描述 最小长度：0 最大长度：1024 error_code String 服务异常错误信息编码 最小长度：0 最大长度：64 状态码： 403 表10 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 error_msg String 服务异常错误信息描述 最小长度：0 最大长度：1024 error_code String 服务异常错误信息编码 最小长度：0 最大长度：64 状态码： 404 表11 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 error_msg String 服务异常错误信息描述 最小长度：0 最大长度：1024 error_code String 服务异常错误信息编码 最小长度：0 最大长度：64 状态码： 405 表12 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 error_msg String 服务异常错误信息描述 最小长度：0 最大长度：1024 error_code String 服务异常错误信息编码 最小长度：0 最大长度：64 状态码： 406 表13 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 error_msg String 服务异常错误信息描述 最小长度：0 最大长度：1024 error_code String 服务异常错误信息编码 最小长度：0 最大长度：64 状态码： 407 表14 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 error_msg String 服务异常错误信息描述 最小长度：0 最大长度：1024 error_code String 服务异常错误信息编码 最小长度：0 最大长度：64 状态码： 408 表15 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 error_msg String 服务异常错误信息描述 最小长度：0 最大长度：1024 error_code String 服务异常错误信息编码 最小长度：0 最大长度：64 状态码： 409 表16 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 error_msg String 服务异常错误信息描述 最小长度：0 最大长度：1024 error_code String 服务异常错误信息编码 最小长度：0 最大长度：64 状态码： 500 表17 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 error_msg String 服务异常错误信息描述 最小长度：0 最大长度：1024 error_code String 服务异常错误信息编码 最小长度：0 最大长度：64 状态码： 501 表18 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 error_msg String 服务异常错误信息描述 最小长度：0 最大长度：1024 error_code String 服务异常错误信息编码 最小长度：0 最大长度：64 状态码： 502 表19 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 error_msg String 服务异常错误信息描述 最小长度：0 最大长度：1024 error_code String 服务异常错误信息编码 最小长度：0 最大长度：64 状态码： 503 表20 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 error_msg String 服务异常错误信息描述 最小长度：0 最大长度：1024 error_code String 服务异常错误信息编码 最小长度：0 最大长度：64 状态码： 504 表21 响应Body参数 参数 参数类型 描述 request_id String 本次请求的编号 最小长度：0 最大长度：36 error_msg String 服务异常错误信息描述 最小长度：0 最大长度：1024 error_code String 服务异常错误信息编码 最小长度：0 最大长度：64

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 publicip 是 AssociatePublicipsOption object 弹性公网IP对象 表3 AssociatePublicipsOption 参数 是否必选 参数类型 描述 associate_instance_type 是 String 功能说明：端口所属实例类型 取值范围：PORT、NATGW、VPN、ELB 约束： associate_instance_type和associate_instance_id都不为空时表示绑定实例 associate_instance_type字段不允许为空 双栈公网IP不允许修改绑定的实例 最小长度：0 最大长度：36 枚举值： PORT NATGW VPN ELB associate_instance_id 是 String 功能说明：端口所属实例ID，例如RDS实例ID 约束： associate_instance_type和associate_instance_id都不为空时表示绑定实例 associate_instance_id不允许为空 双栈公网IP不允许修改绑定的实例 最小长度：0 最大长度：36