All Products
Search
Document Center

:CheckVpnBgpEnabled

最終更新日:Aug 25, 2023

Checks whether the region of an IPsec-VPN connection supports BGP.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter

Type

Required

Example

Description

Action String Yes CheckVpnBgpEnabled

The operation that you want to perform. Set the value to CheckVpnBgpEnabled.

RegionId String Yes ap-southeast-2

The region ID of the IPsec connection.

You can call the DescribeRegions operation to query the most recent region list.

ClientToken String No 123e4567-e89b-12d3-a456-4266****

The client token that is used to ensure the idempotence of the request.

You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.

Note

If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.

Response parameters

Parameter

Type

Example

Description

RequestId String DF448D2E-215D-334F-B10D-7C3B087EF996

The request ID.

BgpEnabled Boolean true

Indicates whether the BGP feature is supported in the current region.

  • true
  • false

Examples

Sample requests

http(s)://[Endpoint]/?Action=CheckVpnBgpEnabled
&RegionId=ap-southeast-2
&ClientToken=123e4567-e89b-12d3-a456-4266****
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<CheckVpnBgpEnabledResponse>
    <RequestId>DF448D2E-215D-334F-B10D-7C3B087EF996</RequestId>
    <BgpEnabled>true</BgpEnabled>
</CheckVpnBgpEnabledResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

HttpCode

Error code

Error message

Description

403 Forbidden User not authorized to operate on the specified resource. You are unauthorized to perform this operation on the specified resource. Acquire the required permissions and try again.

For a list of error codes, see Service error codes.