調(diào)用DescribeBgpPeers接口查詢指定地域下的BGP鄰居。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下：
- 操作：是指具體的權(quán)限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| vpc:DescribeBgpPeers | get | *VirtualBorderRouter acs:vpc:{#regionId}:{#accountId}:virtualborderrouter/{#VbrId} |
| 無 |
請求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RouterId | string | 否 | 要查詢的 BGP 鄰居關(guān)聯(lián)的 VBR ID。 | vbr-2zecmmvg5gvu8i4te**** |
| BgpPeerId | string | 否 | 要查詢的 BGP 鄰居的 ID。 | bgp-2ze3un0ft1jd1xd**** |
| BgpGroupId | string | 否 | 要查詢的 BGP 鄰居所在 BGP 組的 ID。 | bgpg-2zev8h2wo414sfh**** |
| RegionId | string | 是 | 要查詢的 BGP 鄰居所在 BGP 組的地域 ID。 您可以通過調(diào)用 DescribeRegions 接口獲取地域 ID。 | cn-shanghai |
| IsDefault | boolean | 否 | 是否是默認 BGP 組。取值：
| false |
| PageNumber | integer | 否 | 列表的頁碼。默認值：1。 | 1 |
| PageSize | integer | 否 | 分頁查詢時每頁的行數(shù)。最大值：50。默認值：10。 | 10 |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"PageSize": 10,
"RequestId": "DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6",
"PageNumber": 1,
"TotalCount": 10,
"BgpPeers": {
"BgpPeer": [
{
"Status": "Available",
"PeerIpAddress": "116.62.XX.XX",
"RouterId": "vbr-2zecmmvg5gvu8i4te****",
"BgpGroupId": "bgpg-2zev8h2wo414sfh****",
"BgpStatus": "Connect",
"BfdMultiHop": 3,
"PeerAsn": "65515",
"LocalAsn": "45104",
"RegionId": "cn-shanghai",
"BgpPeerId": "bgp-2ze3un0ft1jd1xd****",
"EnableBfd": true,
"Hold": "30",
"IpVersion": "ipv4",
"Keepalive": "10",
"Description": "test",
"RouteLimit": "110",
"IsFake": true,
"AuthKey": "!PWZ****",
"Name": "test",
"AdvertisedRouteCount": 0,
"ReceivedRouteCount": 0,
"GmtModified": "2022-05-20T07:29:08Z"
}
]
}
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | ServiceUnavailable | The request has failed due to a temporary failure of the server. | 請求失敗，因為臨時服務(wù)器故障。 |
| 404 | InvalidRegionId.NotFound | The specified RegionId does not exist in our records. | 指定的RegionId不存在。 |
| 500 | InternalError | The request processing has failed due to some unknown error. | 請求處理由于某些未知錯誤失敗。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-05-08 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2023-09-11 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2021-11-17 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |