華為云計(jì)算 云知識 查詢VPC列表ListVpcs
查詢VPC列表ListVpcs

 

功能介紹

查詢 虛擬私有云 列表。

調(diào)試

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

URI

GET /v1/{project_id}/vpcs

樣例:
GET https://{Endpoint}/v1/{project_id}/vpcs?limit=10&marker=13551d6b-755d-4757-b956-536f674975c0
參數(shù)說明請參見表1。
表1 參數(shù)說明

名稱

是否必選

參數(shù)類型

說明

project_id

String

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

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

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

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

enterprise_project_id

String

  • 功能說明:企業(yè)項(xiàng)目ID??梢允褂迷撟侄芜^濾某個(gè)企業(yè)項(xiàng)目下的虛擬 私有云 。
  • 取值范圍:最大長度36字節(jié),帶“-”連字符的UUID格式,或者是字符串“0”。“0”表示默認(rèn)企業(yè)項(xiàng)目。若需要查詢當(dāng)前用戶所有企業(yè)項(xiàng)目綁定的虛擬私有云,請傳參all_granted_eps。
    說明:

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

請求參數(shù)

請求示例

GET https://{Endpoint}/v1/{project_id}/vpcs

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

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

名稱

參數(shù)類型

說明

vpcs

Array of vpcs objects

vpc對象列表

表3 vpcs字段說明

名稱

參數(shù)類型

說明

id

String

uuid形式的一個(gè)資源標(biāo)識。

name

String

  • 功能說明:虛擬私有云名稱
  • 取值范圍:0-64個(gè)字符,支持?jǐn)?shù)字、字母、中文、_(下劃線)、-(中劃線)、.(點(diǎn))
  • 約束:如果名稱不為空,則同一個(gè)租戶下的名稱不能重復(fù)

description

String

  • 功能說明:虛擬私有云描述
  • 取值范圍:0-255個(gè)字符,不能包含“<”和“>”。

cidr

String

  • 功能說明:虛擬私有云下可用子網(wǎng)的范圍
  • 取值范圍:
    • 10.0.0.0/8~24
    • 172.16.0.0/12~24
    • 192.168.0.0/16~24
  • 不指定cidr時(shí),默認(rèn)值為空
  • 約束:必須是cidr格式,例如:192.168.0.0/16

status

String

  • 功能說明:虛擬私有云的狀態(tài)。
  • 取值范圍:
    • CREATING:創(chuàng)建中
    • OK:創(chuàng)建成功

enterprise_project_id

String

  • 功能說明:企業(yè)項(xiàng)目ID。
  • 取值范圍:最大長度36字節(jié),帶“-”連字符的UUID格式,或者是字符串“0”?!?”表示默認(rèn)企業(yè)項(xiàng)目。
    說明:

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

routes

Array of route objects

  • 功能說明:路由信息列表
  • 約束:詳情參見表4。

tenant_id

String

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

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 route對象

名稱

參數(shù)類型

說明

destination

String

  • 功能說明:路由目的網(wǎng)段
  • 約束:必須是cidr格式,且目前只支持0.0.0.0/0

nexthop

String

  • 功能說明:路由下一跳地址
  • 約束:必須為IP地址格式,且必須屬于本VPC下的子網(wǎng)范圍內(nèi)才能生效

響應(yīng)示例

{
    "vpcs": [
        {
            "id": "13551d6b-755d-4757-b956-536f674975c0",
            "name": "default",
            "description": "test",
            "cidr": "172.16.0.0/16",
            "status": "OK",
            "enterprise_project_id": "0",
            "routes": [],
            "tenant_id": "087679f0aa80d32a2f4ec0172f5e902b",
            "created_at": "2022-12-15T02:11:13",
            "updated_at": "2022-12-15T02:11:13"
        },
        {
            "id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85",
            "name": "222",
            "description": "test",
            "cidr": "192.168.0.0/16",
            "status": "OK",
            "enterprise_project_id": "0635d733-c12d-4308-ba5a-4dc27ec21038",
            "routes": [],
            "tenant_id": "087679f0aa80d32a2f4ec0172f5e902b",
            "created_at": "2022-12-15T04:01:21",
            "updated_at": "2022-12-15T04:01:21"
        },
        {
            "id": "99d9d709-8478-4b46-9f3f-2206b1023fd3",
            "name": "vpc",
            "description": "test",
            "cidr": "192.168.0.0/16",
            "status": "OK",
            "enterprise_project_id": "0",
            "routes": [],
            "tenant_id": "087679f0aa80d32a2f4ec0172f5e902b",
            "created_at": "2022-12-15T05:36:29",
            "updated_at": "2022-12-15T05:36:29"
        }
    ]
}

狀態(tài)碼

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

錯(cuò)誤碼

請參考錯(cuò)誤碼。