Querying the Geolocation Access Control Rule List
Function
This API is used to query the geolocation access control rule list.
Debugging
You can use API Explorer to debug this API.
URI
GET /v1/{project_id}/waf/policy/{policy_id}/geoip
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID |
| policy_id | Yes | String | Policy ID. It can be obtained by calling the API for querying the policy list. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| enterprise_project_id | No | String | Enterprise project ID |
| page | No | Integer | Page number Default: 1 |
| pagesize | No | Integer | Number of records on each page Default: 10 |
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 Default: application/json;charset=utf8 |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| total | Integer | Number of blocked locations in the geolocation access control rules |
| items | Array of objects | List of the blocked locations in the geolocation access control rules |
| Parameter | Type | Description |
|---|---|---|
| id | String | Rule ID |
| geoip | String | Blocked locations in the geolocation access control rules |
| white | Integer | Protective action for the rule. You can configure Allow or Block action. |
| timestamp | Long | Time the rule was created |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code |
| error_msg | String | Error code message |
Status code: 401
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code |
| error_msg | String | Error code message |
Status code: 500
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code |
| error_msg | String | Error code message |
Example Requests
None
Example Responses
None
Status Codes
| Status Code | Description |
|---|---|
| 200 | OK |
| 400 | Request failed |
| 401 | Insufficient token permissions |
| 500 | Internal server error |
Error Codes
See Error Codes.
Last Article: Deleting a Data Masking Rule
Next Article: Creating a Geolocation Access Control Rule
Did this article solve your problem?
Thank you for your score！Your feedback would help us improve the website.