# 查询公网IP池列表 - ListPublicipPool #### 功能介绍 查询租户下所有公网IP池列表。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/EIP/doc?api=ListPublicipPool&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 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | - 参数解释：项目ID。[请参见获取项目ID](https://support.huaweicloud.com/api-eip/eip_api06_0004.html) - 取值范围：不涉及 最大长度：**32** | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | marker | 否 | String | - 功能说明：分页查询起始的资源ID，为空时为查询第一页 最小长度：**0** 最大长度：**36** | | limit | 否 | Integer | - 功能说明：每页返回的资源个数 - 取值范围：1\~2000 最小值：**0** 最大值：**2000** | | fields | 否 | String | - 功能说明：查询字段，形式为"fields=id\&fields=name\&..." - 支持字段：id/name/size/used/project_id/status/billing_info/created_at/updated_at/type/shared/is_common/description/tags/enterprise_project_id/allow_share_bandwidth_types/public_border_group 最小长度：**0** 最大长度：**1024** | | sort_key | 否 | String | - 功能说明：排序字段，形式为"sort_key=id\&sort_dir=asc" - 支持字段：id/name/created_at/updated_at/public_border_group 最小长度：**0** 最大长度：**36** | | sort_dir | 否 | String | - 功能说明：排序方向 - 取值范围： - asc 顺序 - desc 倒序 最小长度：**0** 最大长度：**16** | | id | 否 | String | - 功能说明：根据id过滤 最小长度：**0** 最大长度：**36** | | name | 否 | String | - 功能说明：根据name过滤 最小长度：**0** 最大长度：**64** | | size | 否 | Integer | - 功能说明：根据size过滤 最小值：**0** 最大值：**999999** | | status | 否 | String | - 参数解释：根据池子状态过滤。 - 约束限制：不涉及 - 取值范围： - ACTIVE：已上线。 - INACTIVE:已下线。 - SOLDOUT：已售罄。 - 默认取值：不涉及 最小长度：**0** 最大长度：**36** | | type | 否 | String | - 功能说明：根据公网IP池类型过滤。 - 约束限制：不涉及 - 取值范围： - spec_bgp：专属离散动态 - spec_sbgp：专属离散静态 - 默认取值：不涉及 最小长度：**0** 最大长度：**36** | | description | 否 | String | - 功能说明：根据description过滤 最小长度：**0** 最大长度：**255** | | public_border_group | 否 | String | - 功能说明：根据public_border_group过滤 最小长度：**0** 最大长度：**64** | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | publicip_pools | Array of [PublicipPoolShowResp] objects | 功能说明：公网池对象 数组长度：**0 - 9999** | | request_id | String | 本次请求的编号 | | page_info | [PageInfoOption] object | 分页页码信息 | 表4PublicipPoolShowResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | - 功能说明：公网IP池ID | | name | String | - 功能说明：公网IP池名字 | | status | String | - 参数解释：公网IP池状态。 - 约束限制：不涉及 - 取值范围： - ACTIVE：已上线。 - INACTIVE:已下线。 - SOLDOUT：已售罄。 - 默认取值：不涉及 | | type | String | - 功能说明：公网IP池类型。 - 约束限制：不涉及 - 取值范围： - spec_bgp：专属离散动态 - spec_sbgp：专属离散静态 - 默认取值：不涉及 | | description | String | - 功能说明：描述 | | project_id | String | - 参数解释：项目ID。[请参见获取项目ID](https://support.huaweicloud.com/api-eip/eip_api06_0004.html) - 取值范围：不涉及 | | size | Integer | - 功能说明：池子大小 | | used | Integer | - 功能说明：已经使用的IP数量 | | created_at | String | - 功能说明：公网IP池创建时间 | | updated_at | String | - 功能说明：公网IP池更新时间 | | billing_info | [BillingInfoDict] object | 订单信息, 有订单表示包周期 | | public_border_group | String | - 功能说明：中心还是边缘。公网IP池取值为center | | shared | Boolean | - 功能说明：是否共享 | | tags | Array of [TagsInfo] objects | - 功能说明：用户标签。 数组长度：**0 - 9999** | | enterprise_project_id | String | - 功能说明：企业项目ID。最大长度36字节,带"-"连字符的UUID格式，或者是字符串"0"。创建弹性公网IP时，给弹性公网IP绑定企业项目ID。 | | allow_share_bandwidth_types | Array of strings | - 功能说明：表示此publicip可以加入的共享带宽类型列表，如果为空列表，则表示该publicip不能加入任何共享带宽 - 约束与限制：publicip只能加入到有该带宽类型的共享带宽中 最大长度：**64** 数组长度：**0 - 9999** | 表5BillingInfoDict | 参数 | 参数类型 | 描述 | |:---|:---|:---| | order_id | String | - 功能说明：订单信息 | | product_id | String | - 功能说明：产品id | 表6TagsInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | - 功能说明：标签名称 - 约束与限制： - 不能为空。 - 长度不超过128个字符。 - 由英文字母、数字、下划线、中划线、中文字符组成 - 同一资源的key值不能重复。 最大长度：**128** | | value | String | - 功能说明：标签值 - 约束与限制： - 长度不超过255个字符。 - 由英文字母、数字、下划线、中划线、中文字符组成 最大长度：**255** | 表7PageInfoOption | 参数 | 参数类型 | 描述 | |:---|:---|:---| | previous_marker | String | **参数解释：** 翻页时，作为前一页的marker取值。 **取值范围：** 不涉及。 | | next_marker | String | **参数解释：** 翻页时，作为后一页的marker取值。 **取值范围：** 不涉及。 | | current_count | Integer | **参数解释：** 当前页的数据总数。 **取值范围：** 0-99999 | #### 请求示例 查询公网IP池列表，可根据Query参数过滤 ``` GET https://{Endpoint}/v3/{project_id}/eip/publicip-pools ``` #### 响应示例 **状态码：200** ``` { "publicip_pools" : [ { "id" : "f588ccfa-8750-4d7c-bf5d-2ede24414706", "name" : "test_pool_xxx", "status" : "active", "shared" : true, "enterprise_project_id" : 0, "type" : "spec_bgp", "project_id" : "8b7e35ad379141fc9df3e178bd64f55c", "size" : 100, "used" : 20, "billing_info" : { "order_id" : "CS20081917179HW3H", "product_id" : "00301-335034-0--0" }, "created_at" : "2020-07-17T09:25:53Z", "updated_at" : "2020-07-17T09:25:53Z", "description" : "test", "public_border_group" : "center", "allow_share_bandwidth_types" : [ "share" ] } ], "request_id" : "4a06c169-cc67-4d94-a786-2d70ef09b100", "page_info" : { "previous_marker" : "f588ccfa-8750-4d7c-bf5d-2ede24414706", "current_count" : 1 } } ``` #### 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 ListPublicipPoolSolution { 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(); ListPublicipPoolRequest request = new ListPublicipPoolRequest(); try { ListPublicipPoolResponse response = client.listPublicipPool(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 = ListPublicipPoolRequest() response = client.list_publicip_pool(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.ListPublicipPoolRequest{} response, err := client.ListPublicipPool(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=ListPublicipPool&version=v3)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | Get操作正常返回 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-eip/ErrorCode.html)。