Queries prefix routes that are in the Active, Creating, and Deleting states of a virtual border router (VBR).

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 DescribeVbrAllowPrefixes

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

RegionId String Yes cn-hangzhou

The ID of the region where you want to query prefix routes.

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

VbrId String Yes vbr-bp1jcg5cmxjbl9xgc****

The VBR ID.

Response parameters

Parameter Type Example Description
RequestId String DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6

The request ID.

RegionId String cn-hangzhou

The region ID.

Status String Active

The status of the prefix route. Valid values:

  • Active
  • Creating
  • Deleting
VbrId String vbr-bp1jcg5cmxjbl9xgc****

The VBR ID.

AllowPrefixes Array of String 10.0.0.0/8

The prefix routes.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeVbrAllowPrefixes
&RegionId=cn-hangzhou
&VbrId=vbr-bp1jcg5cmxjbl9xgc****
&Common request parameters

Sample success responses

XML format

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

<DescribeVbrAllowPrefixesResponse>
    <RequestId>DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6</RequestId>
    <RegionId>cn-hangzhou</RegionId>
    <Status>Active</Status>
    <VbrId>vbr-bp1jcg5cmxjbl9xgc****</VbrId>
    <AllowPrefixes>10.0.0.0/8</AllowPrefixes>
</DescribeVbrAllowPrefixesResponse>

JSON format

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

{
  "RequestId" : "DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6",
  "RegionId" : "cn-hangzhou",
  "Status" : "Active",
  "VbrId" : "vbr-bp1jcg5cmxjbl9xgc****",
  "AllowPrefixes" : [ "10.0.0.0/8" ]
}

Error codes

HttpCode Error code Error message Description
404 ResourceNotFound.Vbr The VBR resource is not found. The VBR resource is not found.

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