華為云計(jì)算 云知識(shí) 查詢對(duì)等連接列表ListVpcPeerings
查詢對(duì)等連接列表ListVpcPeerings

 

功能介紹

查詢提交請(qǐng)求的租戶的所有對(duì)等連接。根據(jù)過(guò)濾條件進(jìn)行過(guò)濾。分頁(yè)查詢請(qǐng)參考分頁(yè)查詢。

調(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ù)說(shuō)明請(qǐng)參見(jiàn)表1。
表1 參數(shù)說(shuō)明

名稱

是否必選

參數(shù)類型

說(shuō)明

id

String

按照peering_id過(guò)濾查詢

name

String

  • 功能說(shuō)明:按照peering_name過(guò)查詢
  • 取值范圍:最大長(zhǎng)度不超過(guò)64

status

String

按照status進(jìn)行過(guò)濾

tenant_id

String

按照tenant_id過(guò)濾查詢

vpc_id

String

按照vpc_id過(guò)濾查詢

marker

String

分頁(yè)查詢的起始資源ID,表示從指定資源的下一條記錄開(kāi)始查詢。

marker需要和limit配合使用:

  • 若不傳入marker和limit參數(shù),查詢結(jié)果返回第一頁(yè)全部資源記錄。
  • 若不傳入marker參數(shù),limit為10,查詢結(jié)果返回第1~10條資源記錄。
  • 若marker為第10條記錄的資源ID,limit為10,查詢結(jié)果返回第11~20條資源記錄。
  • 若marker為第10條記錄的資源ID,不傳入limit參數(shù),查詢結(jié)果返回第11條及之后的所有資源記錄。

limit

Integer

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

limit需要和marker配合使用,詳細(xì)規(guī)則請(qǐng)見(jiàn)marker的參數(shù)說(shuō)明。

默認(rèn)值為2000。

請(qǐng)求參數(shù)

無(wú)

請(qǐng)求示例

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

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

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

參數(shù)名稱

類型

說(shuō)明

peerings

Array of peering objects

peering對(duì)象列表,參見(jiàn)表3。

peerings_links

Array of peerings_link objects

peerings_link對(duì)象列表,參見(jiàn)表5。

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

表3 peering對(duì)象

屬性

類型

說(shuō)明

id

String

對(duì)等連接id

name

String

對(duì)等連接的名稱

status

String

狀態(tài)位:

  • PENDING_ACCEPTANCE:等待接受
  • REJECTED:已拒絕。
  • EXPIRED:已過(guò)期。
  • DELETED:已刪除。
  • ACTIVE:活動(dòng)的。

request_vpc_info

vpc_info object

對(duì)等連接發(fā)起端vpc信息,請(qǐng)參見(jiàn)表4。

accept_vpc_info

vpc_info object

對(duì)等連接接受端vpc信息,請(qǐng)參見(jiàn)表4。

description

String

對(duì)等連接描述

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 vpc_info對(duì)象

屬性

類型

說(shuō)明

vpc_id

String

對(duì)等連接其中一端vpc id

tenant_id

String

對(duì)等連接其中一端vpc所屬的項(xiàng)目id

表5 peerings_link對(duì)象

名稱

參數(shù)類型

說(shuō)明

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)碼

請(qǐng)參見(jiàn)狀態(tài)碼。

錯(cuò)誤碼

請(qǐng)參考錯(cuò)誤碼。