This API is used to query the protection policy list.
Function
This API is used to query the protection policy list.
URI
GET /v1/edgesec/configuration/http/policies
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
ID of the enterprise project. It can be obtained by calling the ListEnterpriseProject API of EPS. |
page |
No |
Integer |
Page number, which is required for pagination query. |
pagesize |
No |
Integer |
Pagination query parameter. The number of records displayed on each page is specified by pagesize. |
name |
No |
String |
Policy name used for fuzzy query |
hostname |
No |
String |
Domain name used for fuzzy query |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Tenant token |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total |
Integer |
Total number of policies. |
items |
Array of ShowHttpPolicyResponseBody objects |
Content of the policy. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Policy ID. |
name |
String |
Protection policy name. |
level |
Integer |
Protection level. |
full_detection |
Boolean |
Detection mode in the precise protection rule. |
action |
HttpPolicyAction object |
Operation. |
robot_action |
HttpPolicyAction object |
Operation. |
options |
HttpPolicyOption object |
Option. |
bind_host |
Array of HttpPolicyBindHost objects |
Basic information about the protected domain. |
extend |
Map<String,String> |
Extended field. |
third_bot_options |
Map<String,third_bot_options> |
Third-party BOT operation. |
wap_managed_ruleset_id |
String |
ID of the hosting rule set for basic web protection. |
Parameter |
Type |
Description |
---|---|---|
category |
String |
Protection level. |
followed_action_id |
String |
Attack penalty rule ID. |
Parameter |
Type |
Description |
---|---|---|
webattack |
Boolean |
Whether basic web protection is enabled. |
common |
Boolean |
Whether general check is enabled. |
bot_enable |
Boolean |
Whether full anti-crawler protection is enabled. |
crawler |
Boolean |
Whether anti-crawler protection with feature libraries is enabled. |
crawler_engine |
Boolean |
Whether the search engine is enabled. |
crawler_scanner |
Boolean |
Whether the scanner is enabled. |
crawler_script |
Boolean |
Whether the JavaScript anti-crawler is enabled. |
crawler_other |
Boolean |
Whether other crawler check is enabled. |
webshell |
Boolean |
Whether web shell detection is enabled |
cc |
Boolean |
Whether the CC attack protection rule is enabled. |
custom |
Boolean |
Whether precise protection is enabled. |
followed_action |
Boolean |
Whether known attack source detection is enabled. |
whiteblackip |
Boolean |
Whether blacklist and whitelist protection is enabled. |
geoip |
Boolean |
Whether the geolocation rule is enabled. |
ignore |
Boolean |
Whether false alarm masking is enabled. |
privacy |
Boolean |
Whether data masking is enabled. |
antitamper |
Boolean |
Whether the web tamper protection is enabled. |
antileakage |
Boolean |
Whether the information leakage prevention is enabled. |
anticrawler |
Boolean |
Whether the JavaScript anti-crawler rule is enabled. |
third_bot_river |
Boolean |
Whether the third-party BOT is enabled |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Domain name ID. |
hostname |
String |
Domain name. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Standard error code: service name.8-digit code |
error_msg |
String |
Detailed error information. |
encoded_authorization_message |
String |
If the service is integrated with IAM5.0, an IAM response must be returned when access is denied. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Standard error code: service name.8-digit code |
error_msg |
String |
Detailed error information. |
encoded_authorization_message |
String |
If the service is integrated with IAM5.0, an IAM response must be returned when access is denied. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Standard error code: service name.8-digit code |
error_msg |
String |
Detailed error information. |
encoded_authorization_message |
String |
If the service is integrated with IAM5.0, an IAM response must be returned when access is denied. |
Example Requests
None
Example Responses
None
Status Codes
Status Code |
Description |
---|---|
200 |
Request successful. |
400 |
Request failed. |
401 |
The token does not have required permissions. |
500 |
Internal server error. |
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