Querying IP Address Groups
Function
This API is used to query IP address groups based on filter criteria.
Debugging
You can debug this API through automatic authentication in API Explorer.
URI
GET /v3/{project_id}/vpc/address-groups
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain a project ID, see Obtaining a Project ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
limit |
No |
Integer |
|
marker |
No |
String |
Start resource ID of pagination query. If the parameter is left blank, only resources on the first page are queried. |
id |
No |
Array of strings |
Unique ID of an IP address group, which is used to filter the IP address group. Multiple IDs can be specified for filtering. |
name |
No |
Array of strings |
IP address group name, which is used to filter the IP address group. Multiple names can be specified for filtering. |
ip_version |
No |
Integer |
|
description |
No |
Array of strings |
Supplementary information about an IP address group, which is used to filter the IP address group. Multiple descriptions can be specified for filtering. |
enterprise_project_id |
No |
String |
Maximum: 36 |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Request ID. |
address_groups |
Array of AddressGroup objects |
Response body for querying IP address groups. |
page_info |
PageInfo object |
Pagination information. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
|
name |
String |
|
description |
String |
|
max_capacity |
Integer |
|
ip_set |
Array of strings |
|
ip_version |
Integer |
|
created_at |
String |
|
updated_at |
String |
|
tenant_id |
String |
|
enterprise_project_id |
String |
Maximum: 36 |
tags |
Array of ResourceTag objects |
|
status |
String |
|
status_message |
String |
|
ip_extra_set |
Array of IpExtraSetRespOption objects |
|
Parameter |
Type |
Description |
---|---|---|
key |
String |
Minimum: 1 Maximum: 128 |
value |
String |
Maximum: 255 |
Parameter |
Type |
Description |
---|---|---|
ip |
String |
|
remarks |
String |
|
Example Requests
Query address groups based on combined filter criteria.
GET https://{{endpoint}}/v3/b2782e6708b8475c993e6064bc456bf8/vpc/address-groups?name=vkvgykvsvhjaaaa1&description=xxxxxxxxxx&ip_version=4
Example Responses
Status code: 200
Normal response to the GET operation. For more status codes, see Status Codes.
-
{ "address_groups" : [ { "id" : "dd18a501-fcd5-4adc-acfe-b0e2384baf08", "name" : "AutoTester746010.580123789", "tenant_id" : "b2782e6708b8475c993e6064bc456bf8", "ip_version" : 4, "max_capacity" : 20, "ip_set" : [ "192.168.5.0/24", "192.168.3.20-192.168.3.100", "192.168.3.40", "192.168.3.2" ], "ip_extra_set" : [ { "ip" : "192.168.5.0/24", "remarks" : null }, { "ip" : "192.168.3.20-192.168.3.100", "remarks" : null }, { "ip" : "192.168.3.40", "remarks" : null }, { "ip" : "192.168.3.2", "remarks" : null } ], "enterprise_project_id" : "0aad99bc-f5f6-4f78-8404-c598d76b0ed2", "created_at" : "2019-06-28T02:06:38.000+00:00", "updated_at" : "2019-06-28T02:06:38.000+00:00", "description" : "test", "status" : "NORMAL", "status_message" : "" } ], "page_info" : { "previous_marker" : "dd18a501-fcd5-4adc-acfe-b0e2384baf08", "current_count" : 1 }, "request_id" : "e51fa17c-3259-4122-afb1-9c03d4ef5408" }
Status Codes
Status Code |
Description |
---|---|
200 |
Normal response to the GET operation. For more status codes, see Status Codes. |
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