Queries vRouters in a region.

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 DescribeVRouters

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

VRouterId String No vrt-bp1lhl0taikrteen****

The ID of the vRouter.

RegionId String Yes cn-hangzhou

The region ID of the vRouter that you want to query.

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

PageNumber Integer No. 1

The number of the page to return. Default value: 1.

PageSize Integer No. 10

The number of entries to return on each page. Maximum value: 50. Default value: 10.

Response parameters

Parameter Type Example Description
PageSize Integer 10

The number of entries returned per page.

RequestId String 0ED8D006-F706-4D23-88ED-E11ED28DCAC0

The ID of the request.

PageNumber Integer 1

The page number of the returned page.

TotalCount Integer 1

The number of entries returned.

VRouters Array of VRouter

The details about the vRouters.

VRouter
VpcId String vpc-rj905wotv6y030t1****

The ID of the virtual private cloud (VPC) to which the vRouter belongs.

CreationTime String 2018-03-22T07:46:20Z

The time when the vRouter was created.

VRouterId String vrt-rj98khsezfqpjrxmv****

The ID of the vRouter.

Description String abc

The description of the vRouter.

VRouterName String doctest

The name of the vRouter.

RegionId String cn-hangzhou

The region to which the vRouter belongs.

RouteTableIds Array of String { "RouteTableId": [ "vtb-rj9ybe3y0u41mmjsp****"] }

The ID of the route table in the vRouter.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeVRouters
&VRouterId=vrt-bp1lhl0taikrteen****
&RegionId=cn-hangzhou
&PageNumber=1
&PageSize=10
&Common request parameters

Sample success responses

XML format

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

<DescribeVRoutersResponse>
    <PageSize>10</PageSize>
    <RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>
    <PageNumber>1</PageNumber>
    <TotalCount>1</TotalCount>
    <VRouters>
        <VpcId>vpc-rj905wotv6y030t1****</VpcId>
        <CreationTime>2018-03-22T07:46:20Z</CreationTime>
        <VRouterId>vrt-rj98khsezfqpjrxmv****</VRouterId>
        <Description>abc</Description>
        <VRouterName>doctest</VRouterName>
        <RegionId>cn-hangzhou</RegionId>
        <RouteTableIds>{ "RouteTableId": [ "vtb-rj9ybe3y0u41mmjsp****"] }</RouteTableIds>
    </VRouters>
</DescribeVRoutersResponse>

JSON format

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

{
  "PageSize" : 10,
  "RequestId" : "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "PageNumber" : 1,
  "TotalCount" : 1,
  "VRouters" : [ {
    "VpcId" : "vpc-rj905wotv6y030t1****",
    "CreationTime" : "2018-03-22T07:46:20Z",
    "VRouterId" : "vrt-rj98khsezfqpjrxmv****",
    "Description" : "abc",
    "VRouterName" : "doctest",
    "RegionId" : "cn-hangzhou",
    "RouteTableIds" : [ "{ \"RouteTableId\": [ \"vtb-rj9ybe3y0u41mmjsp****\"] }" ]
  } ]
}

Error codes

For a list of error codes, visit the API Error Center.