Help Center/ Cloud Firewall/ API Reference/ API/ Firewall Management/ Querying the Protection Status of a Firewall

Updated on 2025-08-11 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying the Protection Status of a Firewall

Function

This API is used to query the protection status of a firewall.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.
fw_instance_id	Yes	String	Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
data	FirewallProtectionStatusVO object	Return value for querying the firewall protection status.
trace_id	String	Call path ID.
error_code	String	Error Code
fail_reason	String	Error Cause
error_description	String	Error description.

**Table 3** FirewallProtectionStatusVO
Parameter	Type	Description
protection_status	String	Firewall protection status: 0 (normal), 1 (bypass in progress), 2 (bypass succeeded), 3 (bypass failed), 4 (recovery in progress), or 5 (recovery failed).
id	String	Firewall ID.
object_id	String	Protected object ID.
failed_eip_list	Array of strings	EIPs where the kill switch (one-click unprotection) or one-click protection restoration failed.
failed_eip_id_list	Array of strings	ID list of the EIPs where the kill switch (one-click unprotection) or one-click protection restoration failed.

Example Requests

Query the protection status of the firewall whose ID is 713e174b-cea6-4190-8dfc-c83634eadf2d.

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

Example Responses

Status code: 200

{
  "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]
  }
}