Modifies the configuration of a Border Gateway Protocol (BGP) group.

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 ModifyBgpGroupAttribute

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

RegionId String Yes cn-shanghai

The ID of the region to which the BGP group belongs.

You can call the DescribeRegions operation to obtain the region ID.

BgpGroupId String Yes bgpg-wz9f62v4fbg2g****

The ID of the BGP group.

Name String No test

The name of the BGP group.

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 and cannot start with http:// or https://.

Description String No BGP

The description of the BGP group.

The description must be 2 to 256 characters in length. It must start with a letter and cannot start with http:// or https://.

LocalAsn Long No 45104

The custom autonomous system number (ASN) of the BGP on the Alibaba Cloud side. Default value: 45104. Valid values:

  • 45104
  • 64512~65534
  • 4200000000~4294967294
Note The value of 65025 is reserved by Alibaba Cloud. If you do not use the default value (45104) in scenarios where multiple connections are established, BGP loops may occur. Proceed with caution.
PeerAsn Long No 1****

The ASN of the gateway device in the data center.

AuthKey String No !PWZ2****

The authentication key of the BGP group.

IsFakeAsn Boolean No false

Specifies whether to use a fake ASN. Valid values:

  • false: does not use a fake ASN.
  • true: uses a fake ASN.
Note A router that runs BGP typically belongs to only one autonomous system. If you want to use a different ASN to communicate with the peer but you cannot modify the BGP configuration because it may cause service interruptions, you can use a fake ASN. For example, you can use a fake ASN to communicate with the peer when you migrate or merge autonomous systems. This prevents service interruptions.
ClientToken String No 123e4567-e89b-12d3-a456-426655440000

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 the value is unique among different requests. The ClientToken value can contain only ASCII characters.

Note If you do not set this parameter, ClientToken is set to the value of RequestId. The value of RequestId may be different for each API request.
RouteQuota Integer No 110

The maximum number of routes supported by a BGP peer. Default value: 110.

ClearAuthKey Boolean No false

Specifies whether to clear the secret key. Valid values:

  • true: clears the secret key.
  • false: does not clear the secret key.

Response parameters

Parameter Type Example Description
RequestId String 8C3C6D7C-A1CE-4FD8-BC57-DC493A55F76F

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ModifyBgpGroupAttribute
&RegionId=cn-shanghai
&BgpGroupId=bgpg-wz9f62v4fbg2g****
&Name=test
&Description=BGP
&LocalAsn=45104
&AuthKey=!PWZ2****
&IsFakeAsn=false
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&RouteQuota=110
&ClearAuthKey=false
&<Common request parameters>

Sample success responses

XML format

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

<ModifyBgpGroupAttributeResponse>
    <RequestId>8C3C6D7C-A1CE-4FD8-BC57-DC493A55F76F</RequestId>
</ModifyBgpGroupAttributeResponse>

JSON format

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

{
  "RequestId" : "8C3C6D7C-A1CE-4FD8-BC57-DC493A55F76F"
}

Error codes

HttpCode Error code Error message Description
400 QuotaExceeded.Bgp bgp peer count per vbr quota exceed. The error message returned because the number of BGP groups of the virtual border router (VBR) has reached the upper limit.
400 QuotaExceeded.Nqa nqa count per vbr quota exceed. The error message returned because 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 error message returned because the number of BGP networks advertised to the VBR has reached the upper limit.
400 InvalidPeerIpAddress multi pconn peer ip can not be null. The error message returned because the IP addresses of multiple Express Connect circuits cannot be empty.
400 InvalidVbrNetwork vbr netowrk not exists The error message returned because the specified VBR does not exist. Check whether the specified VBR ID is valid.
400 InvalidBgpGroup bgp group not exists The error message returned because the BGP group does not exist.
400 InvalidBgpName.Malformed Specified Bgp Group name is not valid. The error message returned because the name of the BGP group is invalid.
400 InvalidBgpDiscription.Malformed Specified Bgp Group description is not valid. The error message returned because the description of the BGP group is invalid.
400 InvalidBgpAuthkey.Malformed Specified Bgp Group authkey is not valid. The error message returned because the authentication key of the BGP group is invalid.
400 InvalidIP.Malformed Ip malformed. The error message returned because the format of the IP address is invalid.
400 InvalidPeerAsn.Malformed invalid peer asn cannot equals aliyun asn:45104 The error message returned because the ASN cannot be the same as the ASN on the Alibaba Cloud side.
400 InvalidParams.NotFound instance not found The error message returned because the specified instance does not exist.
400 InvalidParams.NotFound vpc instance not found The error message returned because the specified virtual private cloud (VPC) does not exist. Check whether the specified VPC ID is valid.
400 InvalidParams.AlreadyExists bgp network already exists The error message returned because the BGP network already exists.
400 InvalidStatus.CannotOperate invalid status cannot operate The error message returned because 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. The error message returned because the PeerIpAddress parameter was not set.
400 InvalidParams.PeerIpAddressInUse peer ip address in use ,cannot create bgp peer. The error message returned because the peer IP address is being used. Therefore, you cannot use it to create a BGP peer.
400 OperationFailed.PconnTrafficNotEnable The operation is failed because of PconnTrafficNotEnable. The error message returned because billing for outbound data transfer is disabled.
400 OperationUnsupport Operation is unsupport, not in vbr support custom local asn white list. The error message returned because the operation is not supported.
400 OperationFailed.ClearAuthKeyForbidden The specific auth key is not empty. The error message returned because the specified secret key is not empty and cannot cleared.
404 InvalidRegionId.NotFound Specified value of "regionId" is not supported. The error message returned because the value of the RegionId parameter is invalid. Check whether the service is available in the specified region and try again.

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