Help Center/ Edge Security/ API Reference/ API/ IP Address Group Management/ Querying IP Address Groups

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

View PDF

Querying IP Address Groups

Function

This API is used to query IP address groups.

URI

GET /v1/edgesec/configuration/http/ip-groups

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Obtain the enterprise project ID by calling the ListEnterpriseProject API of Enterprise Project Management Service (EPS). The default value is 0.
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.
name	No	String	IP address group name
ip	No	String	IP address/range

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Tenant token

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
total	Integer	Total number of IP address groups
items	Array of ShowHttpIpGroupResponseBody objects	Detailed information about the IP address group.

**Table 4** ShowHttpIpGroupResponseBody
Parameter	Type	Description
id	String	IP address group ID.
name	String	IP address group name
ips	String	IP address/range.
size	String	IP address/address segment size
description	String	IP address group remarks
timestamp	Long	Time when the IP address group was created.
rules	Array of HttpRuleInfo objects	List of policies and rules that use the IP address group.

**Table 5** HttpRuleInfo
Parameter	Type	Description
rule_id	String	Rule ID in the policy.
rule_name	String	Rule name in the policy.
policy_id	String	Policy ID.
policy_name	String	Policy name.

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	Request successful.
400	Request failed.
401	The token does not have required permissions.
500	Internal server error.

Error Codes

See Error Codes.

Parent topic: IP Address Group Management

Previous topic: IP Address Group Management

Next topic: Creating an IP Address Group

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.