All Products
Search
Document Center

Smart Access Gateway:DescribeSagRouteList

Last Updated:Mar 03, 2024

Queries the routes of a Smart Access Gateway (SAG) instance.

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
smartag:DescribeSagRouteListRead
  • SmartAccessGateway
    acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the SAG instance.

cn-shanghai
SmartAGIdstringYes

The serial number of the SAG device associated with the SAG instance.

sag-whfn****
SmartAGSnstringYes

The ID of the request.

sag32a30****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The routes.

CE6642D4-21EB-4168-9BF9-F217953F9892
Routesobject []

The next hop.

NextHopstring

The destination CIDR block.

192.XX.XX.1
DestinationCidrstring

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.

6.XX.XX.6/32
Coststring

The name of the port. If the port name is -1, data is transferred through a VPN tunnel to Alibaba Cloud.

[110/11]
PortNamestring

The routing protocol. Valid values:

  • STATIC: a static routing protocol.
  • OSPF: the Open Shortest Path First (OSPF) dynamic routing protocol.
  • BGP: the Border Gateway Protocol (BGP) dynamic routing protocol.
2
RouteProtocolstring

The list of CIDR blocks that overlap with each other.

STATIC

Examples

Sample success responses

JSONformat

{
  "RequestId": "CE6642D4-21EB-4168-9BF9-F217953F9892",
  "Routes": [
    {
      "NextHop": "192.XX.XX.1",
      "DestinationCidr": "6.XX.XX.6/32",
      "Cost": "[110/11]",
      "PortName": "2",
      "RouteProtocol": "STATIC",
      "ConflictCidrs": [
        "192.XX.XX.0/24"
      ]
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400SAG.InstanceNoFoundThe specified SAG instance does not exist.The specified SAG instance does not exist.
400SAG.SoftwareNotSupportThe specified SAG software edition instance does not support ACL.The specified SAG software edition instance does not support ACL.
400InstanceNotExitThe specified instance does not exist.The specified instance does not exist.
400ConfigUnsynchronizedThe network configuration is not synchronized.Network settings are not synchronized.
403SmartAccessGatewayNotOnlineThe specified smart access gateway is not online.The specified SAG device is disconnected. The operation cannot be processed.
403FeatureNotSupportThe current edition of the smart access gateway does not support this feature.The current version of Smart Access Gateway does not support this feature.
403FeatureNotSupportForActiveSmartAGThe current edition of the active smart access gateway does not support this feature.The current edition of the active SAG instance does not support this feature.
403FeatureNotSupportForStandBySmartAGThe current edition of the standby smart access gateway does not support this feature.The current version of Smart Access Gateway does not support this feature.
500SmartAccessGatewayInArrearsThe specified Smart Access Gateway has expired.The specified Smart Access Gateway has expired.
500SmartAccessGatewayNotActivatedThe specified Smart Access Gateway has not been activated.The specified SAG instance is inactive. You must activate the instance first.
500SmartAccessGatewayOfflineThe request cannot be completed. The Smart Access Gateway is offline.The SAG device is disconnected. The request cannot be processed.

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