You can call this operation to query the current route list.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | No | 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 Smart Access Gateway (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 |
The route list. |
|
ConflictCidrs | List | 192.XX.XX.0/24 |
The list of CIDR blocks that overlap with each other. |
Cost | String | [110/11] |
The routing cost. The first number represents the administrative distance (AD). The second number represents the router metric. |
DestinationCidr | String | 6.XX.XX.6/32 |
The destination CIDR block. |
NextHop | String | 192.XX.XX.1 |
The next hop. |
PortName | String | 2 |
The name of the port. If the port name is -1, data is transferred through a VPN tunnel to Alibaba Cloud. |
RouteProtocol | String | STATIC |
The routing protocol type. 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
<DescribeSagRouteListResponse>
<RequestId>4D2C2B28-2C90-4D2F-AF44-59355547D70B</RequestId>
<Routes>
<RouteProtocol>STATIC</RouteProtocol>
<NextHop></NextHop>
<PortName>2</PortName>
<Cost>[0/0]</Cost>
<DestinationCidr>192.XX.XX.0/24</DestinationCidr>
</Routes>
<Routes>
<RouteProtocol>STATIC</RouteProtocol>
<NextHop></NextHop>
<PortName>4</PortName>
<Cost>[0/0]</Cost>
<DestinationCidr>192.XX.XX.0/24</DestinationCidr>
</Routes>
</DescribeSagRouteListResponse>
JSON
format
{
"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 specified SAG instance does not exist. |
400 | SAG.SoftwareNotSupport | The specified SAG software edition instance does not support ACL. | The SAG APP instance does not support access control lists (ACLs). |
500 | SmartAccessGatewayInArrears | The specified Smart Access Gateway has expired. | The specified SAG instance has expired and stops running. Renew the SAG instance. |
500 | SmartAccessGatewayNotActivated | The specified Smart Access Gateway has not been activated. | The specified SAG instance is not activated. Activate the SAG instance. |
403 | SmartAccessGatewayNotOnline | The specified smart access gateway is not online. | The system failed to process the request because the specified SAG device is not connected to Alibaba Cloud. |
500 | SmartAccessGatewayOffline | The request cannot be completed. The Smart Access Gateway is offline. | The system failed to process the request because the specified SAG device is not connected to Alibaba Cloud. |
400 | InstanceNotExit | The specified instance does not exist. | The specified SAG instance does not exist. |
400 | ConfigUnsynchronized | The network configuration is not synchronized. | The network configurations are not synchronized. |
403 | FeatureNotSupport | The current edition of the smart access gateway does not support this feature. | The current version of the SAG device does not support this feature. |
403 | FeatureNotSupportForActiveSmartAG | The current edition of the active smart access gateway does not support this feature. | 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 current version of the standby SAG device does not support this feature. |
For a list of error codes, visit the API Error Center.