# 查询浮动IP列表 - NeutronListFloatingIps #### 功能介绍 查询提交请求的租户有权限操作的所有浮动IP地址。单次查询最多返回2000条数据，超过2000后会返回分页标记 #### 接口约束 单次查询最多返回2000条数据，超过2000后会返回分页标记 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/EIP/doc?api=NeutronListFloatingIps&version=v2)中调试该接口，支持自动认证鉴权。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-eip/eip_apipermission_0000.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | eip:nativeFloatingIps:list | List | - | - | - vpc:publicIps:list - vpc:floatingIps:get | - | #### URI GET /v2.0/floatingips 表1Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | **参数解释：** 分页查询每页返回的记录个数。 **约束限制：** limit需要和marker配合使用，详细规则请见marker的参数说明。 **取值范围：** 0\~2000。 **默认取值：** 不涉及。 最小值：**0** 最大值：**2000** | | marker | 否 | String | **参数解释：** 分页查询的起始资源ID，表示从指定资源的下一条记录开始查询。 **约束限制：** marker需要和limit配合使用： - 如果不传入marker和limit参数，查询结果返回全部资源记录。 - 如果不传入marker参数，limit为10，查询结果返回第1\~10条资源记录。 - 如果marker为第10条记录的资源ID，limit为10，查询结果返回第11\~20条资源记录。 - 如果marker为第10条记录的资源ID，不传入limit参数，查询结果返回第11条及之后的所有资源记录。 **取值范围：** 0-36个字符。 **默认取值：** 不涉及。 | | page_reverse | 否 | Boolean | **参数解释：** 是否设置分页的顺序。 **约束限制：** 不涉及。 **取值范围：** - true：设置分页顺序。 - false：不设置分页顺序。 **默认取值：** 不涉及。 | | id | 否 | String | **参数解释：** 浮动IP的id。 **约束限制：** 不涉及。 **取值范围：** 0-36个字符。 **默认取值：** 不涉及。 | | floating_ip_address | 否 | String | **参数解释：** 浮动IP地址（IPv4格式）。 **约束限制：** 不涉及。 **取值范围：** 0-64个字符。 **默认取值：** 不涉及。 | | router_id | 否 | String | **参数解释：** 所属路由器id。 **约束限制：** 不涉及。 **取值范围：** 0-36个字符。 **默认取值：** 不涉及。 | | port_id | 否 | String | **参数解释：** 端口id。 **约束限制：** 不涉及。 **取值范围：** 0-36个字符。 **默认取值：** 不涉及。 | | fixed_ip_address | 否 | String | **参数解释：** 关联端口的私有IP地址。 **约束限制：** 不涉及。 **取值范围：** 0-64个字符。 **默认取值：** 不涉及。 | | tenant_id | 否 | String | **参数解释：** 项目ID。 **约束限制：** 不涉及。 **取值范围：** 0-36个字符。 **默认取值：** 不涉及。 | | floating_network_id | 否 | String | **参数解释：** 外部网络的id。 **约束限制：** 只能使用固定的外网，外部网络的信息请通过GET /v2.0/networks?router:external=True或GET /v2.0/networks?name={floating_network}或neutron net-external-list方式查询。 **取值范围：** 0-36个字符 **默认取值：** 不涉及。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表2响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | floatingips | Array of [FloatingIpResp] objects | **参数解释：** floatingip对象列表。 **取值范围：** 不涉及。 数组长度：**0 - 99999** | | floatingips_links | Array of [Pager] objects | **参数解释：** floatingips_link对象列表。 **取值范围：** 不涉及。 数组长度：**0 - 99999** | 表3FloatingIpResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | fixed_ip_address | String | **参数解释：** 关联端口的私有IP地址。 **取值范围：** 0-64个字符。 | | floating_ip_address | String | **参数解释：** 浮动IP地址。 **取值范围：** 0-64个字符。 | | floating_network_id | String | **参数解释：** 外部网络id。 **取值范围：** 0-36个字符。 | | id | String | **参数解释：** 浮动IP地址的id。 **取值范围：** 0-36个字符。 | | port_id | String | **参数解释：** 端口id。 **取值范围：** 0-36个字符。 | | router_id | String | **参数解释：** 所属路由器id。 **取值范围：** 0-36个字符。 | | status | String | **参数解释：** 网络状态。 **取值范围：** - DOWN：未绑定。 - ACTIVE：绑定。 - ERROR：异常。 | | tenant_id | String | **参数解释：** 项目id。 **取值范围：** 0-36个字符。 | | project_id | String | **参数解释：** 项目id。 **取值范围：** 0-36个字符。 | | dns_name | String | **参数解释：** DNS名称。该参数当前仅在"华南-广州"开放。 **取值范围：** 0-255个字符。 | | dns_domain | String | **参数解释：** DNS域地址。该参数当前仅在"华南-广州"开放。 **取值范围：** 0-255个字符。 | | created_at | String | **参数解释：** 资源创建时间，采用UTC时间，格式：YYYY-MM-DDTHH:MM:SS。 **取值范围：** 不涉及。 | | updated_at | String | **参数解释：** 资源更新时间，采用UTC时间，格式：YYYY-MM-DDTHH:MM:SS。 **取值范围：** 不涉及。 | 表4Pager | 参数 | 参数类型 | 描述 | |:---|:---|:---| | href | String | **参数解释：** 页码url。 **取值范围：** 0-256个字符。 | | rel | String | **参数解释：** 分页指向。 **取值范围：** - next：下一页。 - previous：前一页。 | #### 请求示例 - ``` GET https://{Endpoint}/v2.0/floatingips?limit=1 ``` - ``` GET https://{Endpoint}/v2.0/floatingips?id={fip_id}&router_id={router_id}&floating_network_id={net_id}&floating_ip_address={floating_ip}&port_id={port_id}&fixed_ip_address={fixed_ip}&project_id={project_id} ``` #### 响应示例 **状态码：200** ``` { "floatingips" : [ { "id" : "1a3a2818-d9b4-4a9c-8a19-5252c499d1cd", "status" : "DOWN", "router_id" : null, "tenant_id" : "bbfe8c41dd034a07bebd592bf03b4b0c", "project_id" : "bbfe8c41dd034a07bebd592bf03b4b0c", "floating_network_id" : "0a2228f2-7f8a-45f1-8e09-9039e1d09975", "fixed_ip_address" : null, "floating_ip_address" : "99.99.99.84", "port_id" : null, "dns_name" : "ecs-88-99-103-61", "dns_domain" : "compute.myclouds-dns.com.", "created_at" : "2017-10-19T12:21:28", "updated_at" : "2018-07-30T12:52:13" } ], "floatingips_links" : [ { "href" : "https://network.region.test.clouds.com/v2.0/floatingips.json?limit=2000&marker=000a6144-5010-46f2-bf06-6a1c94477ea3&page_reverse=true", "rel" : "previous" }, { "href" : "https://network.region.test.clouds.com/v2.0/floatingips.json?limit=2000&marker=d445e537-bc81-4039-9c7b-f9c1f5c73c78", "rel" : "next" } ] } ``` #### 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 NeutronListFloatingIpsSolution { 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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); EipClient client = EipClient.newBuilder() .withCredential(auth) .withRegion(EipRegion.valueOf("")) .build(); NeutronListFloatingIpsRequest request = new NeutronListFloatingIpsRequest(); try { NeutronListFloatingIpsResponse response = client.neutronListFloatingIps(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"] credentials = BasicCredentials(ak, sk) client = EipClient.new_builder() \ .with_credentials(credentials) \ .with_region(EipRegion.value_of("")) \ .build() try: request = NeutronListFloatingIpsRequest() response = client.neutron_list_floating_ips(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") auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). 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.NeutronListFloatingIpsRequest{} response, err := client.NeutronListFloatingIps(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=NeutronListFloatingIps&version=v2)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | GET操作正常返回 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-eip/ErrorCode.html)。