Help Center/ Edge Security/ API Reference/ API/ IP Address Group Management/ Querying an IP Address Group
Updated on 2024-11-18 GMT+08:00
View PDF
Share

Querying an IP Address Group

Function

This API is used to query an IP address group.

URI

GET /v1/edgesec/configuration/http/ip-groups/{ip_group_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

ip_group_id

Yes

String

IP address group ID

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

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 4 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 5 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 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: 500

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.

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.