# 查询弹性公网IP列表 - ListPublicips #### 功能介绍 查询当前局点下用户所有弹性公网IP的列表 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/EIP/doc?api=ListPublicips&version=v2)中调试该接口，支持自动认证鉴权。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-eip/eip_apipermission_0000.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | eip:publicIps:list | List | publicip \* | - | vpc:publicIps:list | - | | eip:publicIps:list | List | - | g:EnterpriseProjectId | vpc:publicIps:list | - | #### URI GET /v1/{project_id}/publicips 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID [参见获取项目ID](https://support.huaweicloud.com/api-eip/eip_api06_0004.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | marker | 否 | String | **参数解释：** 分页查询的起始资源ID，表示从指定资源的下一条记录开始查询。为空时为查询第一页。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不超过36个字符。 | | limit | 否 | Integer | **参数解释：** 每页返回的资源个数。 **约束限制：** 不涉及。 **取值范围：** 0\~2000。 **默认取值：** 不涉及。 | | ip_version | 否 | Integer | **参数解释：** IP地址版本信息。 **约束限制：** 不涉及。 **取值范围：** - 4：IPv4。 - 6：开启NAT64能力。 **默认取值：** 不涉及。 | | enterprise_project_id | 否 | String | **参数解释：** 企业项目ID。可以使用该字段过滤某个企业项目下的弹性公网IP。 **约束限制：** 不涉及。 **取值范围：** 最大长度36字节，带"-"连字符的UUID格式，或者是字符串"0"。"0"表示默认企业项目。如果需要查询当前用户所有企业项目绑定的弹性公网IP，请传参all_granted_eps。 **默认取值：** 不涉及。 **说明：** 关于企业项目ID的获取及企业项目特性的详细信息，请参见[《企业管理用户指南》](https://support.huaweicloud.com/usermanual-em/zh-cn_topic_0126101490.html)。 | | port_id | 否 | Array of strings | **参数解释：** 绑定弹性公网IP的端口id，用于过滤查询。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | public_ip_address | 否 | Array of strings | **参数解释：** 弹性公网IP地址。IPv4时是申请到的弹性公网IP地址，IPv6时是IPv6地址对应的IPv4地址，用于过滤查询。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | private_ip_address | 否 | Array of strings | **参数解释：** 关联端口的私有IP地址，用于过滤查询。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | id | 否 | Array of strings | **参数解释：** 弹性公网IP唯一标识，用于过滤查询。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | allow_share_bandwidth_type_any | 否 | Array of strings | **参数解释：** 共享带宽类型，根据任一共享带宽类型过滤弹性公网IP列表。可以指定多个带宽类型，不同的带宽类型间用逗号分隔。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | publicips | Array of [PublicipShowResp] objects | **参数解释：** 弹性公网IP对象列表。 **取值范围：** 不涉及。 | 表4PublicipShowResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | bandwidth_id | String | **参数解释：** 弹性公网IP对应带宽ID。 **取值范围：** 最大长度36。 | | bandwidth_name | String | **参数解释：** 带宽名称。 **取值范围：** 1-64个字符。 | | bandwidth_share_type | String | **参数解释：** 表示共享带宽或者独享带宽，其中IPv6暂不支持WHOLE类型带宽。 **取值范围：** - WHOLE：共享带宽。 - PER：独享带宽。 | | bandwidth_size | Integer | **参数解释：** 带宽大小，单位为Mbit/s。 **取值范围：** 不涉及。 | | create_time | String | **参数解释：** 弹性公网IP申请时间，采用UTC时间。 **取值范围：** 不涉及。 | | enterprise_project_id | String | **参数解释：** 企业项目ID。最大长度36字节，带"-"连字符的UUID格式，或者是字符串"0"。 关于企业项目ID的获取及企业项目特性的详细信息，请参见[《企业管理用户指南》](https://support.huaweicloud.com/usermanual-em/zh-cn_topic_0126101490.html) **取值范围：** 不涉及。 | | id | String | **参数解释：** 弹性公网IP唯一标识。 **取值范围：** 最大长度36。 | | port_id | String | **参数解释：** 端口id。只有绑定了的弹性公网IP查询才会返回该参数。 **取值范围：** 不涉及。 | | private_ip_address | String | **参数解释：** 绑定弹性公网IP的私有IP地址。只有绑定了的弹性公网IP查询才会返回该参数。 **取值范围：** 不涉及。 | | profile | [ProfileResp] object | **参数解释：** 额外参数，包括订单id、产品id等信息。如果profile不为空，说明是包周期的弹性公网IP | | public_ip_address | String | **参数解释：** IPv4时是申请到的弹性公网IP地址，IPv6时是IPv6地址对应的IPv4地址。 **取值范围：** 不涉及。 | | status | String | **参数解释：** 弹性公网IP的状态。 **取值范围：** - FREEZED：冻结。 - BIND_ERROR：绑定失败。 - BINDING：绑定中。 - PENDING_DELETE：释放中。 - PENDING_CREATE：创建中。 - NOTIFYING：创建中。 - NOTIFY_DELETE：释放中。 - PENDING_UPDATE：更新中。 - DOWN：未绑定。 - ACTIVE：绑定。 - ELB：绑定ELB。 - VPN：绑定VPN。 - ERROR：失败。 | | tenant_id | String | **参数解释：** 项目ID，如何获取项目ID请参见[获取项目ID](https://support.huaweicloud.com/api-vpc/vpc_api_0011.html) **取值范围：** 不涉及。 | | type | String | **参数解释：** 弹性公网IP的类型。 **取值范围：** 5_bgp (全动态BGP)，5_sbgp (静态BGP)，5_bgp-premium(精品BGP) - 华南-广州：5_bgp、5_sbgp - 华东-上海一：5_bgp、5_sbgp - 华东-上海二：5_bgp、5_sbgp - 华北-北京一：5_bgp、5_sbgp - 中国-香港：5_bgp、5_bgp-premium - 亚太-曼谷：5_bgp - 亚太-新加坡：5_bgp - 非洲-约翰内斯堡：5_bgp - 西南-贵阳一：5_sbgp - 华北-北京四：5_bgp、5_sbgp - 拉美-圣地亚哥：5_bgp - 拉美-圣保罗一：5_bgp - 拉美-墨西哥城一：5_bgp - 拉美-布宜诺斯艾利斯一：5_bgp - 拉美-利马一：5_bgp - 拉美-圣地亚哥二： 5_bgp | | public_ipv6_address | String | **参数解释：** IPv4时无此字段，IPv6时为申请到的弹性公网IP地址。 **取值范围：** 不涉及。 | | ip_version | Integer | **参数解释：** IP版本信息，IPv6为开启NAT64能力 **取值范围：** - 4：IPv4。 - 6：IPv6。 | | public_border_group | String | **参数解释：** 表示中心站点资源或者边缘站点资源。publicip只能绑定该字段相同的资源。 **取值范围：** center、边缘站点名称。 | | allow_share_bandwidth_types | Array of strings | **参数解释：** 表示此publicip可以加入的共享带宽类型列表，如果列表为空，则表示该publicip不能加入任何共享带宽。publicip只能加入到有该带宽类型的共享带宽中。 **取值范围：** 不涉及。 | | alias | String | **参数解释：** 弹性公网IP名称。 **取值范围：** 1-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点） | 表5ProfileResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | order_id | String | **参数解释：** 订单的id。 **取值范围：** 0-36个字符。 | | product_id | String | **参数解释：** 产品的id。 **取值范围：** 0-36个字符。 | | region_id | String | **参数解释：** 当前局点的id。 **取值范围：** 0-36个字符。 | | user_id | String | **参数解释：** 用户的id。 **取值范围：** 0-36个字符。 | #### 请求示例 查询弹性公网IP列表，数量为2个 ``` GET https://{Endpoint}/v1/{project_id}/publicips?limit=2 ``` #### 响应示例 **状态码：200** ``` { "publicips" : [ { "tenant_id" : "8b7e35ad379141fc9df3e178bd64f55c", "bandwidth_name" : "bandwidth-test", "public_ip_address" : "161.xx.xx.9", "create_time" : "2015-07-16 04:22:32", "profile" : { "user_id" : "35f2b308f5d64441a6fa7999fbcd4321", "product_id" : "00301-48027-0--0", "region_id" : "xxx", "order_id" : "xxxxxxxxx" }, "type" : "5_bgp", "bandwidth_id" : "3fa5b383-5a73-4dcb-a314-c6128546d855", "bandwidth_size" : 5, "enterprise_project_id" : "b261ac1f-2489-4bc7-b31b-c33c3346a439", "ip_version" : 4, "private_ip_address" : "192.168.10.5", "bandwidth_share_type" : "PER", "id" : "6285e7be-fd9f-497c-bc2d-dd0bdea6efe0", "status" : "ACTIVE", "port_id" : "4977b983-cd4f-4ecc-93a1-cb52d848a9b3", "public_border_group" : "center", "allow_share_bandwidth_types" : [ "share" ] }, { "tenant_id" : "8b7e35ad379141fc9df3e178bd64f55c", "bandwidth_name" : "bandwidth-test1", "public_ip_address" : "161.xx.xx.10", "create_time" : "2015-07-16 04:23:03", "profile" : { }, "type" : "5_bgp", "bandwidth_id" : "a79fd11a-047b-4f5b-8f12-99c178cc780a", "bandwidth_size" : 5, "enterprise_project_id" : "0", "ip_version" : 4, "bandwidth_share_type" : "PER", "id" : "80d5b82e-43b9-4f82-809a-37bec5793bd4", "status" : "DOWN", "public_border_group" : "center", "allow_share_bandwidth_types" : [ "share" ] } ] } ``` #### 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.v2.region.EipRegion; import com.huaweicloud.sdk.eip.v2.*; import com.huaweicloud.sdk.eip.v2.model.*; public class ListPublicipsSolution { 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(); ListPublicipsRequest request = new ListPublicipsRequest(); try { ListPublicipsResponse response = client.listPublicips(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.v2.region.eip_region import EipRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkeip.v2 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 = ListPublicipsRequest() response = client.list_publicips(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/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v2/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.ListPublicipsRequest{} response, err := client.ListPublicips(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=ListPublicips&version=v2)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | GET操作正常返回 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-eip/ErrorCode.html)。