You can call this operation to query information about a Smart Access Gateway (SAG) device.

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 No DescribeSAGDeviceInfo

The operation that you want to perform.

Set the value to DescribeSAGDeviceInfo.

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 (SN) of the SAG device.

Response parameters

Parameter Type Example Description
ControllerState String Abnormal

The status of the SAG device. Valid values:

  • Normal: The device works as expected.
  • Abnormal: The device does not work as expected.
RequestId String 419268E8-1D8A-43EC-B9B4-C0906F4C444D

The ID of the request.

SmartAGType String sag-1000

The model of the SAG device. Valid values:

  • SAG-100WM
  • SAG-1000
StartupTime String 2020-04-13 15:21:43

The time when the device was started.

SynStatus String Synchronized

The status of synchronization between the SAG device and instance. Valid values:

  • Synchronized: Settings have been synchronized between the SAG device and instance.
  • Unsynchronized: Settings are not synchronized between the SAG device and instance.
  • Synchronizing: Settings are being synchronized between the SAG device and instance.
Version String 2.0.8

The current version number of the SAG device.

VpnState String Abnormal

The status of the VPN.service Valid values:

  • Normal: works as expected.
  • Abnormal: does not work as expected.

Examples

Sample requests

http(s)://smartag.cn-shanghai.aliyuncs.com/? Action=DescribeSAGDeviceInfo
&RegionId=cn-shanghai
&SmartAGId=sag-whfn****
&SmartAGSn=sag32a30****
&<Common request parameters>

Sample success responses

XML format

<DescribeSAGDeviceInfoResponse>
  <ControllerState>Normal</ControllerState>
  <RequestId>9B6DE689-8E20-4739-9A9F-D46A570F3EB7</RequestId>
  <SynStatus>Synchronized</SynStatus>
  <SmartAGType>sag-1000</SmartAGType>
  <Version>2.0.2</Version>
  <VpnState>Normal</VpnState>
  <StartupTime>2020-04-13 15:21:43</StartupTime>
</DescribeSAGDeviceInfoResponse>

JSON format

{
	"ControllerState": "Normal",
	"RequestId": "9B6DE689-8E20-4739-9A9F-D46A570F3EB7",
	"SynStatus": "Synchronized",
	"SmartAGType": "sag-1000",
	"Version": "2.0.2",
	"VpnState": "Normal",
	"StartupTime": "2020-04-13 15:21:43"
}

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 version of the specified SAG instance does not support ACLs.
500 SmartAccessGatewayNotActivated The specified Smart Access Gateway has not been activated. The error message returned because the specified SAG instance has not been activated. Activate the SAG instance first.
500 SmartAccessGatewayInArrears The specified Smart Access Gateway has expired. The error message returned because the specified SAG instance has expired. Renew the SAG instance first.
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 settings are not synchronized between the SAG device and instance.
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 instance 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.
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.
500 SmartAccessGatewayOffline The request cannot be completed. The Smart Access Gateway is offline. The error message returned because the specified SAG device is disconnected form Alibaba Cloud.

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