All Products
Document Center

Virtual Private Cloud:ModifyBgpPeerAttribute

Last Updated:Dec 01, 2023

Modifies the configuration of a BGP peer.


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.


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
  • VirtualBorderRouter

Request parameters


The region ID of the BGP group to which the BGP peer that you want to modify belongs.

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


The ID of the BGP peer that you want to modify.


The ID of the BGP group to which the BGP peer that you want to modify belongs.


The IP address of the BGP peer that you want to modify.


Specifies whether to enable the Bidirectional Forwarding Detection (BFD) feature. Valid values:

  • true
  • false (default)

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 and cannot exceed 64 characters in length.

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.

The BFD hop count. Valid values: 1 to 255.

This parameter is required only if you enable BFD. The parameter specifies the maximum number of network devices that a packet can traverse from the source to the destination. Set a value based on your network topology.


Response parameters


The request ID.



Sample success responses


  "RequestId": "D4B7649A-61BB-4C64-A586-1DFF1EDA6A42"

Error codes

HTTP status codeError codeError messageDescription
400IllegalParam.IpAddressThe specified IpAddress is illegal.-
400InvalidAccessDeviceId.NotFoundThere is no Access_Device_Id in our records-
400QuotaExceeded.BfdSessionYour Bfd Session number reaches the upper limit.-
400QuotaExceeded.BfdSessionThe Bfd Session on device reaches the upper limit.-
400MissingParam.BgpPeerIdThe parameter BgpPeerId is mandatory.-
400InvalidBgpPeer.NotFoundThe specified BgpPeerId does not exit in our records.-
400InvalidRegionId.NotFoundThe specified RegionId does not exist in our records.The specified region ID does not exist.
400IncorrectStatus.BgpPeerInvalid BgpPeer status cannot operate.The status of the BGP peer does not support this operation.
400MissingParam.EnableBfdThe parameter EnableBfd is missing.-
400IllegalParam.BfdMultiHopBfdMultiHop is illegal.-
400OperationFailed.PconnTrafficNotEnableThe operation is failed because of PconnTrafficNotEnable.Billing for outbound data transfer is disabled.
404InvalidBgpPeerId.NotFoundThe specified BgpPeerId does not exit in our records.-
404IncorretStatus.BgpPeerThe specified BgpPeer status is not stable, can not operate.-
500Internal.ErrorThe request processing has failed due to some unknown error, exception or failure.-

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

Change history

Change timeSummary of changesOperation
No change history