文档首页/ 云防火墙 CFW/ API参考/ API/ 防火墙管理/ 查询南北向防火墙防护状态
更新时间:2025-08-28 GMT+08:00
分享

查询南北向防火墙防护状态

功能介绍

查询南北向防火墙防护状态

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/eip/protection-status/{fw_instance_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以从调API处获取,也可以从控制台获取。项目ID获取方式

约束限制

不涉及

取值范围

32位UUID

默认取值

不涉及

fw_instance_id

String

参数解释

防火墙ID,用户创建防火墙实例后产生的唯一ID,配置后可区分不同防火墙,可通过防火墙ID获取方式获取

约束限制

不涉及

取值范围

32位UUID

默认取值

不涉及

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

data

FirewallProtectionStatusVO object

参数解释

查询南北向防火墙防护状态响应data

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

表3 FirewallProtectionStatusVO

参数

参数类型

描述

protection_status

Integer

参数解释

防火墙防护状态,0: 正常状态, 1: bypass进行中, 2: bypass成功, 3: bypass失败, 4: 恢复中, 5: 恢复失败

取值范围

不涉及

id

String

参数解释

防火墙ID,用户创建防火墙实例后产生的唯一ID,配置后可区分不同防火墙,可通过防火墙ID获取方式获取

约束限制

不涉及

取值范围

32位UUID

默认取值

不涉及

object_id

String

参数解释

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

约束限制

不涉及

取值范围

32位UUID

默认取值

不涉及

failed_eip_list

Array of strings

参数解释

bypass失败的eip列表。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

failed_eip_id_list

Array of strings

参数解释

bypass失败的eip id列表。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

状态码:400

表4 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码

取值范围

不涉及

error_msg

String

参数解释

错误描述

取值范围

不涉及

请求示例

查询项目id为eefb11b22d5944f2aa067954516df1cf,防火墙实例id为175572ed-67e8-4837-9776-e2e07080ea45的防火墙防护状态

https://{Endpoint}/v1/eefb11b22d5944f2aa067954516df1cf/eip/protection-status/175572ed-67e8-4837-9776-e2e07080ea45

响应示例

状态码:200

OK

{
  "data" : {
    "protection_status" : 0,
    "id" : "175572ed-67e8-4837-9776-e2e07080ea45",
    "object_id" : "af30c598-b185-4b3e-9271-3d1393acd43e"
  }
}

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码

相关文档