文档

CheckVpnBgpEnabled - 查询IPsec连接所属的地域是否支持BGP功能

更新时间:

调用CheckVpnBgpEnabled接口查询IPsec连接所属的地域是否支持BGP功能。

调试

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

授权信息

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

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

请求参数

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

IPsec 连接所属的地域 ID。

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

ap-southeast-2
ClientTokenstring

客户端 Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。
123e4567-e89b-12d3-a456-4266****

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

DF448D2E-215D-334F-B10D-7C3B087EF996
BgpEnabledboolean

当前地域是否支持 BGP 功能。

  • true:支持。
  • false:不支持。
true

示例

正常返回示例

JSON格式

{
  "RequestId": "DF448D2E-215D-334F-B10D-7C3B087EF996",
  "BgpEnabled": true
}

错误码

HTTP status code错误码错误信息描述
403ForbiddenUser not authorized to operate on the specified resource.您没有权限操作指定资源,请申请权限后再操作。

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

变更历史

变更时间变更内容概要操作
2023-06-12OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    新增错误码:403
  • 本页导读 (1)
文档反馈