DescribeBgpNetworks - 查询已宣告的BGP网络

调用DescribeBgpNetworks查询已宣告的BGP网络。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vpc:DescribeBgpNetworksget
  • VirtualBorderRouter
    acs:vpc:{#regionId}:{#accountId}:virtualborderrouter/{#VbrId}

请求参数

名称类型必填描述示例值
RouterIdstring

边界路由器 ID。

vrt-bp1lhl0taikrteen8****
RegionIdstring

BGP 组所在的地域。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-hangzhou
PageNumberinteger

列表的页码。默认值:1

1
PageSizeinteger

分页查询时每页的行数。最大值:50。默认值:10

10

返回参数

名称类型描述示例值
object

分页查询时每页的行数。

PageSizeinteger

分页查询时每页的行数。

10
RequestIdstring

请求 ID。

6F513A15-669F-419D-B511-08A85292059B
PageNumberinteger

列表的页码。

1
TotalCountinteger

已宣告的 BGP 网络总数。

2
BgpNetworksarray<object>

BGP 网络。

BgpNetworkobject

BGP 网络。

Statusstring

已宣告的 BGP 网络状态。

Enabled
VpcIdstring

VPC 的 ID。

vpc-bp1qpo0kug3a2*****
DstCidrBlockstring

已宣告的 BGP 网络的网段。

10.1.XX.XX/24
RouterIdstring

边界路由器 ID。

vrt-bp1lhl0taikrteen8****

示例

正常返回示例

JSON格式

{
  "PageSize": 10,
  "RequestId": "6F513A15-669F-419D-B511-08A85292059B",
  "PageNumber": 1,
  "TotalCount": 2,
  "BgpNetworks": {
    "BgpNetwork": [
      {
        "Status": "Enabled",
        "VpcId": "vpc-bp1qpo0kug3a2*****",
        "DstCidrBlock": "10.1.XX.XX/24",
        "RouterId": "vrt-bp1lhl0taikrteen8****"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
404InvalidRegionId.NotFoundThe specified RegionId does not exist in our records.指定的RegionId不存在。
500InternalErrorThe request processing has failed due to some unknown error.请求处理由于某些未知错误失败。
500InternalErrorThe request processing has failed due to some unknown error, exception or failure.内部错误

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-09-11OpenAPI 描述信息更新、OpenAPI 错误码发生变更查看变更详情