华为云用户手册

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 floatingip PostAndPutFloatingIpResp object floatingip对象 表5 PostAndPutFloatingIpResp 参数 参数类型 描述 fixed_ip_address String 功能说明：关联端口的私有IP地址。 最小长度：0 最大长度：64 floating_ip_address String 功能说明：浮动IP地址。 最小长度：0 最大长度：64 floating_network_id String 功能说明：外部网络的id。 最小长度：0 最大长度：36 id String 功能说明：浮动IP地址的id。 最小长度：0 最大长度：36 port_id String 功能说明：端口id。 最小长度：0 最大长度：36 router_id String 功能说明：所属路由器id。 最小长度：0 最大长度：36 status String 功能说明：网络状态，可以为ACTIVE， DOWN或ERROR 取值范围： DOWN：未绑定 ACTIVE：绑定 ERROR：异常 枚举值： ACTIVE DOWN ERROR tenant_id String 功能说明：项目id。 最小长度：0 最大长度：36 dns_name String 功能说明：DNS名称，该参数当前仅在“华南-广州”开放 最小长度：0 最大长度：255 dns_domain String 功能说明：DNS域地址，该参数当前仅在“华南-广州”开放 最小长度：0 最大长度：255 状态码： 400 表6 响应Body参数 参数 参数类型 描述 NeutronError NeutronError object Neutron服务异常 表7 NeutronError 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 type String 服务异常错误类型 最小长度：0 最大长度：64 detail String 服务异常错误详情 最小长度：0 最大长度：256 状态码： 401 表8 响应Body参数 参数 参数类型 描述 NeutronError NeutronError object Neutron服务异常 表9 NeutronError 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 type String 服务异常错误类型 最小长度：0 最大长度：64 detail String 服务异常错误详情 最小长度：0 最大长度：256 状态码： 403 表10 响应Body参数 参数 参数类型 描述 NeutronError NeutronError object Neutron服务异常 表11 NeutronError 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 type String 服务异常错误类型 最小长度：0 最大长度：64 detail String 服务异常错误详情 最小长度：0 最大长度：256 状态码： 404 表12 响应Body参数 参数 参数类型 描述 NeutronError NeutronError object Neutron服务异常 表13 NeutronError 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 type String 服务异常错误类型 最小长度：0 最大长度：64 detail String 服务异常错误详情 最小长度：0 最大长度：256 状态码： 405 表14 响应Body参数 参数 参数类型 描述 NeutronError NeutronError object Neutron服务异常 表15 NeutronError 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 type String 服务异常错误类型 最小长度：0 最大长度：64 detail String 服务异常错误详情 最小长度：0 最大长度：256 状态码： 406 表16 响应Body参数 参数 参数类型 描述 NeutronError NeutronError object Neutron服务异常 表17 NeutronError 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 type String 服务异常错误类型 最小长度：0 最大长度：64 detail String 服务异常错误详情 最小长度：0 最大长度：256 状态码： 407 表18 响应Body参数 参数 参数类型 描述 NeutronError NeutronError object Neutron服务异常 表19 NeutronError 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 type String 服务异常错误类型 最小长度：0 最大长度：64 detail String 服务异常错误详情 最小长度：0 最大长度：256 状态码： 408 表20 响应Body参数 参数 参数类型 描述 NeutronError NeutronError object Neutron服务异常 表21 NeutronError 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 type String 服务异常错误类型 最小长度：0 最大长度：64 detail String 服务异常错误详情 最小长度：0 最大长度：256 状态码： 409 表22 响应Body参数 参数 参数类型 描述 NeutronError NeutronError object Neutron服务异常 表23 NeutronError 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 type String 服务异常错误类型 最小长度：0 最大长度：64 detail String 服务异常错误详情 最小长度：0 最大长度：256 状态码： 500 表24 响应Body参数 参数 参数类型 描述 NeutronError NeutronError object Neutron服务异常 表25 NeutronError 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 type String 服务异常错误类型 最小长度：0 最大长度：64 detail String 服务异常错误详情 最小长度：0 最大长度：256 状态码： 501 表26 响应Body参数 参数 参数类型 描述 NeutronError NeutronError object Neutron服务异常 表27 NeutronError 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 type String 服务异常错误类型 最小长度：0 最大长度：64 detail String 服务异常错误详情 最小长度：0 最大长度：256 状态码： 502 表28 响应Body参数 参数 参数类型 描述 NeutronError NeutronError object Neutron服务异常 表29 NeutronError 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 type String 服务异常错误类型 最小长度：0 最大长度：64 detail String 服务异常错误详情 最小长度：0 最大长度：256 状态码： 503 表30 响应Body参数 参数 参数类型 描述 NeutronError NeutronError object Neutron服务异常 表31 NeutronError 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 type String 服务异常错误类型 最小长度：0 最大长度：64 detail String 服务异常错误详情 最小长度：0 最大长度：256 状态码： 504 表32 响应Body参数 参数 参数类型 描述 NeutronError NeutronError object Neutron服务异常 表33 NeutronError 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 type String 服务异常错误类型 最小长度：0 最大长度：64 detail String 服务异常错误详情 最小长度：0 最大长度：256

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

响应示例 状态码： 200 GET和PUT操作正常返回 { "floatingip" : { "id" : "1a3a2818-d9b4-4a9c-8a19-5252c499d1cd", "status" : "DOWN", "router_id" : null, "tenant_id" : "bbfe8c41dd034a07bebd592bf03b4b0c", "project_id" : "bbfe8c41dd034a07bebd592bf03b4b0c", "floating_network_id" : "0a2228f2-7f8a-45f1-8e09-9039e1d09975", "fixed_ip_address" : null, "floating_ip_address" : "99.99.99.84", "port_id" : null, "dns_name" : "ecs-88-99-103-61", "dns_domain" : "compute.hwclouds-dns.com.", "created_at" : "2017-10-19T12:21:28", "updated_at" : "2018-07-30T12:52:13" }}

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 floatingip FloatingIpResp object floatingip对象 表3 FloatingIpResp 参数 参数类型 描述 fixed_ip_address String 功能说明：关联端口的私有IP地址。 最小长度：0 最大长度：64 floating_ip_address String 功能说明：浮动IP地址。 最小长度：0 最大长度：64 floating_network_id String 功能说明：外部网络id 最小长度：0 最大长度：36 id String 功能说明：浮动IP地址的id。 最小长度：0 最大长度：36 port_id String 功能说明：端口id 最小长度：0 最大长度：36 router_id String 功能说明：所属路由器id。 最小长度：0 最大长度：36 status String 功能说明：网络状态，可以为ACTIVE， DOWN或ERROR。 取值范围： DOWN：未绑定 ACTIVE：绑定 ERROR：异常 枚举值： ACTIVE DOWN ERROR tenant_id String 功能说明：项目id。 最小长度：0 最大长度：36 project_id String 功能说明：项目id。 最小长度：0 最大长度：36 dns_name String 功能说明：DNS名称，该参数当前仅在“华南-广州”开放 最小长度：0 最大长度：255 dns_domain String 功能说明：DNS域地址，该参数当前仅在“华南-广州”开放 最小长度：0 最大长度：255 created_at String 功能说明：资源创建时间，采用UTC时间，格式：YYYY-MM-DDTHH:MM:SS updated_at String 功能说明：资源更新时间，采用UTC时间，格式：YYYY-MM-DDTHH:MM:SS 状态码： 400 表4 响应Body参数 参数 参数类型 描述 NeutronError NeutronError object Neutron服务异常 表5 NeutronError 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 type String 服务异常错误类型 最小长度：0 最大长度：64 detail String 服务异常错误详情 最小长度：0 最大长度：256 状态码： 401 表6 响应Body参数 参数 参数类型 描述 NeutronError NeutronError object Neutron服务异常 表7 NeutronError 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 type String 服务异常错误类型 最小长度：0 最大长度：64 detail String 服务异常错误详情 最小长度：0 最大长度：256 状态码： 403 表8 响应Body参数 参数 参数类型 描述 NeutronError NeutronError object Neutron服务异常 表9 NeutronError 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 type String 服务异常错误类型 最小长度：0 最大长度：64 detail String 服务异常错误详情 最小长度：0 最大长度：256 状态码： 404 表10 响应Body参数 参数 参数类型 描述 NeutronError NeutronError object Neutron服务异常 表11 NeutronError 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 type String 服务异常错误类型 最小长度：0 最大长度：64 detail String 服务异常错误详情 最小长度：0 最大长度：256 状态码： 405 表12 响应Body参数 参数 参数类型 描述 NeutronError NeutronError object Neutron服务异常 表13 NeutronError 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 type String 服务异常错误类型 最小长度：0 最大长度：64 detail String 服务异常错误详情 最小长度：0 最大长度：256 状态码： 406 表14 响应Body参数 参数 参数类型 描述 NeutronError NeutronError object Neutron服务异常 表15 NeutronError 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 type String 服务异常错误类型 最小长度：0 最大长度：64 detail String 服务异常错误详情 最小长度：0 最大长度：256 状态码： 407 表16 响应Body参数 参数 参数类型 描述 NeutronError NeutronError object Neutron服务异常 表17 NeutronError 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 type String 服务异常错误类型 最小长度：0 最大长度：64 detail String 服务异常错误详情 最小长度：0 最大长度：256 状态码： 408 表18 响应Body参数 参数 参数类型 描述 NeutronError NeutronError object Neutron服务异常 表19 NeutronError 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 type String 服务异常错误类型 最小长度：0 最大长度：64 detail String 服务异常错误详情 最小长度：0 最大长度：256 状态码： 409 表20 响应Body参数 参数 参数类型 描述 NeutronError NeutronError object Neutron服务异常 表21 NeutronError 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 type String 服务异常错误类型 最小长度：0 最大长度：64 detail String 服务异常错误详情 最小长度：0 最大长度：256 状态码： 500 表22 响应Body参数 参数 参数类型 描述 NeutronError NeutronError object Neutron服务异常 表23 NeutronError 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 type String 服务异常错误类型 最小长度：0 最大长度：64 detail String 服务异常错误详情 最小长度：0 最大长度：256 状态码： 501 表24 响应Body参数 参数 参数类型 描述 NeutronError NeutronError object Neutron服务异常 表25 NeutronError 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 type String 服务异常错误类型 最小长度：0 最大长度：64 detail String 服务异常错误详情 最小长度：0 最大长度：256 状态码： 502 表26 响应Body参数 参数 参数类型 描述 NeutronError NeutronError object Neutron服务异常 表27 NeutronError 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 type String 服务异常错误类型 最小长度：0 最大长度：64 detail String 服务异常错误详情 最小长度：0 最大长度：256 状态码： 503 表28 响应Body参数 参数 参数类型 描述 NeutronError NeutronError object Neutron服务异常 表29 NeutronError 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 type String 服务异常错误类型 最小长度：0 最大长度：64 detail String 服务异常错误详情 最小长度：0 最大长度：256 状态码： 504 表30 响应Body参数 参数 参数类型 描述 NeutronError NeutronError object Neutron服务异常 表31 NeutronError 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 type String 服务异常错误类型 最小长度：0 最大长度：64 detail String 服务异常错误详情 最小长度：0 最大长度：256

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

响应参数 状态码： 400 表2 响应Body参数 参数 参数类型 描述 NeutronError NeutronError object Neutron服务异常 表3 NeutronError 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 type String 服务异常错误类型 最小长度：0 最大长度：64 detail String 服务异常错误详情 最小长度：0 最大长度：256 状态码： 401 表4 响应Body参数 参数 参数类型 描述 NeutronError NeutronError object Neutron服务异常 表5 NeutronError 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 type String 服务异常错误类型 最小长度：0 最大长度：64 detail String 服务异常错误详情 最小长度：0 最大长度：256 状态码： 403 表6 响应Body参数 参数 参数类型 描述 NeutronError NeutronError object Neutron服务异常 表7 NeutronError 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 type String 服务异常错误类型 最小长度：0 最大长度：64 detail String 服务异常错误详情 最小长度：0 最大长度：256 状态码： 404 表8 响应Body参数 参数 参数类型 描述 NeutronError NeutronError object Neutron服务异常 表9 NeutronError 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 type String 服务异常错误类型 最小长度：0 最大长度：64 detail String 服务异常错误详情 最小长度：0 最大长度：256 状态码： 405 表10 响应Body参数 参数 参数类型 描述 NeutronError NeutronError object Neutron服务异常 表11 NeutronError 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 type String 服务异常错误类型 最小长度：0 最大长度：64 detail String 服务异常错误详情 最小长度：0 最大长度：256 状态码： 406 表12 响应Body参数 参数 参数类型 描述 NeutronError NeutronError object Neutron服务异常 表13 NeutronError 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 type String 服务异常错误类型 最小长度：0 最大长度：64 detail String 服务异常错误详情 最小长度：0 最大长度：256 状态码： 407 表14 响应Body参数 参数 参数类型 描述 NeutronError NeutronError object Neutron服务异常 表15 NeutronError 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 type String 服务异常错误类型 最小长度：0 最大长度：64 detail String 服务异常错误详情 最小长度：0 最大长度：256 状态码： 408 表16 响应Body参数 参数 参数类型 描述 NeutronError NeutronError object Neutron服务异常 表17 NeutronError 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 type String 服务异常错误类型 最小长度：0 最大长度：64 detail String 服务异常错误详情 最小长度：0 最大长度：256 状态码： 409 表18 响应Body参数 参数 参数类型 描述 NeutronError NeutronError object Neutron服务异常 表19 NeutronError 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 type String 服务异常错误类型 最小长度：0 最大长度：64 detail String 服务异常错误详情 最小长度：0 最大长度：256 状态码： 500 表20 响应Body参数 参数 参数类型 描述 NeutronError NeutronError object Neutron服务异常 表21 NeutronError 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 type String 服务异常错误类型 最小长度：0 最大长度：64 detail String 服务异常错误详情 最小长度：0 最大长度：256 状态码： 501 表22 响应Body参数 参数 参数类型 描述 NeutronError NeutronError object Neutron服务异常 表23 NeutronError 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 type String 服务异常错误类型 最小长度：0 最大长度：64 detail String 服务异常错误详情 最小长度：0 最大长度：256 状态码： 502 表24 响应Body参数 参数 参数类型 描述 NeutronError NeutronError object Neutron服务异常 表25 NeutronError 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 type String 服务异常错误类型 最小长度：0 最大长度：64 detail String 服务异常错误详情 最小长度：0 最大长度：256 状态码： 503 表26 响应Body参数 参数 参数类型 描述 NeutronError NeutronError object Neutron服务异常 表27 NeutronError 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 type String 服务异常错误类型 最小长度：0 最大长度：64 detail String 服务异常错误详情 最小长度：0 最大长度：256 状态码： 504 表28 响应Body参数 参数 参数类型 描述 NeutronError NeutronError object Neutron服务异常 表29 NeutronError 参数 参数类型 描述 message String 服务异常错误信息描述 最小长度：0 最大长度：256 type String 服务异常错误类型 最小长度：0 最大长度：64 detail String 服务异常错误详情 最小长度：0 最大长度：256

请求消息 请求参数 表1 请求参数 参数名称 类型 必选 说明 limit Integer 否 每页显示的条目数量。 marker String 否 取值为上一页数据的最后一条记录的id，当marker参数为无效id时，response将响应错误码400。 page_reverse Boolean 否 False/True，是否设置分页的顺序。 请求样例1 GET https://{Endpoint}/v2.0/networks?limit=2&marker=3d42a0d4-a980-4613-ae76-a2cddecff054&page_reverse=False

功能介绍 Neutron API v2.0提供分页查询功能，通过在list请求的url中添加limit和marker参数实现分页返回列表信息。分页显示的结果以显示对象的id升序排序。 若需要访问请求的下一页，需要进行以下两项配置： 在原有访问请求url中将“marker”属性值进行替换。将“marker”取值替换为：在响应消息中“rel”值为“next”时，“herf”参数取值中包括的“marker”取值。 设置“page_reverse”值为“False”。 若需要访问请求的上一页，需要进行以下两项配置： 在原有访问请求的url中将“marker”属性值进行替换。将“maker”取值替换为：在响应消息中“rel”值为“previous”时，“herf”参数中包括的“marker”取值。 设置“page_reverse”值为“True”。

响应消息 响应参数 无 响应样例1 { "networks": [ { "status": "ACTIVE", "subnets": [], "name": "liudongtest ", "admin_state_up": false, "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f", "id": "60c809cb-6731-45d0-ace8-3bf5626421a9" }, { "status": "ACTIVE", "subnets": [ "132dc12d-c02a-4c90-9cd5-c31669aace04" ], "name": "publicnet", "admin_state_up": true, "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f", "id": "9daeac7c-a98f-430f-8e38-67f9c044e299" } ], "networks_links": [ { "href": "http://192.168.82.231:9696/v2.0/networks?limit=2&marker=9daeac7c-a98f-430f-8e38-67f9c044e299", "rel": "next" }, { "href": "http://192.168.82.231:9696/v2.0/networks?limit=2&marker=60c809cb-6731-45d0-ace8-3bf5626421a9&page_reverse=True", "rel": "previous" } ]}

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

请求示例 批量创建标签。 POST https://{Endpoint}/v2.0/{project_id}/publicips/{publicip_id}/tags/action{ "action" : "create", "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value2" } ]} 批量删除标签。 POST https://{Endpoint}/v2.0/{project_id}/publicips/{publicip_id}/tags/action{ "action" : "delete", "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value3" } ]}

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 tags 是 Array of ResourceTagOption objects 功能说明：标签列表 action 是 String 功能说明：操作标识 create：创建 delete: 删除 约束：action为create时，tag的value必选 枚举值： create delete 表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

响应消息 响应参数 表1 响应参数 参数名称 类型 说明 versions Array of version objects API版本列表，请参见表2。 表2 version对象 参数名称 类型 说明 status String API版本的状态： CURRENT（当前版本） STABLE（稳定版本） DEPRECATED（废弃版本） id String API版本 links Array of link objects 链接列表，请参见表3。 表3 link对象 参数名称 类型 说明 href String API链接 rel String API链接与该API版本的关系 响应样例 { "versions": [ { "status": "CURRENT", "id": "v2.0", "links": [ { "href": "https://None/v2.0", "rel": "self" } ] } ]}

响应示例 状态码： 200 GET操作正常返回 { "total_count" : 1000, "resources" : [ { "resource_detail" : null, "resource_id" : "cdfs_cefs_wesas_12_dsad", "resource_name" : "resouece1", "tags" : [ { "value" : "value1", "key" : "key1" }, { "value" : "value1", "key" : "key2" } ] } ]}

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

请求示例 action为filter时请求体。 { "offset" : 0, "limit" : 100, "action" : "filter", "matches" : [ { "key" : "resource_name", "value" : "resource1" } ], "tags" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ]} action为count时请求体。 { "action" : "count", "tags" : [ { "key" : "key1", "values" : [ "value1", "value2" ] }, { "key" : "key2", "values" : [ "value1", "value2" ] } ], "matches" : [ { "key" : "resource_name", "value" : "resource1" } ]}

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 tags 否 Array of TagReq objects 包含标签，最多包含10个key。 每个key下面的value最多10个，结构体不能缺失，key不能为空或者空字符串。 Key不能重复，同一个key中values不能重复。 limit 否 Integer 查询记录数（action为count时无此参数）如果action为filter默认为1000，limit最多为1000，不能为负数，最小值为1 最小值：1 最大值：1000 offset 否 Integer 索引位置， 从offset指定的下一条数据开始查询。 查询第一页数据时，不需要传入此参数，查询后续页码数据时，将查询前一页数据时响应体中的值带入此参数（action为count时无此参数）如果action为filter默认为0，必须为数字，不能为负数 最小值：0 action 是 String 操作标识（仅限于filter，count）：filter（过滤），count(查询总条数) 如果是filter就是分页查询，如果是count只需按照条件将总条数返回即可。 枚举值： filter count matches 否 Array of MatchReq objects 搜索字段，key为要匹配的字段，当前仅支持resource_name。value为匹配的值。此字段为固定字典值。 表3 TagReq 参数 是否必选 参数类型 描述 key 是 String 键。最大长度127个unicode字符。 key不能为空。(搜索时不对此参数做校验) 最大长度：127 values 是 Array of strings 值列表。每个值最大长度255个unicode字符，如果values为空列表，则表示any_value。value之间为或的关系。 最大长度：255 表4 MatchReq 参数 是否必选 参数类型 描述 key 是 String 键。当前仅限定为resource_name 枚举值： resource_name value 是 String 值。每个值最大长度255个unicode字符。 最大长度：255

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 resources Array of ListResourceResp objects resource对象列表 total_count Integer 总记录数 表6 ListResourceResp 参数 参数类型 描述 resource_detail Object 资源详情。 资源对象，用于扩展。默认为空 resource_id String 资源ID 最小长度：0 最大长度：36 resource_name String 资源名称，没有默认为空字符串 最小长度：0 最大长度：256 tags Array of ListResourceTagResp objects 标签列表，没有标签默认为空数组 表7 ListResourceTagResp 参数 参数类型 描述 key String 键。最大长度127个unicode字符。 key不能为空。(搜索时不对此参数做校验) 最小长度：0 最大长度：36 value String 值列表。每个值最大长度255个unicode字符，如果values为空列表，则表示any_value。value之间为或的关系。 最小长度：0 最大长度：43 状态码： 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

状态码 状态码 描述 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

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

状态码 状态码 描述 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列表。可以指定多个带宽类型，不同的带宽类型间用逗号分隔。