Queries Border Gateway Protocol (BGP) peers in a region.
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:DescribeBgpPeers | get |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RouterId | string | No | The ID of the virtual border router (VBR) that is associated with the BGP peer that you want to query. | vbr-2zecmmvg5gvu8i4te**** |
| BgpPeerId | string | No | The ID of the BGP peer that you want to query. | bgp-2ze3un0ft1jd1xd**** |
| BgpGroupId | string | No | The ID of the BGP group to which the BGP peer that you want to query belongs. | bgpg-2zev8h2wo414sfh**** |
| RegionId | string | Yes | The region ID of the BGP group to which the BGP peer that you want to query belongs. You can call the DescribeRegions operation to obtain the region ID. | cn-shanghai |
| IsDefault | boolean | No | Specifies whether the BGP group is the default group. Valid values:
| false |
| PageNumber | integer | No | The page number. Default value: 1. | 1 |
| PageSize | integer | No | The number of entries per page. Valid values: 1 to 50. Default value: 10. | 10 |
Response parameters
Examples
Sample success responses
JSONformat
{
"PageSize": 10,
"RequestId": "DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6",
"PageNumber": 1,
"TotalCount": 10,
"BgpPeers": {
"BgpPeer": [
{
"Status": "Available",
"PeerIpAddress": "116.62.XX.XX",
"RouterId": "vbr-2zecmmvg5gvu8i4te****",
"BgpGroupId": "bgpg-2zev8h2wo414sfh****",
"BgpStatus": "Connect",
"BfdMultiHop": 3,
"PeerAsn": "65515",
"LocalAsn": "45104",
"RegionId": "cn-shanghai",
"BgpPeerId": "bgp-2ze3un0ft1jd1xd****",
"EnableBfd": true,
"Hold": "30",
"IpVersion": "ipv4",
"Keepalive": "10",
"Description": "test",
"RouteLimit": "110",
"IsFake": true,
"AuthKey": "!PWZ****",
"Name": "test",
"AdvertisedRouteCount": 0,
"ReceivedRouteCount": 0,
"GmtModified": "2022-05-20T07:29:08Z"
}
]
}
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 404 | InvalidRegionId.NotFound | The specified RegionId does not exist in our records. | The specified region ID does not exist. |
| 500 | InternalError | The request processing has failed due to some unknown error. | An unknown error occurred. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-05-08 | The Error code has changed | View Change Details |
| 2023-09-11 | API Description Update. The Error code has changed | View Change Details |
| 2021-11-17 | The Error code has changed. The response structure of the API has changed | View Change Details |