Modifies the configuration of a BGP peer.
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| vpc:ModifyBgpPeerAttribute | update | *VirtualBorderRouter acs:vpc:{#regionId}:{#accountId}:virtualborderrouter/{#VirtualBorderRouterId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | 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. | cn-shanghai |
| BgpPeerId | string | Yes | The ID of the BGP peer that you want to modify. | bgp-m5eoyp2mwegk8ce9v**** |
| BgpGroupId | string | No | The ID of the BGP group to which the BGP peer that you want to modify belongs. | bgpg-m5eo12jxuw2hc0uqq**** |
| PeerIpAddress | string | No | The IP address of the BGP peer that you want to modify. | 116.62.XX.XX |
| EnableBfd | boolean | No | Specifies whether to enable the Bidirectional Forwarding Detection (BFD) feature. Valid values:
| 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 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.
| 123e4567-e89b-12d3-a456-426655440000 |
| BfdMultiHop | integer | No | 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. | 3 |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "D4B7649A-61BB-4C64-A586-1DFF1EDA6A42"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | IllegalParam.IpAddress | The specified IpAddress is illegal. | The specified IpAddress is illegal |
| 400 | InvalidAccessDeviceId.NotFound | There is no Access_Device_Id in our records | - |
| 400 | QuotaExceeded.BfdSession | Your Bfd Session number reaches the upper limit. | - |
| 400 | QuotaExceeded.BfdSession | The Bfd Session on device reaches the upper limit. | - |
| 400 | MissingParam.BgpPeerId | The parameter BgpPeerId is mandatory. | - |
| 400 | InvalidBgpPeer.NotFound | The specified BgpPeerId does not exit in our records. | - |
| 400 | InvalidRegionId.NotFound | The specified RegionId does not exist in our records. | The specified region ID does not exist. |
| 400 | IncorrectStatus.BgpPeer | Invalid BgpPeer status cannot operate. | The status of the BGP peer does not support this operation. |
| 400 | MissingParam.EnableBfd | The parameter EnableBfd is missing. | - |
| 400 | IllegalParam.BfdMultiHop | BfdMultiHop is illegal. | - |
| 400 | OperationFailed.PconnTrafficNotEnable | The operation is failed because of PconnTrafficNotEnable. | Billing for outbound data transfer is disabled. |
| 404 | InvalidBgpPeerId.NotFound | The specified BgpPeerId does not exit in our records. | - |
| 404 | IncorretStatus.BgpPeer | The specified BgpPeer status is not stable, can not operate. | - |
| 500 | Internal.Error | The 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 time | Summary of changes | Operation |
|---|---|---|
| 2024-01-04 | API Description Update. The Error code has changed | View Change Details |