Help Center/ Edge Security/ API Reference/ API/ HTTP Protection Rule Management - IP Address Blacklist and Whitelist/ This API is used to query IP address blacklist and whitelist rules.
Updated on 2024-11-18 GMT+08:00
View PDF
Share

This API is used to query IP address blacklist and whitelist rules.

Function

This API is used to query IP address blacklist and whitelist rules.

URI

GET /v1/edgesec/configuration/http/policies/{policy_id}/blocktrustip-rule

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

policy_id

Yes

String

Policy ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

name

No

String

Rule name

addr

No

String

IP address/IP address segment.

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.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

auth token

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total

Integer

Number of protection rules in a policy

items

Array of ShowHttpBlockTrustIpRuleResponseBody objects

Protection rule list

size

Long

Number of IP addresses or IP address segments in a protection rule
Table 5 ShowHttpBlockTrustIpRuleResponseBody

Parameter

Type

Description

id

String

Rule ID.

name

String

Rule name.

policy_id

String

ID of the policy to which the rule belongs

policy_name

String

Name of the policy to which the rule belongs

timestamp

Long

Time when a rule is created

description

String

Rule description

status

Integer

Rule status:

  • 0: disabled

  • 1: enabled

addr

String

IP address/address segment

white

Integer

  • 0: Block

  • 1: Allow

  • 2: Record only

followed_action_id

String

Attack penalty rule ID

ip_group

HttpIpGroup object

IP address group
Table 6 HttpIpGroup

Parameter

Type

Description

id

String

IP address group ID

name

String

IP address group name

ips

Array of strings

IP address/address segment list

size

Integer

IP address/address segment size

description

String

IP address group description

create_time

Long

Timestamp when an IP address group is created

Status code: 400

Table 7 Response body parameters

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

Table 8 Response body parameters

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

Table 9 Response body parameters

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.