Creating an IP Intelligence Rule
Function
This API is used to create an IP intelligence rule.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/waf/policy/{policy_id}/ip-reputation
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition Project ID of the user. Constraints N/A Range N/A Default Value N/A |
policy_id |
Yes |
String |
Definition Protection policy ID. You can call the ListPolicy API to obtain the policy ID. Constraints N/A Range N/A Default Value N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
Definition Obtain the enterprise project ID by calling the ListEnterpriseProject API of Enterprise Project Management Service (EPS). Constraints N/A Range N/A Default Value N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition User token. It can be obtained by calling the IAM API for obtaining a user token (value of X-Subject-Token in the response header). Constraints N/A Range N/A Default Value N/A |
Content-Type |
Yes |
String |
Definition Content type. Constraints N/A Range N/A Default Value application/json;charset=utf8 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
No |
String |
Definition Rule name. Constraints N/A Range N/A Default Value N/A |
policyname |
No |
String |
Definition Policy name. Constraints N/A Range N/A Default Value N/A |
description |
No |
String |
Definition Rule description. Constraints N/A Range N/A Default Value N/A |
status |
No |
Integer |
Definition Rule status. 1: enabled. 0: disabled. Constraints N/A Range N/A Default Value N/A |
action |
No |
action object |
Definition Protective action configuration. Constraints N/A Range N/A Default Value N/A |
type |
No |
String |
Definition Rule type, for example, idc indicates the data center IP intelligence type. Constraints N/A Range N/A Default Value N/A |
tags |
No |
Array of strings |
Definition Tag list. Tags are used to specify the associated intelligence identifiers. Constraints N/A Range N/A Default Value N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition Rule ID, which uniquely identifies a rule. Constraints N/A Range N/A Default Value N/A |
policyid |
String |
Definition Protection policy ID. Constraints N/A Range N/A Default Value N/A |
name |
String |
Definition Rule name. Constraints N/A Range N/A Default Value N/A |
policyname |
String |
Definition Policy name. Constraints N/A Range N/A Default Value N/A |
timestamp |
Integer |
Definition Rule creation timestamp (in ms). Constraints N/A Range N/A Default Value N/A |
description |
String |
Definition Rule description. Constraints N/A Range N/A Default Value N/A |
status |
Integer |
Definition Rule status. 1: enabled. 0: disabled. Constraints N/A Range N/A Default Value N/A |
type |
String |
Definition Rule type, for example, idc indicates the data center IP intelligence type. Constraints N/A Range N/A Default Value N/A |
tags |
Array of strings |
Definition Tag list, which is the associated intelligence IDs. Constraints N/A Range N/A Default Value N/A |
action |
action object |
Definition Protective action configuration. Constraints N/A Range N/A Default Value N/A |
Parameter |
Type |
Description |
---|---|---|
category |
String |
Definition Action type, for example, log indicates that attacks are logged only. Constraints N/A Range N/A Default Value N/A |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
encoded_authorization_message |
String |
You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs. |
details |
Array of IAM5ErrorDetails objects |
The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error codes of the downstream service. |
error_msg |
String |
Error messages of the downstream service. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
encoded_authorization_message |
String |
You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs. |
details |
Array of IAM5ErrorDetails objects |
The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error codes of the downstream service. |
error_msg |
String |
Error messages of the downstream service. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
encoded_authorization_message |
String |
You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs. |
details |
Array of IAM5ErrorDetails objects |
The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs. |
Example Requests
POST https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/ip-reputation?enterprise_project_id=0 { "name" : "name", "policyname" : "policy_name", "description" : "description", "status" : 1, "action" : { "category" : "log" }, "type" : "idc", "tags" : [ "Google" ] }
Example Responses
Status code: 200
OK
{ "id" : "3e57a557e2274f2686416afa77d6438b", "policyid" : "6d392034d94c4e8a95a78c98127453b6", "name" : "name", "policyname" : "policy_name", "timestamp" : 1657851399563, "description" : "description", "status" : 1, "type" : "idc", "tags" : [ "Google" ], "action" : { "category" : "log" } }
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