Modifies the configuration of a Border Gateway Protocol (BGP) group.
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The region ID of the BGP group. You can call the DescribeRegions operation to query the most recent region list. | cn-shanghai |
| BgpGroupId | string | Yes | The BGP group ID. | bgpg-wz9f62v4fbg2g**** |
| Name | string | No | The BGP group name. The name must be 2 to 128 characters in length, and can contain digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter but cannot start with | test |
| Description | string | No | The BGP group description. The description must be 2 to 256 characters in length. It must start with a letter and cannot start with | BGP |
| LocalAsn | long | No | The custom autonomous system number (ASN) of the BGP on the Alibaba Cloud side. Valid values:
Note
65025 is reserved by Alibaba Cloud. Alibaba Cloud uses 45104 as the local ASN by default. Custom local ASNs may cause loops in multi-line scenarios. Proceed with caution.
| 45104 |
| PeerAsn | long | No | The ASN of the gateway device in the data center. | 1**** |
| AuthKey | string | No | The authentication key of the BGP group. | !PWZ2**** |
| IsFakeAsn | boolean | No | Specifies whether to use a fake AS number. Valid values:
Note
A router that runs BGP typically belongs to only one AS. If you need to replace an AS with a new one, but you cannot immediately modify BGP configurations due to business requirements, you can specify a fake AS number to establish a connection with the local end. This ensures service continuity in scenarios such as AS migration or AS merging.
| false |
| ClientToken | string | No | 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 client 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.
| 123e4567-e89b-12d3-a456-426655440000 |
| RouteQuota | integer | No | The maximum number of routes supported by a BGP peer. Default value: 110. | 110 |
| ClearAuthKey | boolean | No | Specifies whether to clear the secret key. Valid values:
| false |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "8C3C6D7C-A1CE-4FD8-BC57-DC493A55F76F"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | QuotaExceeded.Bgp | bgp peer count per vbr quota exceed. | The number of BGP peers in the VBR has reached the upper limit. |
| 400 | QuotaExceeded.Nqa | nqa count per vbr quota exceed. | The number of Network Quality Analyzers (NQAs) has reached the upper limit that is supported by the VBR. |
| 400 | QuotaExceeded.BgpNetwork | bgp network count per vbr quota exceed. | The number of BGP networks in the VBR has reached the upper limit. |
| 400 | InvalidPeerIpAddress | multi pconn peer ip can not be null. | The IP addresses of multiple Express Connect circuits cannot be empty. |
| 400 | InvalidVbrNetwork | vbr netowrk not exists | The VBR does not exist. Check the VBR ID. |
| 400 | InvalidBgpGroup | bgp group not exists | The BGP group does not exist. |
| 400 | InvalidBgpName.Malformed | Specified Bgp Group name is not valid. | The name of the BGP group is invalid. |
| 400 | InvalidBgpDiscription.Malformed | Specified Bgp Group description is not valid. | The description of the BGP group is invalid. |
| 400 | InvalidBgpAuthkey.Malformed | Specified Bgp Group authkey is not valid. | The authentication key of the BGP group is invalid. |
| 400 | InvalidIP.Malformed | Ip malformed. | The format of the IP address is invalid. |
| 400 | InvalidPeerAsn.Malformed | invalid peer asn cannot equals aliyun asn:45104 | The AS number cannot be the same as the AS number on the Alibaba Cloud side. |
| 400 | InvalidParams.NotNull | %s | - |
| 400 | InvalidBgpGroup.LocalAsnInvalid | The specified BgpGroup LocalAsn is invalid, only support 64512 to 65534 or 4200000000 to 4294967294, and cannot be 65025. | - |
| 400 | InvalidParams.NotFound | instance not found | The specified instance does not exist. |
| 400 | InvalidParams.NotFound | vpc instance not found | The VPC does not exist. Check whether the specified VPC is valid. |
| 400 | InvalidParams.AlreadyExists | bgp network already exists | The BGP network already exists. |
| 400 | InvalidStatus.CannotOperate | invalid status cannot operate | You cannot perform the operation when the specified resource is in the current state. |
| 400 | InvalidParams.PeerIpAddressMustPointOut | vbr has 0 or more than 1 subif ,point out peerIpAddress. | You must set the PeerIpAddress parameter. |
| 400 | InvalidParams.PeerIpAddressInUse | peer ip address in use ,cannot create bgp peer. | The peer IP address is being used. Therefore, you cannot use it to create a BGP peer. |
| 400 | InvalidStatus.CannotOperate | Instance is not in stable status,please wait and try again. | - |
| 400 | IllegalParam.PeerAsn | %s | - |
| 400 | IllegalParam.LocalAsn | %s | - |
| 400 | OperationFailed.PconnTrafficNotEnable | The operation is failed because of PconnTrafficNotEnable. | Billing for outbound data transfer is disabled. |
| 400 | OperationUnsupport | Operation is unsupport, not in vbr support custom local asn white list. | The operation is not supported. |
| 400 | OperationFailed.ClearAuthKeyForbidden | The specific auth key is not empty. | The specified key is not empty and cannot be cleared. |
| 400 | IllegalParam.RouteLimit | The operation is failed because of bgp group max route entry num quota exceed. | The number of routes that can be received by each BGP peer in the BGP group exceeds the upper limit. |
| 400 | OperationDenied.VbrAttachEcrInMiddleStatus | The operation is not allowed because of VBR attach or detach ECR in middle status. | The current operation cannot be performed because the VBR is in the process of loading or unloading the leased line gateway. Please wait a moment and try again. |
| 400 | OperationUnsupported.VBRAttachedECR | VBR already attached to ECR, please delete it from ECR. | The VBR has been bound to ECR. Delete the VBR from ECR and try again. |
| 404 | InvalidRegionId.NotFound | Specified value of "regionId" is not supported. | RegionId is set to an invalid value. Check whether the service is available in the specified region and try again. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-06-19 | The Error code has changed | View Change Details |
| 2024-06-13 | API Description Update. The Error code has changed | View Change Details |