# 查询IP地址组列表 - ListIpGroups #### 功能介绍 查询IP地址组列表。 #### 接口约束 - 分页查询使用的参数为marker、limit、page_reverse。 - marker和page_reverse只有和limit一起使用时才会生效，单独使用无效。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-elb/elb_dy_0000.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-elb/elb_sq_0001.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | elb:ipgroups:list | List | ipgroup \* | - | - | - | | elb:ipgroups:list | List | - | g:EnterpriseProjectId | - | - | #### URI GET /v3/{project_id}/elb/ipgroups 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释** ：项目ID。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-elb/elb_fl_0008.html)。 **约束限制**：不涉及 **取值范围**：长度为32个字符，由小写字母和数字组成。 **默认取值**：不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | marker | 否 | String | **参数解释**：上一页最后一条记录的ID。 **约束限制**： - 必须与limit一起使用。 - 不指定时表示查询第一页。 - 该字段不允许为空或无效的ID。 **取值范围**：不涉及 **默认取值**：不涉及 | | limit | 否 | Integer | **参数解释**：每页返回的个数。 **约束限制**：不涉及 **取值范围**：0-2000 **默认取值**：2000 | | page_reverse | 否 | Boolean | **参数解释**：是否反向查询。 **约束限制**： - 必须与limit一起使用。 - 当page_reverse=true时，若要查询上一页，marker取值为当前页返回值的previous_marker。 **取值范围**： - true：查询上一页。 - false：查询下一页。 **默认取值**：false | | id | 否 | Array of strings | **参数解释**：IP地址组的ID。 **约束限制**：不涉及 **取值范围**：不涉及 **默认取值**：不涉及 | | name | 否 | Array of strings | **参数解释**：IP地址组的名称。 **约束限制**：不涉及 **取值范围**：不涉及 **默认取值**：不涉及 | | description | 否 | Array of strings | **参数解释**：IP地址组的描述。 **约束限制**：不涉及 **取值范围**：不涉及 **默认取值**：不涉及 | | ip_list | 否 | Array of strings | **参数解释**：IP地址组的IP地址。若一次传入多个，则查询满足任意一个IP地址的所有IP地址组。 注意：不管是单个IP、网段还是连续地址段，都全匹配查询。比如存在IP地址组的IP地址是127.0.0.1-127.0.0.10，则需要传入ip_list=127.0.0.1-127.0.0.10 才能查询到。 **约束限制**：不涉及 **取值范围**：不涉及 **默认取值**：不涉及 | | enterprise_project_id | 否 | Array of strings | **参数解释**：资源所属的企业项目ID。 支持多值查询，查询条件格式： *enterprise_project_id=xxx\&enterprise_project_id=xxx*。 **约束限制**： 如果enterprise_project_id不传值，默认查询所有企业项目下的资源，鉴权按照细粒度权限鉴权，必须在用户组下分配elb:ipgroups:list权限。 如果enterprise_project_id传值，鉴权按照企业项目权限鉴权，分为传入具体eps_id和all_granted_eps两种场景，前者查询指定eps_id的eps下的资源，后者查询的是所有有list权限的eps下的资源。 **取值范围**：不涉及 **默认取值**：不涉及 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**：IAM鉴权Token。 **约束限制**：不涉及 **取值范围**：不涉及 **默认取值**：不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | ipgroups | Array of [IpGroup] objects | **参数解释**：IP地址组列表返回对象。 | | request_id | String | **参数解释**：请求ID。 **取值范围**：由数字、小写字母和中划线（-）组成的字符串，自动生成。 | | page_info | [PageInfo] object | **参数解释**：分页信息。 | 表5IpGroup | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**：IP地址组的ID。 **取值范围**：不涉及 | | name | String | **参数解释**：IP地址组的名称。 **取值范围**：不涉及 | | description | String | **参数解释**：IP地址组的描述信息。 **取值范围**：不涉及 | | ip_list | Array of [IpInfo] objects | **参数解释**：IP地址组中包含的IP地址列表。\[\]表示任意IP。 | | listeners | Array of [ListenerRef] objects | **参数解释**：与IP地址组关联的监听器的ID列表。 | | project_id | String | **参数解释**：IP地址组的项目ID。 **取值范围**：不涉及 | | enterprise_project_id | String | **参数解释**：资源所属的企业项目ID。 **取值范围**： - "0"：表示资源属于default企业项目。 - UUID格式的字符串，表示非默认企业项目。 | | created_at | String | **参数解释**：IP地址组的创建时间。 **取值范围**：格式：yyyy-MM-dd'T'HH:mm:ss'Z'，UTC时区。 | | updated_at | String | **参数解释**：IP地址组的更新时间。 **取值范围**：格式：yyyy-MM-dd'T'HH:mm:ss'Z'，UTC时区。 | 表6IpInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | ip | String | **参数解释**：IP地址组中的IP地址。 **取值范围**：IP地址段格式为ip-ip，例如192.168.1.2-192.168.2.253或者2001:0DB8:02de::0e12-2001:0DB8:02de::0e13，终止IP需要大于起始IP。 | | description | String | **参数解释**：IP地址组中ip的备注信息。 **取值范围**：长度为0-255个字符。 | 表7ListenerRef | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**：监听器ID。 **取值范围**：不涉及 | 表8PageInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | previous_marker | String | **参数解释**：分页查询结果中第一条记录的ID。通常用于配合page_reverse=true查询上一页。 **取值范围**：不涉及 | | next_marker | String | **参数解释**：分页查询结果中最后一条记录的ID。通常用于查询下一页。 **取值范围**：不涉及 | | current_count | Integer | **参数解释**：当前页返回记录数。 **取值范围**：不涉及 | #### 请求示例 分页查询IP地址组列表 ``` GET https://{ELB_Endpoint}/v3/45977fa2dbd7482098dd68d0d8970117/elb/ipgroups?limit=1 ``` #### 响应示例 **状态码：200** 操作正常返回。 ``` { "ipgroups" : [ { "description" : "", "id" : "8722e0e0-9cc9-4490-9660-8c9a5732fbb0", "name" : "test_ipg", "project_id" : "45977fa2dbd7482098dd68d0d8970117", "ip_list" : [ { "ip" : "192.168.1.123", "description" : "" }, { "ip" : "192.168.3.0/24", "description" : "test_ip" } ], "listeners" : [ { "id" : "88f9c079-29cb-435a-b98f-0c5c0b90c2bd" }, { "id" : "2f4c9644-d5d2-4cf8-a3c0-944239a4f58c" } ], "enterprise_project_id" : "0", "created_at" : "2018-01-16T03:19:16Z", "updated_at" : "2018-01-16T03:19:16Z" } ], "page_info" : { "previous_marker" : "1d321f77-bc7b-45d3-9cfe-d7c0b65a3620", "current_count" : 1 }, "request_id" : "8d9f423c-8766-4b6a-9952-275a88ac1ce3" } ``` #### 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.elb.v3.region.ElbRegion; import com.huaweicloud.sdk.elb.v3.*; import com.huaweicloud.sdk.elb.v3.model.*; public class ListIpGroupsSolution { 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); ElbClient client = ElbClient.newBuilder() .withCredential(auth) .withRegion(ElbRegion.valueOf("")) .build(); ListIpGroupsRequest request = new ListIpGroupsRequest(); try { ListIpGroupsResponse response = client.listIpGroups(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 huaweicloudsdkelb.v3.region.elb_region import ElbRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkelb.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 = ElbClient.new_builder() \ .with_credentials(credentials) \ .with_region(ElbRegion.value_of("")) \ .build() try: request = ListIpGroupsRequest() response = client.list_ip_groups(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" elb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/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 := elb.ElbClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := elb.NewElbClient(hcClient) request := &model.ListIpGroupsRequest{} response, err := client.ListIpGroups(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ELB/sdk?api=ListIpGroups&version=v3)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 操作正常返回。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-elb/ErrorCode.html)。