查询指定地域下的BGP组。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| vpc:DescribeBgpGroups | get |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| 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. | - |
| 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 错误码发生变更 | 查看变更详情 |