華為云計(jì)算 云知識 查詢浮動IP列表NeutronListFloatingIps
查詢浮動IP列表NeutronListFloatingIps

 

功能介紹

查詢提交請求的租戶有權(quán)限操作的所有浮動IP地址。單次查詢最多返回2000條數(shù)據(jù),超過2000后會返回分頁標(biāo)記。

接口約束

單次查詢最多返回2000條數(shù)據(jù),超過2000后會返回分頁標(biāo)記。

調(diào)試

您可以在API Explorer中調(diào)試該接口,支持自動認(rèn)證鑒權(quán)。API Explorer可以自動生成SDK代碼示例,并提供SDK代碼示例調(diào)試功能。

URI

GET /v2.0/floatingips

表1 Query參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

limit

Integer

  • 功能說明:分頁查詢每頁返回的記錄個(gè)數(shù)

  • 取值范圍為0~intmax。

  • 約束:limit需要和marker配合使用,詳細(xì)規(guī)則請見marker的參數(shù)說明

最小值:0

最大值:2000

marker

String

  • 功能說明:分頁查詢的起始資源ID,表示從指定資源的下一條記錄開始查詢。

  • 約束:marker需要和limit配合使用:

    • 若不傳入marker和limit參數(shù),查詢結(jié)果返回全部資源記錄。

    • 若不傳入marker參數(shù),limit為10,查詢結(jié)果返回第1~10條資源記錄。

    • 若marker為第10條記錄的資源ID,limit為10,查詢結(jié)果返回第11~20條資源記錄。

    • 若marker為第10條記錄的資源ID,不傳入limit參數(shù),查詢結(jié)果返回第11條及之后的所有資源記錄。

最小長度:0

最大長度:36

page_reverse

Boolean

  • 功能說明:False/True,是否設(shè)置分頁的順序。

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

  • 功能說明:關(guān)聯(lián)端口的私有IP地址。

最小長度:0

最大長度:64

tenant_id

String

  • 功能說明:項(xiàng)目ID。

最小長度:0

最大長度:36

floating_network_id

String

  • 功能說明:外部網(wǎng)絡(luò)的id。

  • 約束:只能使用固定的外網(wǎng),外部網(wǎng)絡(luò)的信息請通過GET /v2.0/networks?router:external=True或GET /v2.0/networks?name={floating_network}或neutron net-external-list方式查詢

最小長度:0

最大長度:36

請求參數(shù)

響應(yīng)參數(shù)

狀態(tài)碼: 200

表2 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

floatingips

Array of FloatingIpResp objects

floatingip對象列表

數(shù)組長度:0 - 99999

floatingips_links

Array of Pager objects

floatingips_link對象列表

數(shù)組長度:0 - 99999

表3 FloatingIpResp

參數(shù)

參數(shù)類型

描述

fixed_ip_address

String

  • 功能說明:關(guān)聯(lián)端口的私有IP地址。

最小長度:0

最大長度:64

floating_ip_address

String

  • 功能說明:浮動IP地址。

最小長度:0

最大長度:64

floating_network_id

String

  • 功能說明:外部網(wǎng)絡(luò)id

最小長度:0

最大長度:36

id

String

  • 功能說明:浮動IP地址的id。

最小長度:0

最大長度:36

port_id

String

  • 功能說明:端口id

最小長度:0

最大長度:36

router_id

String

  • 功能說明:所屬路由器id。

最小長度:0

最大長度:36

status

String

  • 功能說明:網(wǎng)絡(luò)狀態(tài),可以為ACTIVE, DOWN或ERROR。

  • 取值范圍:

    • DOWN:未綁定

    • ACTIVE:綁定

    • ERROR:異常

枚舉值:

  • ACTIVE

  • DOWN

  • ERROR

tenant_id

String

  • 功能說明:項(xiàng)目id。

最小長度:0

最大長度:36

project_id

String

  • 功能說明:項(xiàng)目id。

最小長度:0

最大長度:36

dns_name

String

  • 功能說明:DNS名稱,該參數(shù)當(dāng)前僅在“華南-廣州”開放

最小長度:0

最大長度:255

dns_domain

String

  • 功能說明:DNS域地址,該參數(shù)當(dāng)前僅在“華南-廣州”開放

最小長度:0

最大長度:255

created_at

String

  • 功能說明:資源創(chuàng)建時(shí)間,采用UTC時(shí)間,格式:YYYY-MM-DDTHH:MM:SS

updated_at

String

  • 功能說明:資源更新時(shí)間,采用UTC時(shí)間,格式:YYYY-MM-DDTHH:MM:SS

表4 Pager

參數(shù)

參數(shù)類型

描述

href

String

頁碼url

最小長度:0

最大長度:256

rel

String

next:下一頁 previous:前一頁

枚舉值:

  • 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}

響應(yīng)示例

狀態(tài)碼: 200

GET操作正常返回

{
  "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.hwclouds-dns.com.",
    "created_at" : "2017-10-19T12:21:28",
    "updated_at" : "2018-07-30T12:52:13"
  } ],
  "floatingips_links" : [ {
    "href" : "https://network.region.cn-southwest-2.hwclouds.com/v2.0/floatingips.json?
limit=2000&marker=000a6144-5010-46f2-bf06-6a1c94477ea3&page_reverse=true", "rel" : "previous" }, { "href" : "https://network.region.cn-southwest-2.hwclouds.com/v2.0/floatingips.json?
limit=2000&marker=d445e537-bc81-4039-9c7b-f9c1f5c73c78", "rel" : "next" } ] }

狀態(tài)碼

狀態(tài)碼

描述

200

GET操作正常返回

錯誤碼

請參見錯誤碼。