Queries the routes of a Smart Access Gateway (SAG) instance.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeSagRouteList |
The operation that you want to perform. Set the value to DescribeSagRouteList. |
RegionId | String | Yes | cn-shanghai |
The ID of the region where the SAG instance is deployed. |
SmartAGId | String | Yes | sag-whfn**** |
The ID of the SAG instance. |
SmartAGSn | String | Yes | sag32a30**** |
The serial number of the SAG device associated with the SAG instance. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | CE6642D4-21EB-4168-9BF9-F217953F9892 |
The ID of the request. |
Routes | Array of Route |
The routes. |
|
NextHop | String | 192.XX.XX.1 |
The next hop. |
DestinationCidr | String | 6.XX.XX.6/32 |
The destination CIDR block. |
Cost | String | [110/11] |
The cost of the route. The number on the left side of the forward slash (/) indicates the administrative distance (AD) of the routing protocol. The number on the right side of the forward slash (/) indicates the metric value. |
PortName | String | 2 |
The name of the port. If the port name is -1, data is transferred through a VPN tunnel to Alibaba Cloud. |
ConflictCidrs | Array of String | 192.XX.XX.0/24 |
The list of CIDR blocks that overlap with each other. |
RouteProtocol | String | STATIC |
The routing protocol. Valid values:
|
Examples
Sample requests
http(s)://smartag.cn-shanghai.aliyuncs.com/?Action=DescribeSagRouteList
&RegionId=cn-shanghai
&SmartAGId=sag-whfn****
&SmartAGSn=sag32a30****
&<Common request parameters>
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeSagRouteListResponse>
<RequestId>4D2C2B28-2C90-4D2F-AF44-59355547D70B</RequestId>
<Routes>
<RouteProtocol>STATIC</RouteProtocol>
<NextHop/>
<PortName>2</PortName>
<Cost>[0/0]</Cost>
<DestinationCidr>192.XX.XX.0/24</DestinationCidr>
</Routes>
<Routes>
<RouteProtocol>STATIC</RouteProtocol>
<NextHop/>
<PortName>4</PortName>
<Cost>[0/0]</Cost>
<DestinationCidr>192.XX.XX.0/24</DestinationCidr>
</Routes>
</DescribeSagRouteListResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "4D2C2B28-2C90-4D2F-AF44-59355547D70B",
"Routes" : [ {
"RouteProtocol" : "STATIC",
"ConflictCidrs" : [ ],
"NextHop" : "",
"PortName" : "2",
"Cost" : "[0/0]",
"DestinationCidr" : "192.XX.XX.0/24"
}, {
"RouteProtocol" : "STATIC",
"ConflictCidrs" : [ ],
"NextHop" : "",
"PortName" : "4",
"Cost" : "[0/0]",
"DestinationCidr" : "192.XX.XX.0/24"
} ]
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
400 | SAG.InstanceNoFound | The specified SAG instance does not exist. | The error message returned because the specified SAG instance does not exist. |
400 | SAG.SoftwareNotSupport | The specified SAG software edition instance does not support ACL. | The error message returned because the SAG app instance does not support access control lists (ACLs). |
400 | InstanceNotExit | The specified instance does not exist. | The error message returned because the specified instance does not exist. |
400 | ConfigUnsynchronized | The network configuration is not synchronized. | The error message returned because the network configurations are not synchronized. |
403 | SmartAccessGatewayNotOnline | The specified smart access gateway is not online. | The error message returned because the specified SAG device is not connected to Alibaba Cloud and the system failed to process the request. |
403 | FeatureNotSupport | The current edition of the smart access gateway does not support this feature. | The error message returned because the current version of the specified SAG device does not support this feature. |
403 | FeatureNotSupportForActiveSmartAG | The current edition of the active smart access gateway does not support this feature. | The error message returned because the current version of the active SAG device does not support this feature. |
403 | FeatureNotSupportForStandBySmartAG | The current edition of the standby smart access gateway does not support this feature. | The error message returned because the current version of the standby SAG device does not support this feature. |
500 | SmartAccessGatewayInArrears | The specified Smart Access Gateway has expired. | The error message returned because the specified SAG instance has expired. Renew the SAG instance. |
500 | SmartAccessGatewayNotActivated | The specified Smart Access Gateway has not been activated. | The error message returned because the specified SAG instance is not activated. Activate the SAG instance first. |
500 | SmartAccessGatewayOffline | The request cannot be completed. The Smart Access Gateway is offline. | The error message returned because the specified SAG device is not connected to Alibaba Cloud and the system failed to process the request. |
For a list of error codes, visit the Error Center.