The following tables list API operations available for use in Smart Access Gateway (SAG).
SAG instance and device management
| API | Description |
|---|---|
| ModifySmartAccessGateway | Modifies the parameters of an SAG instance. |
| DescribeSmartAccessGateways | Queries SAG instances that you have created. |
| BindSmartAccessGateway | Associates an SAG instance with a Cloud Connect Network (CCN) instance. |
| UnbindSmartAccessGateway | Disassociates an SAG instance from the associated CCN instance. |
| DescribeSmartAccessGatewayVersions | Queries the version of an SAG instance. |
| GetSmartAccessGatewayUseLimit | Queries the number of SAG instances that you can purchase. |
| UpdateSmartAccessGatewayVersion | Upgrades an SAG instance to a later version. |
| DescribeRegions | Queries the most recent list of available regions. |
| CreateSmartAccessGateway | Creates an SAG instance. |
| UpgradeSmartAccessGateway | Upgrades the bandwidth of an SAG instance. |
| DowngradeSmartAccessGateway | Downgrades the bandwidth of an SAG instance. |
| ActivateSmartAccessGateway | Activates an SAG device. |
| DescribeSmartAccessGatewayHa | Queries the high availability (HA) settings of an SAG instance. |
| AddSnatEntry | Adds a source network address translation (SNAT) entry to an SAG instance. |
| DescribeSnatEntries | Queries SNAT entries associated with an SAG instance. |
| DeleteSnatEntry | Deletes a SNAT entry from an SAG instance. |
| AddDnatEntry | Adds a destination network address translation (DNAT) entry to an SAG instance. |
| DescribeDnatEntries | Queries DNAT entries associated with an SAG instance. |
| DeleteDnatEntry | Deletes a DNAT entry from an SAG instance. |
| RebootSmartAccessGateway | Restarts an SAG instance. |
| UnlockSmartAccessGateway | Unlocks an SAG instance. |
| ModifySmartAccessGatewayUpBandwidth | Modifies the parameters of an SAG instance. |
| BindVbr | Associates an SAG instance with a virtual border router (VBR). |
| GrantSagInstanceToCcn | Authorizes an SAG instance to communicate with CCN instances that are under other Alibaba Cloud accounts. |
| DescribeGrantSagRules | Queries rules that authorize an SAG instance to communicate with CCN instances under other Alibaba Cloud accounts. |
| RevokeSagInstanceFromCcn | Disallows an SAG instance to communicate with a CCN instance under another Alibaba Cloud account. |
| ModifySagRemoteAccess | Modifies the IP address used to remotely log on to an SAG instance. |
| UnbindVbr | Disassociates an SAG instance from the associated VBR. |
| ClearSagRouteableAddress | Clears the routable addresses of an SAG instance. |
| DescribeBindableSmartAccessGateways | Queries SAG instances that can be associated with a specific CCN instance. |
| UnbindSerialNumber | Disassociates an SAG device from the associated SAG instance. |
| SynchronizeSmartAGWebConfig | Synchronizes the settings of an SAG device to the associated SAG instance. |
| ModifySagHa | Modifies the HA settings of an SAG instance. |
| ModifySagUserDns | Modifies the DNS servers used by an SAG instance. |
| DescribeSagWan4G | Queries information about the 4G subscriber identity module (SIM) card of an SAG device. |
| ModifySagWifi | Modifies the Wi-Fi settings of an SAG device. |
| DescribeSagHa | Queries the HA settings of an SAG instance. |
| DescribeSagUserDns | Queries the DNS servers used by an SAG instance. |
| DescribeSagCurrentDns | Queries the active DNS server used by an SAG instance. |
| DescribeSagWifi | Queries the Wi-Fi settings of an SAG device. |
| DescribeSAGDeviceInfo | Queries information about an SAG device. |
CCN instance management
| API | Description |
|---|---|
| CreateCloudConnectNetwork | Creates a CCN instance. |
| DescribeCloudConnectNetworks | Queries CCN instances that you have created. |
| ModifyCloudConnectNetwork | Modifies the name and description of a CCN instance. |
| DeleteCloudConnectNetwork | Deletes a CCN instance. |
| GetCloudConnectNetworkUseLimit | Queries the number of CCN instances that can be created under the current account in a specific region. |
| GrantInstanceToCbn | Authorizes a Cloud Enterprise Network (CEN) instance to communicate with a CCN instance. |
| RevokeInstanceFromCbn | Disallows a CEN instance to communicate with a CCN instance. |
| DescribeGrantRules | Queries rules that allow a CEN instance to communicate with a CCN instance. |
ACL management
| API | Description |
|---|---|
| CreateACL | Creates an access control list (ACL). |
| DescribeACLAttribute | Queries multiple ACLs at a time. You can query ACLs by ACL name. In this case, you must set the Name parameter. |
| DescribeACLs | Queries information about ACLs. |
| ModifyACL | Modifies an ACL. |
| DeleteACL | Deletes an ACL. |
| AssociateACL | Associates an ACL with an SAG instance. |
| DisassociateACL | Disassociates an ACL from the associated SAG instance. |
| AddACLRule | Adds a rule to an ACL. |
| DeleteACLRule | Deletes a rule from an ACL. |
| ModifyACLRule | Modifies an ACL rule. |
SAG APP management
| API | Description |
|---|---|
| CreateSmartAccessGatewaySoftware | Creates an SAP APP instance. |
| CreateSmartAccessGatewayClientUser | Creates a client account. |
| DescribeSmartAccessGatewayClientUsers | Queries client accounts added to an SAG APP instance. |
| ResetSmartAccessGatewayClientUserPassword | Resets the password of a client account. |
| DeleteSmartAccessGatewayClientUser | Deletes a client account. |
| ModifySmartAccessGatewayClientUser | Modifies the bandwidth set for a client account. |
| DescribeSagOnlineClientStatistics | Queries the information about clients connected to a specified SAG APP instance. |
| DescribeUserOnlineClientStatistics | Queries the number of clients connected to a specific SAG APP instance. |
| KickOutClients | Disconnects a client from the specified SAG APP instance based on the instance ID and username of the client account. |
| DescribeUserOnlineClients | Queries the connection information about a client account based on the ID of the SAP APP instance and username of the client account. |
| DescribeUserFlowStatistics | Queries data usage of clients accounts added to a specific SAG APP instance. |
| EnableSmartAccessGatewayUser | Enables a client account that has been added to a specific SAG APP instance. |
| DisableSmartAccessGatewayUser | Disables a client account added to a specific SAG APP instance. |
| DowngradeSmartAccessGatewaySoftware | Downgrades the bandwidth of an SAG APP instance. |
QoS policy management
| API | Description |
|---|---|
| CreateQos | Creates a quality of service (QoS) policy. |
| ModifyQos | Modifies a QoS policy, for example, its name. |
| DeleteQos | Deletes a QoS policy. |
| DescribeQoses | Queries QoS policies. |
| CreateQosPolicy | Adds a QoS rule that contains 5-tuples to a QoS policy. |
| ModifyQosPolicy | Modifies a QoS rule that contains 5-tuples. |
| DeleteQosPolicy | Deletes a QoS policy that contains 5-tuples. |
| DescribeQosPolicies | Queries QoS rules that contain 5-tuples. |
| CreateQosCar | Queries the traffic throttling policy in a QoS rule. |
| ModifyQosCar | Modifies the traffic throttling policy in a QoS rule. |
| DeleteQosCar | Deletes the traffic throttling policy from a QoS rule. |
| AssociateQos | Applies a QoS policy to an SAG instance. |
| DisassociateQos | Disassociates a QoS policy from the associated SAG instance. |
Flow log management
| API | Description |
|---|---|
| CreateFlowLog | Creates a flow log. |
| ModifyFlowLogAttribute | Modifies the settings of a flow log. |
| DeleteFlowLog | Deletes a flow log. |
| ActiveFlowLog | Enables a flow log. |
| DeactiveFlowLog | Disables a flow log. |
| AssociateFlowLog | Associates a flow log with an SAG instance. |
| DisassociateFlowLog | Disassociates a flow log from the associated SAG instance. |
| DescribeFlowLogSags | Queries SAG instances associated with a specific flow log. |
| DescribeUnbindFlowLogSags | Queries SAG instances that are not associated with a flow log. |
| DescribeFlowLogs | Queries flow logs. |
Route management
| API | Description |
|---|---|
| ModifySagGlobalRouteProtocol | Changes the routing protocol of an SAG instance. |
| ModifySagRouteProtocolBgp | Modifies the Border Gateway Protocol (BGP) settings of an SAG device. |
| ModifySagRouteProtocolOspf | Modifies the Open Shortest Path First (OSPF) settings of an SAG instance. |
| CreateSagStaticRoute | Adds a static route to an SAG instance. |
| ModifySagStaticRoute | Modifies a static route. |
| DeleteSagStaticRoute | Deletes a static route from an SAG instance. |
| ModifySagPortRouteProtocol | Changes the routing protocol of a port. |
| DescribeSagRouteProtocolBgp | Queries the BGP settings of an SAG instance. |
| DescribeSagGlobalRouteProtocol | Queries the routing protocol of an SAG instance. |
| DescribeSagStaticRouteList | Queries the list of static routes of an SAG instance. |
| DescribeSagRouteProtocolOspf | Queries the OSPF settings of an SAG instance. |
| DescribeSagRouteList | Queries the current route list of an SAG instance. |
| DescribeSagPortRouteProtocolList | Queries the ports that have the specified routing protocol enabled. |
Port management
| API | Description |
|---|---|
| ModifySagPortRole | Modifies the role of a port. |
| ModifySagManagementPort | Modifies the settings of an SAG device port. |
| ModifySagWan | Modifies the WAN port settings of an SAG device. |
| CreateSagExpressConnectInterface | Creates a sub-interface for a leased line port. |
| ModifySagExpressConnectInterface | Modifies the sub-interface settings of a leased line port. |
| DeleteSagExpressConnectInterface | Deletes a sub-interface from a leased line port. |
| DescribeSagExpressConnectInterfaceList | Queries sub-interfaces added to a leased line port. |
| DescribeSagManagementPort | Queries the management port settings of an SAG device. |
| DescribeSagWanList | Queries the WAN port settings of an SAG device. |
| DescribeSagWanSnat | Queries the SNAT settings of the WAN port of an SAG device. |
| DescribeSagPortList | Queries information about the physical ports of an SAG device. |
| ModifySagWanSnat | Modifies the SNAT settings of the WAN port of an SAG device. |
| ModifySagLan | Modifies the LAN port settings of an SAG device. |
| DescribeSagLanList | Queries the LAN port settings of an SAG device. |
Health check management
| API | Description |
|---|---|
| ModifyHealthCheck | Modifies health check settings. |
| CreateHealthCheck | Creates a health check instance for an SAG instance. |
| DescribeHealthChecks | Queries health check instances associated with an SAG instance. |
| DeleteHealthCheck | Deletes a health check instance. |
| DescribeHealthCheckAttribute | Queries the detailed information about a health check instance. |
Route advertisement policy management
| API | Description |
|---|---|
| DescribeRouteDistributionStrategies | Queries route advertisement policies. |
| ModifyRouteDistributionStrategy | Modifies a route advertisement policy. |
| DeleteRouteDistributionStrategy | Deletes a route advertisement policy. |