Help Center/ Web Application Firewall/ API Reference/ APIs/ Rule Management/ Querying the List of Geolocation Access Control Rules
Updated on 2024-04-25 GMT+08:00

Querying the List of Geolocation Access Control Rules

Function

This API is used to query the list of geolocation access control rules.

URI

GET /v1/{project_id}/waf/policy/{policy_id}/geoip

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. To obtain it, go to Cloud management console and hover the cursor over your username. On the displayed window, choose My Credentials.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.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

You can obtain the ID by calling the ListEnterpriseProject API of 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.

Default: 1

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.

Default: 10

Request Parameters

Table 3 Request header 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.

Default: application/json;charset=utf8

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total

Integer

Number of geolocation access control rules in the policy

items

Array of GeOIpItem objects

Array of geolocation access control rues

Table 5 GeOIpItem

Parameter

Type

Description

id

String

Rule ID

policyid

String

Policy ID

name

String

Name of the geolocation access control rue

geoip

String

Locations that can be configured in the geolocation access control rule: (Countries/Regions outside China: CA: Canada, South Africa: South Africa, Mexico: Mexico, Peru: Peru, Indonesia: Indonesia) For details about the location code, see Appendix - Geographical Location Codes.

white

Integer

Protective action

  • 0: WAF blocks requests that hit the rule.

  • 1: WAF allows requests that hit the rule.

  • 2: WAF only record requests that hit the rule.

status

Integer

Rule status.

  • true: enabled.

  • false: disabled.

timestamp

Long

Time the rule is created.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Example Requests

The following example shows how to query the geolocation access control 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}/geoip?enterprise_project_id=0

Example Responses

Status code: 200

OK

{
  "total" : 1,
  "items" : [ {
    "id" : "06f07f6c229141b9a4a78614751bb687",
    "policyid" : "2abeeecefb9840e6bf05efbd80d0fcd7",
    "timestamp" : 1636340038062,
    "status" : 1,
    "geoip" : "GD",
    "white" : 1,
    "name" : "demo"
  } ]
}

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.