Querying IP Address Groups
Function
This API is used to query IP address groups based on filter criteria.
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 |
Number of records displayed on each page. Value range: 0 to 2000 |
enterprise_project_id |
No |
String |
Enterprise project ID. This field can be used to filter the IP address groups of an enterprise project. The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value 0 indicates the default enterprise project. To obtain the IP address groups bound to all enterprise projects of the user, set all_granted_eps. Maximum length: 36 This parameter is available in CN South-Shenzhen, CN Southwest-Guiyang1, CN South-Guangzhou, and AP-Singapore. |
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 can be used to filter the IP address group. |
name |
No |
Array of strings |
Name of an IP address group, which can be used to filter the IP address group. |
ip_version |
No |
Integer |
Version of IP addresses in an IP address group. The value can be 4 or 6. |
description |
No |
Array of strings |
Provides supplementary information about an IP address group, which can be used to filter the IP address group. |
Request Parameter
None
Example Request
- Query IP address groups based on combined filtering criteria
"GET https://{{endpoint}}/v3/b2782e6708b8475c993e6064bc456bf8/vpc/address-groups?name=vkvgykvsvhjaaaa1&description=xxxxxxxxxx&ip_version=4"
Response Parameter
When the status code is 200, the response parameters are as follows:
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Request ID |
address_groups |
Array of AddressGroup objects |
Response body of IP address groups |
page_info |
PageInfo object |
Pagination information |
Parameter |
Type |
Description |
---|---|---|
id |
String |
|
name |
String |
|
description |
String |
|
ip_set |
Array of strings |
|
ip_version |
Integer |
|
created_at |
String |
|
updated_at |
String |
|
tenant_id |
String |
|
max_capacity |
Integer |
|
enterprise_project_id |
String |
|
tags |
Array of ResourceTag objects |
IP address group tags. |
status |
String |
|
status_message |
String |
|
ip_extra_set |
Array of IpExtraSetRespOption objects |
|
Parameter |
Type |
Description |
---|---|---|
previous_marker |
String |
First record on the current page |
current_count |
Integer |
Total number of records on the current page |
next_marker |
String |
Last record on the current page. This parameter does not exist if the page is the last one. |
Parameter |
Type |
Description |
---|---|---|
key |
String |
Tag key. Each key value of a resource must be unique. Minimum length: 1 Maximum length: 128 |
value |
String |
Tag value Maximum length: 255 |
Parameter |
Type |
Description |
---|---|---|
ip |
String |
An IP address, IP address range, or CIDR block. Both IPv4 and IPv6 are supported. |
remarks |
String |
Provides supplementary information about the IP address, IP address range, or CIDR block. The value can contain no more than 255 characters and cannot contain angle brackets (< or >). |
Example Response
When the status code is 200, the response parameters are as follows:
{ "address_groups": [ { "id": "dd18a501-fcd5-4adc-acfe-b0e2384baf08", "name": "AutoTester746010.580123789", "tenant_id": "b2782e6708b8475c993e6064bc456bf8", "ip_version": 4, "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 }], "created_at": "2019-06-28T02:06:38", "updated_at": "2019-06-28T02:06:38", "description": "test", "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2", "tags": [], "max_capacity": 20, "status": "NORMAL", "status_message": "" } ], "page_info": { "previous_marker": "dd18a501-fcd5-4adc-acfe-b0e2384baf08", "current_count": 1 }, "request_id": "e51fa17c-3259-4122-afb1-9c03d4ef5408" }
Status Code
See Status Codes.
Error Code
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