Creating a Known Attack Source Rule.
Function
This API is used to create a known attack source rule.
URI
POST /v1/edgesec/configuration/http/policies/{policy_id}/punishment-rule
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
policy_id |
Yes |
String |
Policy ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
auth token |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
description |
No |
String |
Rule description, which contains a maximum of 512 characters. |
category |
Yes |
String |
Blocking type. The options are as follows: long_ip_block (long-time IP address blocking), long_cookie_block (long-time cookie blocking), long_params_block (long-time parameter blocking), and short_ip_block (short-time IP address blocking). short_cookie_block (short-time cookie blocking) and short_params_block (short-time parameter blocking) |
block_time |
Yes |
Integer |
Blocking duration. If the prefix of the attack penalty type is long, the value range of block_time is 301-1800. If the prefix of the attack penalty type is short, the value range of block_time is 0-300. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
id |
String |
Rule ID |
policy_id |
String |
ID of the policy to which the rule belongs |
timestamp |
Long |
Time when a rule is created |
description |
String |
Rule description |
category |
String |
Blocking type. The options are as follows: long_ip_block (long-time IP address blocking), long_cookie_block (long-time cookie blocking), long_params_block (long-time parameter blocking), and short_ip_block (short-time IP address blocking). short_cookie_block (short-time cookie blocking) and short_params_block (short-time parameter blocking) |
block_time |
Integer |
Blocking duration. |
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 |
OK |
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