All Products
Search
Document Center

Virtual Private Cloud:DescribeBgpNetworks

Last Updated:Mar 22, 2024

Queries advertised Border Gateway Protocol (BGP) networks.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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
vpc:DescribeBgpNetworksRead
  • VirtualBorderRouter
    acs:vpc:{#regionId}:{#accountId}:virtualborderrouter/{#VbrId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RouterIdstringNo

The ID of the VBR.

vrt-bp1lhl0taikrteen8****
RegionIdstringYes

The region ID of the BGP group.

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

cn-hangzhou
PageNumberintegerNo

The page number. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Maximum value: 50. Default value: 10.

10

Response parameters

ParameterTypeDescriptionExample
object

The number of entries per page.

PageSizeinteger

The number of entries per page.

10
RequestIdstring

The request ID.

6F513A15-669F-419D-B511-08A85292059B
PageNumberinteger

The page number.

1
TotalCountinteger

The total number of advertised BGP networks.

2
BgpNetworksobject []

The BGP network.

Statusstring

The status of the advertised BGP network.

Enabled
VpcIdstring

The ID of the virtual private cloud (VPC) in which the master instance resides.

vpc-bp1qpo0kug3a2*****
DstCidrBlockstring

The CIDR block of the advertised BGP network.

10.1.XX.XX/24
RouterIdstring

The ID of the VBR.

vrt-bp1lhl0taikrteen8****

Examples

Sample success responses

JSONformat

{
  "PageSize": 10,
  "RequestId": "6F513A15-669F-419D-B511-08A85292059B",
  "PageNumber": 1,
  "TotalCount": 2,
  "BgpNetworks": {
    "BgpNetwork": [
      {
        "Status": "Enabled",
        "VpcId": "vpc-bp1qpo0kug3a2*****",
        "DstCidrBlock": "10.1.XX.XX/24",
        "RouterId": "vrt-bp1lhl0taikrteen8****"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
404InvalidRegionId.NotFoundThe specified RegionId does not exist in our records.The specified region ID does not exist.
500InternalErrorThe request processing has failed due to some unknown error.An unknown error occurred.
500InternalErrorThe request processing has failed due to some unknown error, exception or failure.An internal error occurred.

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

Change history

Change timeSummary of changesOperation
2023-09-11API Description Update. The Error code has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    delete Error Codes: 404
    delete Error Codes: 500