文档首页/ 云防火墙 CFW/ API参考/ API/ 防火墙管理/ 查询防火墙的防护状态
更新时间:2025-08-12 GMT+08:00

查询防火墙的防护状态

功能介绍

查询防火墙的防护状态

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID,可以通过调用API获取,也可以从控制台获取。项目ID获取方式

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

fw_instance_id

String

参数解释

防火墙ID,可通过防火墙ID获取方式获取

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

data

FirewallProtectionStatusVO object

参数解释

查询防火墙防护状态的返回值

约束限制

不涉及

trace_id

String

参数解释

调用路径id

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

error_code

String

参数解释

错误码

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

fail_reason

String

参数解释

错误原因

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

error_description

String

参数解释

错误信息描述

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

表3 FirewallProtectionStatusVO

参数

参数类型

描述

protection_status

String

参数解释

防火墙防护状态

约束限制

不涉及

取值范围

  • 0:正常状态

  • 1:bypass进行中

  • 2: bypass成功

  • 3:bypass失败

  • 4:恢复中

  • 35:恢复失败

默认取值

不涉及

id

String

参数解释

防火墙ID

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

object_id

String

参数解释

防护对象ID

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

failed_eip_list

Array of strings

参数解释

一键逃生/一键恢复失败的EIP列表

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

failed_eip_id_list

Array of strings

参数解释

一键逃生/一键恢复失败的EIP的ID列表

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

请求示例

查询防火墙ID为713e174b-cea6-4190-8dfc-c83634eadf2d的防护状态

/cfw/v1/82ae1aa0-883c-4428-b2e1-2910798d95fd/eip/protection-status/713e174b-cea6-4190-8dfc-c83634eadf2d

响应示例

状态码:200

OK

{
  "data": {
    "protection_status": "BYPASS_FAILED",
    "id": "713e174b-cea6-4190-8dfc-c83634eadf2d",
    "object_id": "82ae1aa0-883c-4428-b2e1-2910798d95fd",
    "failed_eip_list": [10.10.10.100, 10.10.10.101],
    "failed_eip_id_list": [0c45fa66-1dd3-459b-b6f3-55e6e2ccb31c, 1bb840a6-8158-45e6-8a76-279ec903887b]
  }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码