Help Center/ Edge Security/ API Reference/ API/ HTTP Protection Rule Management - Geographical Location/ This API is used to query the geolocation access control rules.

Updated on 2024-11-18 GMT+08:00

View PDF

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

Function

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

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
policy_id	Yes	String	Policy ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
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 ShowHttpGeoIpRuleResponseBody objects	Protection rule list

**Table 5** ShowHttpGeoIpRuleResponseBody
Parameter	Type	Description
id	String	Rule ID
name	String	Rule name
policyid	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 enabling status
geo_ip	String	Geo-location
geo_tag_list	Array of strings	Geographical location list
white	Integer	Block/Allow/Record only

Status code: 400

**Table 6** 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 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: 500

**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.

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.

Parent topic: HTTP Protection Rule Management - Geographical Location

Previous topic: HTTP Protection Rule Management - Geographical Location

Next topic: This API is used to create a geolocation access control rule.

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.