Adding Threat Intelligence Access Control Rules to Multiple Policies At Once
Function
This API is used to add a threat intelligence access control rule to multiple policies at once.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/waf/rule/ip-reputation
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition Project ID. To obtain it, log in to the Huawei Cloud console, click the username, choose My Credentials, and find the project ID in the Projects list. Constraints N/A Range The value contains 32 characters. Only letters and digits are supported. Default Value N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| policyids | No | String | Definition Policy ID list. Obtain the policy ID by calling the ListPolicy API. Policies are separated by commas (,). Constraints N/A Range N/A Default Value N/A |
| enterprise_project_id | No | String | Definition Obtain the enterprise project ID by calling the ListEnterpriseProject API of Enterprise Project Management Service (EPS). To obtain the resource details in all enterprise projects of a user, set this parameter to all_granted_eps. Constraints N/A Range Default Value 0 |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | No | String | Definition User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the 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 | Yes | String | Definition Rule name. Constraints Length range: [1, 256] Range N/A Default Value N/A |
| type | Yes | String | Definition Reputation type (currently, only IDC is supported). Constraints N/A Range Default Value N/A |
| tags | Yes | Array of strings | Definition Tag list. Tags are used to specify the associated indicator identifiers. They can be queried through the ConfirmPolicyIpReputationMap API. Multiple identifiers are separated by commas (,). Constraints A tag can appear only once across multiple rules. That is, the tag lists of multiple rules cannot overlap. Range N/A Default Value N/A |
| action | Yes | action object | Definition Protective action configuration. 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 |
| policy_ids | Yes | Array of strings | Definition IDs of policies to which rules are added. Obtain the policy ID by calling the ListPolicy API. Policies are separated by commas (,). Constraints Cannot be empty. 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 | Long | 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
Select multiple policies and add a threat intelligence access control rule to them all at once.
POST https://{endpoint}/v1/{project_id}/waf/rule/ip-reputation?enterprise_project_id=0
{
"name" : "dddd",
"type" : "idc",
"tags" : [ "HW", "Google" ],
"action" : {
"category" : "block"
},
"policy_ids" : [ "1368ab6534634aaf9e0fd7575d0d3584", "9d7f27e4073640618ee20947471f1a25" ]
} Example Responses
Status code: 200
Definition
OK
Constraints
N/A
Range
N/A
Default Value
N/A
{
"name" : "dddd",
"type" : "idc",
"tags" : [ "HW", "Google" ],
"action" : {
"category" : "block"
}
} SDK Sample Code
The SDK sample code is as follows.
Select multiple policies and add a threat intelligence access control rule to them all at once.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 | package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.waf.v1.region.WafRegion; import com.huaweicloud.sdk.waf.v1.*; import com.huaweicloud.sdk.waf.v1.model.*; import java.util.List; import java.util.ArrayList; public class BatchCreateIpReputationRuleSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); WafClient client = WafClient.newBuilder() .withCredential(auth) .withRegion(WafRegion.valueOf("<YOUR REGION>")) .build(); BatchCreateIpReputationRuleRequest request = new BatchCreateIpReputationRuleRequest(); BatchCreateIpReputationRuleRequestBody body = new BatchCreateIpReputationRuleRequestBody(); List<String> listbodyPolicyIds = new ArrayList<>(); listbodyPolicyIds.add("1368ab6534634aaf9e0fd7575d0d3584"); listbodyPolicyIds.add("9d7f27e4073640618ee20947471f1a25"); BatchCreateIpReputationRuleRequestBodyAction actionbody = new BatchCreateIpReputationRuleRequestBodyAction(); actionbody.withCategory(BatchCreateIpReputationRuleRequestBodyAction.CategoryEnum.fromValue("block")); List<String> listbodyTags = new ArrayList<>(); listbodyTags.add("HW"); listbodyTags.add("Google"); body.withPolicyIds(listbodyPolicyIds); body.withAction(actionbody); body.withTags(listbodyTags); body.withType(BatchCreateIpReputationRuleRequestBody.TypeEnum.fromValue("idc")); body.withName("dddd"); request.withBody(body); try { BatchCreateIpReputationRuleResponse response = client.batchCreateIpReputationRule(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Select multiple policies and add a threat intelligence access control rule to them all at once.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkwaf.v1.region.waf_region import WafRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkwaf.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = WafClient.new_builder() \ .with_credentials(credentials) \ .with_region(WafRegion.value_of("<YOUR REGION>")) \ .build() try: request = BatchCreateIpReputationRuleRequest() listPolicyIdsbody = [ "1368ab6534634aaf9e0fd7575d0d3584", "9d7f27e4073640618ee20947471f1a25" ] actionbody = BatchCreateIpReputationRuleRequestBodyAction( category="block" ) listTagsbody = [ "HW", "Google" ] request.body = BatchCreateIpReputationRuleRequestBody( policy_ids=listPolicyIdsbody, action=actionbody, tags=listTagsbody, type="idc", name="dddd" ) response = client.batch_create_ip_reputation_rule(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Select multiple policies and add a threat intelligence access control rule to them all at once.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" waf "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := waf.WafClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := waf.NewWafClient(hcClient) request := &model.BatchCreateIpReputationRuleRequest{} var listPolicyIdsbody = []string{ "1368ab6534634aaf9e0fd7575d0d3584", "9d7f27e4073640618ee20947471f1a25", } actionbody := &model.BatchCreateIpReputationRuleRequestBodyAction{ Category: model.GetBatchCreateIpReputationRuleRequestBodyActionCategoryEnum().BLOCK, } var listTagsbody = []string{ "HW", "Google", } request.Body = &model.BatchCreateIpReputationRuleRequestBody{ PolicyIds: listPolicyIdsbody, Action: actionbody, Tags: listTagsbody, Type: model.GetBatchCreateIpReputationRuleRequestBodyTypeEnum().IDC, Name: "dddd", } response, err := client.BatchCreateIpReputationRule(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
| Status Code | Description |
|---|---|
| 200 | Definition OK Constraints N/A Range N/A Default Value N/A |
| 400 | Definition Request failed. Constraints N/A Range N/A Default Value N/A |
| 401 | Definition The token does not have required permissions. Constraints N/A Range N/A Default Value N/A |
| 500 | Definition Internal server error. Constraints N/A Range N/A Default Value N/A |
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