文档首页/ 云防火墙 CFW/ API参考（安卡拉区域）/ API/ EIP管理/ 查询Eip个数
更新时间：2024-12-05 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询Eip个数

功能介绍

查询Eip个数

调用方法

请参见如何调用API。

URI

GET /v1/{project_id}/eip-count/{object_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户项目ID

object_id

是

String

防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id。
表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

企业项目id，用户支持企业项目后，由企业项目生成的id。

fw_instance_id

否

String

防火墙实例id，创建云防火墙后用于标志防火墙由系统自动生成的标志id，可通过调用查询防火墙实例接口，默认情况下，fw_instance_Id为空时，返回账号下第一个墙的信息；fw_instance_Id非空时，返回与fw_instance_Id对应墙的信息。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

data

EipCountRespData object

Eip个数数据
表5 EipCountRespData

参数

参数类型

描述

object_id

String

防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id。

eip_total

Integer

EIP总数

eip_protected

Integer

该账号下所有墙防护EIP总数量

eip_protected_self

Integer

该当前防火墙防护EIP数量

状态码： 400

表6 响应Body参数

参数

参数类型

描述

data

data object

响应体

trace_id

String

trace id
表7 data

参数

参数类型

描述

id

String

标识ID

请求示例

查询项目id为9d80d070b6d44942af73c9c3d38e0429，防护对象id为cfebd347-b655-4b84-b938-3c54317599b2的eip个数

https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/eip-count/cfebd347-b655-4b84-b938-3c54317599b2

响应示例

状态码： 200

OK

{
  "data" : {
    "eip_protected" : 1,
    "eip_protected_self" : 4,
    "eip_total" : 5,
    "object_id" : ""
  }
}

状态码： 400

Bad Request

{
  "error_code" : "CFW.00200005",
  "error_msg" : "操作内容不存在"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： EIP管理