# 查询IP地址组列表 - ListAddressGroup #### 功能介绍 当您的IP地址组创建成功后，您可以通过该接口查询所有IP地址组信息，包括IP地址组的名称、包含的IP地址等。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-vpc/vpc_api00_0007.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-vpc/vpc_permission_0000.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | vpc:addressGroups:list | List | addressGroup \* | - | - | - | | vpc:addressGroups:list | List | - | g:EnterpriseProjectId | - | - | #### URI GET /v3/{project_id}/vpc/address-groups 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： IP地址组所属的项目ID。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-vpc/vpc_api_0011.html)。 **取值范围**： 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | **参数解释**： 每页返回的资源个数。 **取值范围**： 0-2000。 | | marker | 否 | String | **参数解释**： 分页查询起始的资源ID，为空时查询第一页。 **取值范围**： IP地址组的资源ID。 | | id | 否 | Array of strings | **参数解释**： IP地址组的资源ID。可以使用该字段精确过滤IP地址组，支持传入多个ID过滤。 **取值范围**： 不涉及。 | | name | 否 | Array of strings | **参数解释**： IP地址组的名称。可以使用该字段精确过滤满足条件的IP地址组，支持传入多个name过滤。 **取值范围**： 不涉及。 | | ip_version | 否 | Integer | **参数解释**： IP地址组的IP版本。可以使用该字段按照IP版本过滤IP地址组。 **取值范围**： - 4：过滤IPv4地址组。 - 6：过滤IPv6地址组。 | | description | 否 | Array of strings | **参数解释**： IP地址组的描述信息。可以使用该字段精确过滤IP地址组，支持传入多个描述进行过滤。 **取值范围**： 不涉及。 | | enterprise_project_id | 否 | String | **参数解释**： IP地址组所属的企业项目ID。可以使用该字段过滤企业项目下的IP地址组。 **取值范围**： - 最大长度36字节，带"-"连字符的UUID格式，或者是字符串"0"。"0"表示默认企业项目。 - 若需要查询当前用户所有有权限查看企业项目绑定的IP地址组，请传参all_granted_eps。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | request_id | String | **参数解释**： 请求ID。 **取值范围**： 不涉及。 | | address_groups | Array of [AddressGroup] objects | **参数解释**： 查询IP地址组列表的响应体。 **取值范围**： 不涉及。 | | page_info | [PageInfo] object | **参数解释**： 分页信息。 **取值范围**： 不涉及。 | 表4AddressGroup | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： IP地址组的资源ID。IP地址组创建成功后，会生成一个IP地址组ID，是IP地址组对应的唯一标识。 **取值范围**： 带"-"的标准UUID格式。 | | name | String | **参数解释**： IP地址组的名称。 **取值范围**： 1-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点）。 | | description | String | **参数解释**： IP地址组的描述信息。 **取值范围**： 0-255个字符，不能包含"\<"和"\>"。 | | max_capacity | Integer | **参数解释**： IP地址组支持的最大IP条目数，限制IP地址组可以包含的IP地址数量。 **取值范围**： 0-20，默认20。 | | ip_set | Array of strings | **参数解释**： IP地址组包含的IP地址集，支持IPv4和IPv6。 **取值范围**： IP地址集中的元素可以是： - 单个IP地址，如192.168.21.25。 - IP地址范围，如192.168.21.25-192.168.21.30。 - IP网段，如192.168.21.0/24。 | | ip_version | Integer | **参数解释**： IP地址组的IP版本。 **取值范围**： - 4：表示IPv4地址组。 - 6：表示IPv6地址组。 | | created_at | String | **参数解释**： IP地址组的创建时间。 **取值范围**： UTC时间格式，yyyy-MM-ddTHH:mm:ss。 | | updated_at | String | **参数解释**： IP地址组的最近一次的更新时间。 **取值范围**： UTC时间格式，yyyy-MM-ddTHH:mm:ss。 | | tenant_id | String | **参数解释**： IP地址组所属的项目ID。 **取值范围**： 不涉及。 | | enterprise_project_id | String | **参数解释**： IP地址组所属的企业项目ID。 **取值范围**： 最大长度36字节，带"-"连字符的UUID格式，或者是字符串"0"。"0"表示默认企业项目。 | | tags | Array of [ResponseTag] objects | **参数解释**： IP地址组的标签信息，包括标签键和标签值，可用来分类和标识资源。详情请参见Tag对象。 **取值范围**： 不涉及。 | | status | String | **参数解释**： IP地址组的状态，当IP地址组处于UPDATING（更新中）状态时，不允许再次更新。 **取值范围**： - NORMAL：正常，默认值。 - UPDATING：更新中。 - UPDATE_FAILED：更新失败。 | | status_message | String | **参数解释**： IP地址组的状态详情信息。 **取值范围**： 不涉及。 | | ip_extra_set | Array of [IpExtraSetRespOption] objects | **参数解释**： IP地址组包含的IP地址及其备注信息。 **取值范围**： 不涉及。 | 表5ResponseTag | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释**： 标签键。 **取值范围**： - 最大长度128个unicode字符， key不能为空。 - 同一资源的key不能重复。 - 可以包含的字符范围： - 英文字母 - 数字 - 特殊字符：下划线（_）、点（.）、冒号（:）、加号（+）、中划线（-）、等号（=） - 中文字符 | | value | String | **参数解释**： 标签值。 **取值范围**： - 每个值最大长度255个unicode字符，value可以为空。 - 可以包含的字符范围： - 英文字母 - 数字 - 特殊字符：下划线（_）、点（.）、冒号（:）、加号（+）、中划线（-）、等号（=） - 中文字符 | 表6IpExtraSetRespOption | 参数 | 参数类型 | 描述 | |:---|:---|:---| | ip | String | **参数解释**： IP地址集中包含的IP条目，支持IPv4和IPv6。 **取值范围**： - 单个IP地址，如192.168.21.25。 - IP地址范围，如192.168.21.25-192.168.21.30。 - IP网段，如192.168.21.0/24。 | | remarks | String | **参数解释**： IP条目的备注信息。 **取值范围**： 0-255个字符，不能包含"\<"和"\>"。 | 表7PageInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | previous_marker | String | **参数解释**： 当前页的第一条记录。 **取值范围**： 不涉及。 | | current_count | Integer | **参数解释**： 当前页的资源总数。 **取值范围**： 不涉及。 | | next_marker | String | **参数解释**： 当前页的最后一条记录，最后一页时无next_marker字段。 **取值范围**： 不涉及。 | #### 请求示例 组合过滤条件查询IP地址组列表。 ``` GET https://{endpoint}/v3/b2782e6708b8475c993e6064bc456bf8/vpc/address-groups?name=ipGroup-test&description=test&ip_version=4 ``` #### 响应示例 **状态码：200** GET操作正常返回，更多状态码请参见[状态码](https://support.huaweicloud.com/api-vpc/vpc_api_0002.html)。 ``` { "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代码示例 SDK代码示例如下。 - [Java] ``` 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("")) .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()); } } } ``` - [Python] ``` # 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("")) \ .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) ``` - [Go] ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := vpc.VpcClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := vpc.NewVpcClient(hcClient) request := &model.ListAddressGroupRequest{} response, err := client.ListAddressGroup(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/VPC/sdk?api=ListAddressGroup&version=v3)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | GET操作正常返回，更多状态码请参见[状态码](https://support.huaweicloud.com/api-vpc/vpc_api_0002.html)。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-vpc/vpc_api_0003.html)。