華為云計算 云知識 查詢對等連接列表ListVpcPeerings
查詢對等連接列表ListVpcPeerings

 

功能介紹

查詢提交請求的租戶的所有對等連接。根據(jù)過濾條件進行過濾。分頁查詢請參考分頁查詢。

調(diào)試

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

URI

GET /v2.0/vpc/peerings

樣例:

GET https://{Endpoint}/v2.0/vpc/peerings?id={id}&name={name}&status={status}&
tenant_id={tenant_id}&vpc_id={vpc_id}&limit={limit}&marker={marker}
參數(shù)說明請參見表1。
表1 參數(shù)說明

名稱

是否必選

參數(shù)類型

說明

id

String

按照peering_id過濾查詢

name

String

  • 功能說明:按照peering_name過查詢
  • 取值范圍:最大長度不超過64

status

String

按照status進行過濾

tenant_id

String

按照tenant_id過濾查詢

vpc_id

String

按照vpc_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

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

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

默認值為2000。

請求參數(shù)

請求示例

GET https://{Endpoint}/v2.0/vpc/peerings

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

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

參數(shù)名稱

類型

說明

peerings

Array of peering objects

peering對象列表,參見表3。

peerings_links

Array of peerings_link objects

peerings_link對象列表,參見表5。

只有在使用limit過濾,并且資源個數(shù)超過limit或者資源個數(shù)超過2000時(limit默認值),該參數(shù)的rel和href取值才會顯示為next和其對應(yīng)的link。

表3 peering對象

屬性

類型

說明

id

String

對等連接id

name

String

對等連接的名稱

status

String

狀態(tài)位:

  • PENDING_ACCEPTANCE:等待接受
  • REJECTED:已拒絕。
  • EXPIRED:已過期。
  • DELETED:已刪除。
  • ACTIVE:活動的。

request_vpc_info

vpc_info object

對等連接發(fā)起端vpc信息,請參見表4。

accept_vpc_info

vpc_info object

對等連接接受端vpc信息,請參見表4。

description

String

對等連接描述

created_at

String

資源創(chuàng)建時間,UTC時間

格式:yyyy-MM-ddTHH:mm:ss

updated_at

String

資源更新時間,UTC時間

格式:yyyy-MM-ddTHH:mm:ss

表4 vpc_info對象

屬性

類型

說明

vpc_id

String

對等連接其中一端vpc id

tenant_id

String

對等連接其中一端vpc所屬的項目id

表5 peerings_link對象

名稱

參數(shù)類型

說明

href

String

API鏈接

rel

String

API鏈接與該API版本的關(guān)系

響應(yīng)示例

{
    "peerings": [
        {
            "request_vpc_info": {
                "vpc_id": "9daeac7c-a98f-430f-8e38-67f9c044e299",
                "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e"
            },
            "accept_vpc_info": {
                "vpc_id": "f583c072-0bb8-4e19-afb2-afb7c1693be5",
                "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e"
            },
            "name": "test",
            "description": "test",
            "id": "b147a74b-39bb-4c7a-aed5-19cac4c2df13",
            "status": "ACTIVE"
        }
    ]
}

狀態(tài)碼

請參見狀態(tài)碼

錯誤碼

請參考錯誤碼。