華為云計算 云知識 查詢私有IP列表ListPrivateips
查詢私有IP列表ListPrivateips

 

功能介紹

查詢指定子網(wǎng)下的私有IP列表。

調(diào)試

您可以在API Explorer中調(diào)試該接口。

URI

GET /v1/{project_id}/subnets/{subnet_id}/privateips

樣例:
GET https://{Endpoint}/v1/{project_id}/subnets/{subnet_id}/privateips?limit=10&
marker=4779ab1c-7c1a-44b1-a02e-93dfc361b32d
參數(shù)說明請參見表1。
表1 參數(shù)說明

名稱

是否必選

參數(shù)類型

說明

project_id

String

項目ID,獲取項目ID請參見獲取項目ID。

subnet_id

String

私有IP所在子網(wǎng)的唯一標(biāo)識

如果您使用管理控制臺,此值即為子網(wǎng)詳情中的“網(wǎng)絡(luò)ID”參數(shù)值。

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條及之后的所有資源記錄。

limit

Integer

分頁查詢每頁返回的記錄個數(shù),取值范圍為0~intmax(2^31-1),默認(rèn)值2000。

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

請求參數(shù)

請求示例

GET https://{Endpoint}/v1/{project_id}/subnets/{subnet_id}/privateips

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

表2 請求參數(shù)

名稱

參數(shù)類型

說明

privateips

Array of privateip objects

私有IP列表對象,請參見表3。

表3 privateip字段說明

名稱

參數(shù)類型

說明

status

String

  • 功能說明:私有IP的狀態(tài)
  • 取值范圍:
    • ACTIVE:活動的
    • DOWN:不可用

id

String

私有IP標(biāo)識

subnet_id

String

分配IP的子網(wǎng)標(biāo)識

如果您使用管理控制臺,此值即為子網(wǎng)詳情中的“網(wǎng)絡(luò)ID”參數(shù)值。

tenant_id

String

項目ID

device_owner

String

  • 功能說明:私有IP的使用者,空表示未使用
  • 取值范圍:

    network:dhcp DHCP服務(wù)IP地址

    network:router_interface_distributed 網(wǎng)關(guān)IP地址

    compute:xxx(xxx對應(yīng)具體的可用區(qū)名稱,例如compute:aa-bb-cc表示是被可用區(qū)aa-bb-cc上的ECS使用) 虛擬機網(wǎng)卡IP地址

    neutron:VIP_PORT 虛擬IP地址

    compute:subeni 輔助彈性網(wǎng)卡IP地址

    neutron:LOADBALANCERV2 共享ELB使用的IP地址

    neutron:LOADBALANCERV3 獨享ELB使用的IP地址

    network:endpoint_interface VPC終端節(jié)點使用的IP地址

  • 約束:此處的取值范圍只是本服務(wù)支持的類型,其他類型未做標(biāo)注

ip_address

String

申請到的私有IP

響應(yīng)示例

{
    "privateips": [
        {
            "status": "DOWN",
            "id": "d600542a-b231-45ed-af05-e9930cb14f78",
            "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd",
            "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c",
            "device_owner": "",
            "ip_address": "192.168.1.11"
        },
        {
            "status": "DOWN",
            "id": "d600542a-b231-45ed-af05-e9930cb14f79",
            "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd",
            "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c",
            "device_owner": "",
            "ip_address": "192.168.1.12"
        }
    ]
}

狀態(tài)碼

請參見狀態(tài)碼。

錯誤碼

請參考錯誤碼。