Querying Address Group Members
Function
This API is used to query address group members.
Debugging
You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.
URI
GET /v1/{project_id}/address-items
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
project_id |
Yes |
String |
Project ID |
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
set_id |
Yes |
String |
ID of the IP address group |
key_word |
No |
String |
Keyword |
limit |
Yes |
Integer |
Number of records displayed on each page |
offset |
Yes |
Integer |
Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0. |
address |
No |
String |
IP address |
enterprise_project_id |
No |
String |
Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. |
fw_instance_id |
No |
String |
Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
|---|---|---|
data |
data object |
Response for address group member query |
Parameter |
Type |
Description |
|---|---|---|
offset |
Integer |
Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0. |
limit |
Integer |
Number of records displayed on each page |
total |
Integer |
Total |
set_id |
String |
ID of the IP address group |
records |
Array of records objects |
Member information |
Parameter |
Type |
Description |
|---|---|---|
item_id |
String |
ID of an address group member |
name |
String |
Name of an address group member |
description |
String |
Description |
address_type |
Integer |
Address group type. The value can be 0 (IPv4) or 1 (IPv6). |
address |
String |
Address group |
Status code: 400
Parameter |
Type |
Description |
|---|---|---|
error_code |
String |
Error code Minimum: 8 Maximum: 36 |
error_msg |
String |
Description Minimum: 2 Maximum: 512 |
Example Requests
Query members in address group 8773c082-2a6c-4529-939a-edc28ef1a67c of project 9d80d070b6d44942af73c9c3d38e0429.
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-items?set_id=8773c082-2a6c-4529-939a-edc28ef1a67c&limit=10&offset=0
Example Responses
Status code: 200
Return value for querying address group members
{
"data" : {
"limit" : 10,
"offset" : 0,
"records" : [ {
"address" : "1.1.1.1",
"address_type" : 0,
"description" : "",
"item_id" : "294fab71-34bf-4858-a380-8f7530e1c816",
"name" : "ceshi"
} ],
"set_id" : "8773c082-2a6c-4529-939a-edc28ef1a67c",
"total" : 1
}
}
Status code: 400
Bad Request
{
"error_code" : "CFW.00200005",
"error_msg" : "operation content does not exist"
}
Status Codes
Status Code |
Description |
|---|---|
200 |
Return value for querying address group members |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
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.
