華為云計(jì)算 云知識 查詢彈性公網(wǎng)IP列表ListPublicips
查詢彈性公網(wǎng)IP列表ListPublicips

 

功能介紹

查詢EIP列表

調(diào)試

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

URI

GET /v1/{project_id}/publicips

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

project_id

String

項(xiàng)目ID,獲取項(xiàng)目ID請參見獲取項(xiàng)目ID

表2 Query參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

marker

String

  • 功能說明:取值為上一頁數(shù)據(jù)的最后一條記錄的id,為空時(shí)為查詢第一頁

最大長度:36

limit

Integer

  • 功能說明:每頁返回的個(gè)數(shù)

  • 取值范圍:0~intmax

最小值:0

ip_version

Integer

  • 功能說明:IP地址版本信息,4:IPv4,6:開啟NAT64能力

枚舉值:

  • 4

  • 6

enterprise_project_id

String

  • 功能說明:企業(yè)項(xiàng)目ID??梢允褂迷撟侄芜^濾某個(gè)企業(yè)項(xiàng)目下的EIP。

  • 取值范圍:最大長度36字節(jié),帶“-”連字符的UUID格式,或者是字符串“0”。“0”表示默認(rèn)企業(yè)項(xiàng)目。若需要查詢當(dāng)前用戶所有企業(yè)項(xiàng)目綁定的 彈性公網(wǎng)IP ,請傳參all_granted_eps。

關(guān)于企業(yè)項(xiàng)目ID的獲取及企業(yè)項(xiàng)目特性的詳細(xì)信息,請參見《企業(yè)管理用戶指南》

port_id

Array

public_ip_address

Array

  • 功能說明:IPv4時(shí)是申請到的彈性公網(wǎng)IP地址,IPv6時(shí)是IPv6地址對應(yīng)的IPv4地址

private_ip_address

Array

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

id

Array

  • 功能說明:彈性公網(wǎng)IP唯一標(biāo)識

allow_share_bandwidth_type_any

Array

  • 功能說明:共享帶寬類型,根據(jù)任一共享帶寬類型過濾EIP列表??梢灾付ǘ鄠€(gè)帶寬類型,不同的帶寬類型間用逗號分隔。

請求參數(shù)

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

狀態(tài)碼: 200

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

參數(shù)

參數(shù)類型

描述

publicips

Array of PublicipShowResp objects

彈性公網(wǎng)IP對象

表4 PublicipShowResp

參數(shù)

參數(shù)類型

描述

bandwidth_id

String

  • 功能說明:EIP對應(yīng)帶寬ID

最大長度:36

bandwidth_name

String

  • 功能說明:帶寬名稱

最小長度:1

最大長度:64

bandwidth_share_type

String

  • 功能說明:表示共享帶寬或者獨(dú)享帶寬

  • 取值范圍:

    • WHOLE:共享帶寬

    • PER:獨(dú)享帶寬

  • 約束:其中IPv6暫不支持WHOLE類型帶寬。

枚舉值:

  • WHOLE

  • PER

bandwidth_size

Integer

  • 功能說明:帶寬大小,單位為Mbit/s。

最小值:0

create_time

String

  • 功能說明:EIP申請時(shí)間(UTC)

enterprise_project_id

String

  • 企業(yè)項(xiàng)目ID。最大長度36字節(jié),帶“-”連字符的UUID格式,或者是字符串“0”。

  • 創(chuàng)建彈性公網(wǎng)IP時(shí),給彈性公網(wǎng)IP綁定企業(yè)項(xiàng)目ID。

  • 不指定該參數(shù)時(shí),默認(rèn)值是 0

關(guān)于企業(yè)項(xiàng)目ID的獲取及企業(yè)項(xiàng)目特性的詳細(xì)信息,請參見《企業(yè)管理用戶指南》

最大長度:36

id

String

  • 功能說明:EIP唯一標(biāo)識

最大長度:36

port_id

String

  • 功能說明:端口id。

  • 約束:只有綁定了的EIP查詢才會返回該參數(shù)

最大長度:36

private_ip_address

String

  • 功能說明:綁定彈性公網(wǎng)IP的私有IP地址

  • 約束:只有綁定了的彈性公網(wǎng)IP查詢才會返回該參數(shù)

profile

ProfileResp object

  • 功能說明:額外參數(shù),包括訂單id、產(chǎn)品id等信息

  • 約束:如果profile不為空,說明是包周期的EIP

public_ip_address

String

  • 功能說明:IPv4時(shí)是申請到的EIP地址,IPv6時(shí)是IPv6地址對應(yīng)的IPv4地址

最大長度:15

status

String

  • 功能說明:彈性公網(wǎng)IP的狀態(tài)

  • 取值范圍

    • FREEZED:凍結(jié)

    • BIND_ERROR:綁定失敗

    • BINDING:綁定中

    • PENDING_DELETE:釋放中

    • PENDING_CREATE:創(chuàng)建中

    • NOTIFYING:創(chuàng)建中

    • NOTIFY_DELETE:釋放中

    • PENDING_UPDATE:更新中

    • DOWN:未綁定

    • ACTIVE:綁定

    • ELB:綁定ELB

    • VPN:綁定VPN

    • ERROR:失敗

枚舉值:

  • FREEZED

  • BIND_ERROR

  • BINDING

  • PENDING_DELETE

  • PENDING_CREATE

  • NOTIFYING

  • NOTIFY_DELETE

  • PENDING_UPDATE

  • DOWN

  • ACTIVE

  • ELB

  • VPN

  • ERROR

tenant_id

String

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

最大長度:36

type

String

  • 功能說明:EIP的類型

  • 取值范圍:5_bgp(全動態(tài)BGP),5_sbgp(靜態(tài)BGP),5_youxuanbgp(優(yōu)選BGP)

    • 華南-廣州:5_bgp、5_sbgp

    • 華東-上海一:5_bgp、5_sbgp

    • 華東-上海二:5_bgp、5_sbgp

    • 華北-北京一:5_bgp、5_sbgp

    • 中國-香港:5_bgp、5_youxuanbgp

    • 亞太-曼谷:5_bgp

    • 亞太-新加坡:5_bgp

    • 非洲-約翰內(nèi)斯堡:5_bgp

    • 西南-貴陽一:5_sbgp

    • 華北-北京四:5_bgp、5_sbgp

    • 拉美-圣地亞哥:5_bgp

    • 拉美-圣保羅一:5_bgp

    • 拉美-墨西哥城一:5_bgp

    • 拉美-布宜諾斯艾利一:5_bgp

    • 拉美-利馬一:5_bgp

    • 拉美-圣地亞哥二: 5_bgp

  • 約束:

    • 必須是系統(tǒng)具體支持的類型。

    • publicip_id為IPv4端口,所以"type"字段未給定時(shí),默認(rèn)為5_bgp。

最大長度:36

public_ipv6_address

String

  • 功能說明:IPv4時(shí)無此字段,IPv6時(shí)為申請到的EIP地址

最大長度:39

ip_version

Integer

  • 功能說明:IP版本信息

  • 取值范圍是4和6,IPv6為開啟NAT64能力

    • 4:IPv4

    • 6:IPv6

枚舉值:

  • 4

  • 6

public_border_group

String

  • 功能說明:表示中心站點(diǎn)資源或者邊緣站點(diǎn)資源,對接了邊緣站點(diǎn)的區(qū)域才會返回該字段

  • 取值范圍: center、邊緣站點(diǎn)名稱

  • 約束:publicip只能綁定該字段相同的資源

最小長度:1

最大長度:64

allow_share_bandwidth_types

Array of strings

  • 功能說明:表示此publicip可以加入的共享帶寬類型列表,如果列表為空,則表示該publicip不能加入任何共享帶寬

  • 約束:publicip只能加入到有該帶寬類型的共享帶寬中

最大長度:64

alias

String

  • 功能說明:彈性公網(wǎng)IP名稱

  • 取值范圍:1-64個(gè)字符,支持?jǐn)?shù)字、字母、中文、_(下劃線)、-(中劃線)、.(點(diǎn))

最大長度:64

表5 ProfileResp

參數(shù)

參數(shù)類型

描述

order_id

String

訂單的id

最大長度:36

product_id

String

產(chǎn)品的id

最大長度:36

region_id

String

region的id

最大長度:36

user_id

String

用戶的id

最大長度:36

請求示例

GET https://{Endpoint}/v1/{project_id}/publicips?limit=2&marker=4779ab1c-7c1a-44b1-a02e-93dfc361b32d

響應(yīng)示例

狀態(tài)碼: 200

GET操作正常返回

{
  "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" ]
  } ]
}

狀態(tài)碼

狀態(tài)碼

描述

200

GET操作正常返回

錯(cuò)誤碼

請參見錯(cuò)誤碼。