查询Eip个数
功能介绍
查询Eip个数
URI
GET /v1/{project_id}/eip-count/{object_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目ID, 可以从调API处获取，也可以从控制台获取。项目ID获取方式 |
| object_id | 是 | String | 防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口获得，通过返回值中的data.records.protect_objects.object_id（.表示各对象之间层级的区分）获得，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id。此处仅取type为0的防护对象id，可通过data.records.protect_objects.type（.表示各对象之间层级的区分）获得。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| enterprise_project_id | 否 | String | 企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0 |
| fw_instance_id | 否 | String | 防火墙id，可通过防火墙ID获取方式获取 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 用户Token。可通过如何获取用户Token获取。 |
| Content-Type | 是 | String | 内容类型，只有application/json的值是适用的 |
响应参数
状态码：200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| data | EipCountRespData object | Eip计数数据 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| eip_total | Integer | 总体EIP数 |
| eip_protected | Integer | 该账号下所有墙防护EIP总数量 |
| eip_protected_self | Integer | 当前防火墙防护EIP数量 |
状态码：400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误描述 |
请求示例
查询项目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 |
错误码
请参见错误码。
