- What's New
- Function Overview
- Service Overview
- Getting Started
-
User Guide
- Creating a User Group and Granting Permissions
- Checking the Dashboard
- Purchasing and Changing the Specifications of CFW
- 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
- Viewing Audit Logs
- Viewing Monitoring Metrics
-
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
-
API Reference
- Before You Start
- API Overview
- API Calling
-
API
- Domain Name Management
- VPC Protection
- Rule Hit Count
- IPS Switch Management
- East-west Protection
- ACL Rule Management
- Blacklist and Whitelist Management
- Log Query Management
- Protection Mode Management
- Cloud Firewall Information Management
- Service Group Management
- Service Group Member Management
- EIP Management
- Address Group Member Management
- Address Group Management
- Appendix
- Change History
- SDK Reference
-
FAQs
-
About the Product
- Does CFW Support Off-Cloud Servers?
- 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?
- How Long Are CFW Logs Stored by Default?
- Regions and AZs
- Troubleshooting
-
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?
- Billing
-
About the Product
- Videos
Returned Values
Status Code
After sending a request, you will receive a response, including a status code, response header, and response body.
A status code is a group of digits, ranging from 1xx to 5xx. It indicates the status of a request. For more information, see Status Code.
For example, if status code 201 is returned for calling the API used to obtain a user token, the request is successful.
Response Header
A response header corresponds to a request header, for example, Content-Type.
Figure 1 shows the response header for the API of obtaining a user token, in which x-subject-token is the desired user token. Then, you can use the token to authenticate the calling of other APIs.
(Optional) Response Body
A response body is generally returned in a structured format, corresponding to the Content-Type in the response header, and is used to transfer content other than the response header.
The following shows part of the response body for the API to obtain a user token. For the sake of space, only part of the content is displayed here.
{
"token": {
"expires_at": "2019-02-13T06:52:13.855000Z",
"methods": [
"password"
],
"catalog": [
{
"endpoints": [
{
"region_id": "xxxxxxxx",
......If an error occurs during API calling, the system returns an error code and a message to you. The following shows the format of an error response body:
{
"error": {
"message": "The request you have made requires authentication.",
"title": "Unauthorized"
}
}In the preceding information, error_code is an error code, and error_msg describes the error.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
