文档首页/ 云防火墙 CFW/ API参考/ API/ EIP管理/ 获取eip自动防护状态信息
更新时间：2024-12-25 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取eip自动防护状态信息

功能介绍

获取eip自动防护状态信息

调用方法

请参见如何调用API。

URI

GET /v1/{project_id}/eip/auto-protect-status/{object_id}

表1 路径参数

参数

是否必选

参数类型

描述

object_id

是

String

防护对象ID，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口获得，通过返回值中的data.records.protect_objects.object_id（.表示各对象之间层级的区分）获得，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id。此处仅取type为1的防护对象id，可通过data.records.protect_objects.type（.表示各对象之间层级的区分）获得。

project_id

是

String

项目ID，可以从调API处获取，也可以从控制台获取。可通过项目ID获取方式获取
表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token，可通过如何获取用户Token获取

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

data

FirewallStatusVO object

防火墙状态对象
表5 FirewallStatusVO

参数

参数类型

描述

available_eip_count

Integer

可防护eip数量

beyond_max_count

Boolean

是否超出eip数量限制

eip_protected_self

Integer

已防护eip数量

eip_total

Integer

eip总数

eip_un_protected

Integer

未防护eip数量

object_id

String

防护对象id

status

Integer

是否开启新增eip自动防护，1；是，0：否

请求示例

获取项目id为408972e72dcd4c1a9b033e955802a36b的EIP自动防护状态信息，防火墙id为e743cfaf-8164-4807-aa13-d893d83313cf，企业项目id为fb55459c-41b3-47fc-885d-540946fddda4，目标对象id为1b90f031-0c7b-4f25-95e2-b6d9940d269e。

https://{Endpoint}/v1/408972e72dcd4c1a9b033e955802a36b/eip/auto-protect-status/1b90f031-0c7b-4f25-95e2-b6d9940d269e?fw_instance_id=e743cfaf-8164-4807-aa13-d893d83313cf&enterprise_project_id=fb55459c-41b3-47fc-885d-540946fddda4&object_id=1b90f031-0c7b-4f25-95e2-b6d9940d269e&project_id=408972e72dcd4c1a9b033e955802a36b

响应示例

状态码： 200

OK

{
  "data" : {
    "available_eip_count" : 50,
    "beyond_max_count" : false,
    "eip_protected_self" : 15,
    "eip_total" : 24,
    "eip_un_protected" : 9,
    "object_id" : "1b90f031-0c7b-4f25-95e2-b6d9940d269e",
    "status" : 1
  }
}

状态码

状态码

描述

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码。

父主题： EIP管理

相关文档