Querying IP Addresses in an Address Group
Function
This API is used to query IP addresses included in an address group.
URI
GET /v1/{project_id}/waf/ip-group/{id}
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
project_id |
Yes |
String |
Project ID. To obtain it, go to Cloud management console and hover the cursor over your username. On the displayed window, choose My Credentials.Then, in the Projects area, view Project ID of the corresponding project. |
id |
Yes |
String |
ID of the IP address group. |
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
enterprise_project_id |
No |
String |
You can obtain the ID by calling the ListEnterpriseProject API of EPS. |
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 |
|---|---|---|
id |
String |
ID of the IP address group |
name |
String |
IP address group name |
ips |
String |
Address group IP addresses (IP addresses or IP address ranges are separated by commas (,). |
size |
Integer |
Length of the IP address group |
rules |
Array of RuleInfo objects |
List of rules that use the IP address group |
share_info |
ShareInfo object |
Sharing information |
description |
String |
Address group description |
Parameter |
Type |
Description |
|---|---|---|
rule_id |
String |
Rule ID |
rule_name |
String |
Rule name |
policy_id |
String |
Policy ID |
policy_name |
String |
Policy Name |
Parameter |
Type |
Description |
|---|---|---|
share_count |
Integer |
Total number of the users who share the address group. |
accept_count |
Integer |
Number of users who accept the sharing |
process_status |
Integer |
Status |
Status code: 400
Parameter |
Type |
Description |
|---|---|---|
error_code |
String |
Error code |
error_msg |
String |
Error message |
Status code: 401
Parameter |
Type |
Description |
|---|---|---|
error_code |
String |
Error code |
error_msg |
String |
Error message |
Status code: 500
Parameter |
Type |
Description |
|---|---|---|
error_code |
String |
Error code |
error_msg |
String |
Error message |
Example Requests
The following example shows how to query an address group in a project. The project ID is specified by project_id. The address group ID is id.
GET https://{Endpoint}/v1/{project_id}/waf/ip-group/{id}?enterprise_project_id=0
Example Responses
Status code: 200
Request succeeded.
{
"description" : "",
"id" : "c36e896b18ee486a81026fce8e69fb1a",
"ips" : "xx.xx.xx.xx",
"name" : "sfddf",
"rules" : [ ],
"size" : 1
}
Status Codes
Status Code |
Description |
|---|---|
200 |
Request succeeded. |
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.
