Querying IP Address Groups
Function
This API is used to query IP address groups.
URI
GET /v1/edgesec/configuration/http/ip-groups
|
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
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
Tenant token |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
total |
Integer |
Total number of IP address groups |
|
items |
Array of ShowHttpIpGroupResponseBody objects |
Detailed information about the IP address group. |
|
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. |
|
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
|
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
|
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
|
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot