Querying IP Address Groups
Function
This API is used to query information about all IP address groups, including the IP address group name and IP addresses.
Calling Method
For details, see Calling APIs.
URI
GET /v3/{project_id}/vpc/address-groups
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition: ID of the project that an IP address group belongs to. For details about how to obtain a project ID, see Obtaining a Project ID. Range: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
limit |
No |
Integer |
Definition: Number of resources on each page. Range: 0 to 2000 |
marker |
No |
String |
Definition: Start resource ID of pagination query. If the parameter is left blank, only resources on the first page are queried. Range: ID of an IP address group. |
id |
No |
Array of strings |
Definition: ID of an IP address group. This field can be used to precisely filter IP address groups. Multiple IDs can be specified for filtering. Range: N/A |
name |
No |
Array of strings |
Definition: The name of an IP address group. This field can be used to precisely filter IP address groups. Multiple names can be specified for filtering. Range: N/A |
ip_version |
No |
Integer |
Definition: IP address version of an IP address group. This field can be used to filter IP address groups. Range:
|
description |
No |
Array of strings |
Definition: Description about an IP address group. This field can be used to precisely filter IP address groups. Multiple descriptions can be specified for filtering. Range: N/A |
enterprise_project_id |
No |
String |
Definition: ID of the enterprise project that an IP address group belongs to. This field can be used to filter the IP address groups of an enterprise project. Range:
|
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Definition: Request ID. Range: N/A |
address_groups |
Array of AddressGroup objects |
Definition: Response body for querying IP address groups. Range: N/A |
page_info |
PageInfo object |
Definition: Pagination information. Range: N/A |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition: ID of an IP address group. After an IP address group is created, an IP address group ID is generated, which uniquely identifies the IP address group. Range: The value is in UUID format with hyphens (-). |
name |
String |
Definition: The name of an IP address group. Range: The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods. |
description |
String |
Definition: Description about an IP address group. Range: The value can contain 0 to 255 characters and cannot contain angle brackets (< or >). |
max_capacity |
Integer |
Definition: Maximum number of IP address entries in an IP address group. Range: The value can be from 0 to 20. The default value is 20. |
ip_set |
Array of strings |
Definition: IP address entries in an IP address group. Both IPv4 and IPv6 address entries are supported. Range: An IP address entry in an IP address set can be:
|
ip_version |
Integer |
Definition: IP address version of an IP address group. Range:
|
created_at |
String |
Definition: Time when an IP address group was created. Range: The value is a UTC time in the format of yyyy-MM-ddTHH:mm:ss. |
updated_at |
String |
Definition: Time when an IP address group was last updated. Range: The value is a UTC time in the format of yyyy-MM-ddTHH:mm:ss. |
tenant_id |
String |
Definition: ID of the project that an IP address group belongs to. Range: N/A |
enterprise_project_id |
String |
Definition: ID of the enterprise project that an IP address group belongs to. Range: The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). 0 indicates the default enterprise project. |
tags |
Array of ResponseTag objects |
Definition: Tags of an IP address group, including tag keys and tag values, which can be used to classify and identify resources. For details, see the tag objects. Range: N/A |
status |
String |
Definition: Status of an IP address group. If the IP address group is in the UPDATING state, it cannot be updated again. Range:
|
status_message |
String |
Definition: Details about the IP address group status. Range: N/A |
ip_extra_set |
Array of IpExtraSetRespOption objects |
Definition: IP address entries in an IP address group and their remarks. Range: N/A |
Parameter |
Type |
Description |
---|---|---|
key |
String |
Definition: Tag key. Range:
|
value |
String |
Definition: Tag value. Range:
|
Parameter |
Type |
Description |
---|---|---|
ip |
String |
Definition: IP address entries in an IP address group. Both IPv4 and IPv6 address entries are supported. Range:
|
remarks |
String |
Definition: Remarks of an IP address entry. Range: The value can contain 0 to 255 characters and cannot contain angle brackets (< or >). |
Parameter |
Type |
Description |
---|---|---|
previous_marker |
String |
Definition: The first record on the current page. Range: N/A |
current_count |
Integer |
Definition: Total number of resources on the current page. Range: N/A |
next_marker |
String |
Definition: The last record on the current page. The next_marker field does not exist if the page is the last one. Range: N/A |
Example Requests
Query IP address groups based on combined filters.
GET https://{{endpoint}}/v3/b2782e6708b8475c993e6064bc456bf8/vpc/address-groups?name=ipGroup-test&description=test&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" : "ipGroup-test", "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" : "", "tags" : [ ] } ], "page_info" : { "previous_marker" : "dd18a501-fcd5-4adc-acfe-b0e2384baf08", "current_count" : 1 }, "request_id" : "e51fa17c-3259-4122-afb1-9c03d4ef5408" }
SDK Sample Code
The SDK sample code is as follows.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.vpc.v3.region.VpcRegion; import com.huaweicloud.sdk.vpc.v3.*; import com.huaweicloud.sdk.vpc.v3.model.*; public class ListAddressGroupSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); VpcClient client = VpcClient.newBuilder() .withCredential(auth) .withRegion(VpcRegion.valueOf("<YOUR REGION>")) .build(); ListAddressGroupRequest request = new ListAddressGroupRequest(); try { ListAddressGroupResponse response = client.listAddressGroup(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkvpc.v3.region.vpc_region import VpcRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkvpc.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = VpcClient.new_builder() \ .with_credentials(credentials) \ .with_region(VpcRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListAddressGroupRequest() response = client.list_address_group(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" vpc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := vpc.NewVpcClient( vpc.VpcClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListAddressGroupRequest{} response, err := client.ListAddressGroup(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
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