All Products
Search
Document Center

Virtual Private Cloud:CheckVpnBgpEnabled

Last Updated:Dec 02, 2023

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

debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

debugging

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
vpc:CheckVpnBgpEnabledRead
  • VpnGateway
    acs:vpc:{#regionId}:{#accountId}:vpngateway/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region to which the IPsec-VPN connection belongs.

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

ap-southeast-2
ClientTokenstringNo

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

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

Note If you do not set this parameter, the system automatically uses RequestId as ClientToken. RequestId of each API request may be different.
123e4567-e89b-12d3-a456-4266****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

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

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

  • true: supported.
  • false: not supported.
true

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
403ForbiddenUser not authorized to operate on the specified resource.You do not have the permissions to manage the specified resource. Apply for the permissions and try again.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-06-12The error codes of the API operation change.see changesets
Change itemChange content
Error CodesThe error codes of the API operation change.
    Added Error Codes: 403