- What's New
- Function Overview
- Service Overview
- Billing
- Getting Started
-
User Guide
- Creating a User Group and Granting Permissions
- Purchasing and Changing the Specifications of CFW
- CFW Dashboard
- CFW Protection
-
Access Control
- Access Control Policy Overview
-
Configuring an Access Control Policy
- Configuring Protection Rules to Block or Allow Internet Border Traffic
- Configuring Protection Rules to Block or Allow VPC Border Traffic
- Configuring Protection Rules to Block or Allow NAT Gateway Border Traffic
- Example 1: Allowing the Inbound Traffic from a Specified IP Address
- Example 2: Blocking Access from a Region
- Example 3: Allowing Traffic from a Service to a Platform
- Example 4: Configuring SNAT Protection Rules
- Adding Blacklist or Whitelist Items to Block or Allow Traffic
- Quickly Block Malicious Traffic Through Traffic Blocking
- Viewing Protection Information Using the Policy Assistant
- Managing ACL Policies
- Managing Object Groups
- Attack Defense
- Traffic Analysis
- Log Audit
- System Management
- Permissions Management
- Using Cloud Eye to Monitor CFW
- CTS Auditing
-
Best Practices
- CFW Best Practice Summary
- Purchasing and Querying CFW via API
- Migrating Security Policies to CFW in Batches
- Configuration Suggestions for Using CFW with WAF, Advanced Anti-DDoS, and CDN
- Allowing Internet Traffic Only to a Specified Port
- Allowing Outbound Traffic from Cloud Resources Only to a Specified Domain Name
- Using CFW to Defend Against Network Attacks
- Configuring a Protection Rule to Protect Traffic Between Two VPCs
- Configuring a Protection Rule to Protect SNAT Traffic
- Using CFW to Protect Enterprise Resources
- Using CFW to Protect EIPs Across Accounts
- Using CFW to Protect VPCs Across Accounts
- CFW Security Best Practices
-
API Reference
- Before You Start
- API Overview
- API Calling
-
API
-
Firewall Management
- Creating a Firewall
- Obtaining the Status of a CFW Task
- Deleting a Firewall
- Querying the Firewall List
- Changing the East-West Firewall Protection Status
- Querying Firewall Details
- Obtaining East-West Firewall Information
- Creating an East-West Firewall
- Querying the Number of Protected VPCs
- Creating a Tag
- Deleting a Tag
- Querying the Protection Status of a Firewall
- EIP Management
-
ACL Rule Management
- Creating an ACL Rule
- Deleting an ACL Rule
- Deleting ACL Rules in Batches
- Deleting the Number of Rule Hits
- Updating an ACL Rule
- Updating Rule Actions in Batches
- Setting the Priority of an ACL Protection Rule
- Querying a Protection Rule
- Querying Rule Tags
- Obtaining the Number of Rule Hits
- Viewing the Region List
- Checking the ACL Import Status
- Blacklist/Whitelist Management
-
Address Group Management
- Adding an Address Group
- Adding an Address Group Member
- Deleting an Address Group
- Deleting an Address Group Member
- Deleting Address Group Members in Batches
- Updating Address Group Information
- Querying the Address Group List
- Querying Address Group Details
- Querying Address Group Members
- Updating the Object Configuration Description
- Service Group Management
-
Domain Name Resolution and Domain Name Group Management
- Adding a Domain Name Group
- Deleting a Domain Name Group
- Updating a Domain Name Group
- Updating the DNS Server List
- Querying the Domain Name Group List
- Querying the DNS Server List
- Querying the IP Address for Domain Name Resolution
- Obtain the list of domain names in a domain name group
- Adding a Domain Name List
- Deleting a Domain Name List
- Viewing Domain Group Details
- Obtaining the DNS Resolution Result of a Domain Name
- Deleting Domain Groups in Batches
-
IPS management
- Querying the Status of the IPS Feature
- Changing the IPS Feature Status
- Querying a Protection Mode
- Changing the Protection Mode
- Changing the IPS Rule Mode
- Updating a Frequency IPS Rule
- Querying Frequency IPS Rule Information
- Obtaining the IPS Rule List
- Obtaining the IPS Rule Update Time
- Obtaining Custom IPS Rules
- Log Management
- Packet Capture Management
- Antivirus Management
- Alarm Configuration Management
- Tag Management
-
Filtering traffic
- Importing an IP Address Blacklist for Traffic Filtering
- Obtain the imported IP address blacklist.
- Deleting the Imported IP Address Blacklist
- Exporting the IP Address Blacklist for Traffic Filtering
- Re-importing the IP Address Blacklist Used for Traffic Filtering After an Import Failed
- Enabling or Disabling the IP Address Blacklist for Traffic Filtering
- Obtaining the Traffic Filtering Switch Information
-
Firewall Management
- Appendix
- SDK Reference
-
FAQs
-
About the Product
- Does CFW Support On-premises Servers?
- What Traffic Does CFW Protect?
- What Are the QPS, New Connections, and Concurrent Connections Supported by CFW?
- Can CFW Be Shared Across Accounts?
- What Are the Differences Between CFW and WAF?
- What Are the Differences Between CFW, Security Groups, and Network ACLs?
- How Does CFW Control Access?
- What Are the Priorities of the Protection Settings in CFW?
- Can WAF, Advanced Anti-DDoS, and CFW Be Deployed Together?
- Can CFW Protect Resources Across Enterprise Projects?
- How Long Are CFW Logs Stored by Default?
- Regions and AZs
-
Troubleshooting
- Why Are Traffic and Attack Logs Incomplete?
- Why Does a Protection Rule Not Take Effect?
- Why Is No Data Displayed on the Access Control Logs Page?
- What Can I Do If Services Cannot Be Accessed After a Policy Is Configured on CFW?
- What Do I Do If IPS Blocks Normal Services?
- Why Is the IP Address Translated Using NAT64 Blocked?
- Why Some Permissions Become Invalid After a System Policy Is Granted to an Enterprise Project?
- What Do I Do If a Message Indicating Insufficient Permissions Is Displayed When I Configure LTS Logs?
- What Can I Do If Automatic EIP Protection Does Not Take Effect?
-
Network Traffic
- How Do I Calculate the Number of Protected VPCs and the Peak Protection Traffic at the VPC Border?
- How Does CFW Collect Traffic Statistics?
- What Is the Protection Bandwidth Provided by CFW?
- What Do I Do If My Service Traffic Exceeds the Protection Bandwidth?
- What Are the Differences Between the Data Displayed in Traffic Trend Module and the Traffic Analysis Page?
- How Do I Verify the Validity of an Outbound HTTP/HTTPS Domain Protection Rule?
- How Do I Obtain the Real IP Address of an Attacker?
- What Do I Do If a High Traffic Warning Is Received?
-
About the Product
- Videos
-
More Documents
-
User Guide (Ankara Region)
- Product Overview
- Checking the Dashboard
- Creating Cloud Firewall
- Enabling Internet Border Traffic Protection
- Enabling VPC Border Traffic Protection
-
Configuring Access Control Policies to Control Traffic
- Access Control Policy Overview
- Configuring Protection Rules to Block or Allow Traffic
- Adding Blacklist or Whitelist Items to Block or Allow Traffic
- Viewing Protection Information Using the Policy Assistant
- Managing Access Control Policies
- Managing IP Address Groups
- Domain Name Management
- Service Group Management
- Attack Defense
- Viewing Traffic Statistics
- Viewing CFW Protection Logs
- System Management
-
FAQs
-
About the Product
- Does CFW Support Off-Cloud Servers?
- What Are the QPS, New Connections, and Concurrent Connections Supported by CFW?
- Can CFW Be Shared Across Accounts?
- What Are the Differences Between CFW and WAF?
- What Are the Differences Between CFW, Security Groups, and Network ACLs?
- How Does CFW Control Access?
- What Are the Priorities of the Protection Settings in CFW?
- Can WAF and CFW Be Deployed Together?
- Troubleshooting
- Network Traffic
-
About the Product
- Change History
- API Reference (Ankara Region)
-
User Guide (Ankara Region)
- General Reference
Copied.
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}
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
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. |
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
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" ]
}
}
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot