# 查询公共池列表 - ListCommonPools #### 功能介绍 查询公共池列表。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/EIP/doc?api=ListCommonPools&version=v3)中调试该接口，支持自动认证鉴权。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-eip/eip_apipermission_0000.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v3/{project_id}/eip/publicip-pools/common-pools 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | - 参数解释：项目ID。[请参见获取项目ID](https://support.huaweicloud.com/api-eip/eip_api06_0004.html) - 取值范围：不涉及 最大长度：**32** | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | fields | 否 | String | - 功能说明：查询字段，形式为"fields=id\&fields=name\&.." - 支持字段：id/name/status/type/used/allow_share_bandwidth_types/public_border_group 最小长度：**0** 最大长度：**1024** | | name | 否 | String | - 功能说明：公共池名称 最小长度：**0** 最大长度：**36** | | public_border_group | 否 | String | - 功能说明：公共池位于中心还是边缘 最小长度：**0** 最大长度：**64** | | limit | 否 | String | - 功能说明：每页返回的资源个数 - 取值范围：1\~2000 | | marker | 否 | String | - 功能说明：分页查询起始的资源ID，为空时为查询第一页 最小长度：**0** 最大长度：**36** | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | common_pools | Array of [CommonPoolDict] objects | 功能说明：公共池对象 数组长度：**0 - 9999** | | request_id | String | 本次请求的编号 | 表4CommonPoolDict | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | - 公共池名字 最小长度：**0** 最大长度：**36** | | status | String | - 参数解释：公共池状态。 - 约束限制：不涉及 - 取值范围： - ACTIVE：公共池当前可购买IP。 - SOLDOUT：公共池IP已售罄。 - 默认取值：不涉及 - 最大长度: 36 - 最小长度: 0 | | type | String | - 参数解释：指定公共池类型。 - 约束限制：不涉及 - 取值范围：所有的公共池类型 - 5_bgp：动态bgp公共IP池。 - 5_sbgp：静态bgp公共IP池。 - 5_testbgp:IP测试池 - 默认取值：不涉及 最小长度：**0** 最大长度：**36** | | used | Integer | - 已经使用的ip数量 最小值：**0** 最大值：**99999** | | public_border_group | String | - 功能说明：表示中心站点资源或者边缘站点资源 - 取值范围： center、边缘站点名称 - 约束与限制：publicip只能绑定该字段相同的资源 最小长度：**1** 最大长度：**64** | | id | String | - 功能说明：默认不展示，取值, 公共池ID 最小长度：**36** 最大长度：**36** | | allow_share_bandwidth_types | Array of strings | - 功能说明：表示此publicip可以加入的共享带宽类型列表，如果为空列表，则表示该publicip不能加入任何共享带宽 - 约束与限制：publicip只能加入到有该带宽类型的共享带宽中 最大长度：**64** 数组长度：**0 - 9999** | #### 请求示例 查询公共池列表，可根据query参数字段进行过滤 ``` GET https://{Endpoint}/v3/{project_id}/eip/publicip-pools/common-pools?name=5_bgp ``` #### 响应示例 **状态码：200** ``` { "common_pools" : [ { "name" : "5_bgp", "status" : "active", "type" : "bgp", "used" : 99, "public_border_group" : "center", "allow_share_bandwidth_types" : [ "share" ] } ], "request_id" : "4a06c169-cc67-4d94-a786-2d70ef09b100" } ``` #### 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.eip.v3.region.EipRegion; import com.huaweicloud.sdk.eip.v3.*; import com.huaweicloud.sdk.eip.v3.model.*; public class ListCommonPoolsSolution { 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); EipClient client = EipClient.newBuilder() .withCredential(auth) .withRegion(EipRegion.valueOf("")) .build(); ListCommonPoolsRequest request = new ListCommonPoolsRequest(); try { ListCommonPoolsResponse response = client.listCommonPools(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 huaweicloudsdkeip.v3.region.eip_region import EipRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkeip.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 = EipClient.new_builder() \ .with_credentials(credentials) \ .with_region(EipRegion.value_of("")) \ .build() try: request = ListCommonPoolsRequest() response = client.list_common_pools(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" eip "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/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 := eip.EipClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := eip.NewEipClient(hcClient) request := &model.ListCommonPoolsRequest{} response, err := client.ListCommonPools(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/EIP/sdk?api=ListCommonPools&version=v3)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | Get操作正常返回 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-eip/ErrorCode.html)。