查詢指定地域下的BGP組。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| vpc:DescribeBgpGroups | get | *VirtualBorderRouter acs:vpc:{#regionId}:{#accountId}:virtualborderrouter/{#VbrId} |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RouterId | string | 否 | BGP 組關聯的 VBR 的 ID。 | vbr-bp1ctxy813985gkuk**** |
| BgpGroupId | string | 否 | BGP 組的 ID。 | bgpg-bp1k25cyp26cllath**** |
| RegionId | string | 是 | VBR 所在的地域 ID。 您可以通過調用 DescribeRegions 接口獲取地域 ID。 | cn-shanghai |
| IsDefault | boolean | 否 | 是否為默認 BGP 組。取值：
| false |
| PageNumber | integer | 否 | 列表的頁碼。默認值：1。 | 1 |
| PageSize | integer | 否 | 分頁查詢時每頁的行數。最大值：50。默認值：10。 | 10 |
返回參數
示例
正常返回示例
JSON格式
{
"PageSize": 10,
"RequestId": "1D0971B2-A35A-42C1-A44C-E91360C36C0B",
"PageNumber": 1,
"TotalCount": 1,
"BgpGroups": {
"BgpGroup": [
{
"Status": "Available",
"BgpGroupId": "bgpg-bp1k25cyp26cllath****",
"RouterId": "vbr-bp1ctxy813985gkuk****",
"PeerAsn": "1****",
"LocalAsn": "45104",
"RegionId": "cn-shanghai",
"Hold": "30",
"IpVersion": "IPv4",
"Description": "BGP組描述。",
"Keepalive": "10",
"IsFake": "true",
"RouteLimit": "99",
"Name": "name",
"AuthKey": "!PWZ****"
}
]
}
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | IellgalParameter.OwnerAccount | The specified parameter OwnerAccount is not valid. | 指定參數 OwnerAccount 不合法 |
| 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. | 請求處理由于某些未知錯誤失敗。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2023-09-11 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更 | 查看變更詳情 |