Querying the Blacklist and Whitelist Rule List
Function
This API is used to query the list of blacklist and whitelist rules.
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/waf/policy/{policy_id}/whiteblackip
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. To obtain it, go to Huawei Cloud management cons**. Then, in the Projects area, view Project ID of the corresponding project. |
policy_id |
Yes |
String |
Policy ID. It can be obtained by calling the ListPolicy API. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
You can obtain the ID by calling the ListEnterpriseProject API of EPS. To query resources associated with all enterprise projects in the current account, specify parameter all_granted_eps. |
page |
No |
Integer |
Page number of the data to be returned during pagination query. The default value is 1, indicating that the data on the first page is returned. |
pagesize |
No |
Integer |
Number of results on each page during pagination query. Value range: 1 to 100. The default value is 10, indicating that each page contains 10 results. |
name |
No |
String |
Name of the whitelist or blacklist rule. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). |
Content-Type |
Yes |
String |
Content type. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total |
Integer |
Number of the whitelist and blacklist rules. |
items |
Array of WhiteBlackIpResponseBody objects |
Details of blacklist or whitelist rules. |
size |
Integer |
Number of the Ip addresses |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Rule ID. |
name |
String |
Name of the whitelist or blacklist rule. |
policyid |
String |
Policy ID. |
timestamp |
Long |
Timestamp (ms) when the rule was created. |
description |
String |
Rule description. |
status |
Integer |
Rule status. The value can be 0 or 1. |
addr |
String |
IP address/IP address group |
white |
Integer |
Protective action |
ip_group |
Ip_group object |
IP address group. |
time_mode |
String |
The rule application method. Default value: permanent, indicating that the rule will be applied once it is configured. |
start |
Long |
Effective start time. This parameter is valid only when time_Mode is set to customize. |
terminal |
Long |
Effective end time. This parameter is valid only when time_Mode is set to customize. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
ID of the IP address group. |
name |
String |
Name of the IP address group. |
size |
Long |
Number of IP addresses or IP address ranges in the IP address group. |
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. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error codes of the downstream service. |
error_msg |
String |
Error messages of the downstream service. |
Example Requests
The following example shows how to query the whitelist and blacklist rule list in a project. The project ID is specified by project_id, and the policy is specified by policy_id.
GET https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/whiteblackip?enterprise_project_id=0
Example Responses
Status code: 200
OK
{ "total" : 1, "items" : [ { "id" : "3c96caf769ca4f57814fcf4259ea89a1", "policyid" : "4dddfd44fc89453e9fd9cd6bfdc39db2", "name" : "hkhtest", "timestamp" : 1650362891844, "description" : "demo", "status" : 1, "addr" : "x.x.x.x", "white" : 0 } ] }
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