Queries 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.

You can call the DescribeRegions operation to query the most recent region list.

SmartAGId String Yes sag-7f3d9b6jwnuqn6****

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
ServiceIP String 42.XX.XX.151

The IP address of the SAG device.

ControllerState String Normal

The control status of the SAG device. Valid values:

  • Normal: normal
  • Abnormal: abnormal
RequestId String B6A991F4-F533-1627-8144-B64E01C5EE85

The ID of the request.

SynStatus String Unsynchronized

Indicates whether the settings of the SAG device are synchronized to Alibaba Cloud. Valid values:

  • Synchronized: synchronized
  • Unsynchronized: unsynchronized
  • Synchronizing: being synchronized
SmartAGType String sag-100wm

The model of the SAG device. Valid values:

  • sag-100wm
  • sag-1000
Version String 2.3.1.1

The version of the SAG device.

VpnState String Abnormal

The VPN connection status of the SAG device. Valid values:

  • Normal: normal
  • Abnormal: abnormal
StartupTime String 2021-06-15 17:33:43

The time when the SAG device was started.

LastConnectedControllerTime String 2021-07-14 00:27:48

The last time when the SAG device was connected to Alibaba Cloud.

ResettableStatus String Enabled

Indicates whether the reset button of the SAG device is enabled. Valid values:

  • Enabled: enabled
  • Disabled: disabled

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeSAGDeviceInfo
&RegionId=cn-shanghai
&SmartAGId=sag-7f3d9b6jwnuqn6****
&SmartAGSn=sag32a30****
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeSAGDeviceInfoResponse>
    <ControllerState>Normal</ControllerState>
    <RequestId>B6A991F4-F533-1627-8144-B64E01C5EE85</RequestId>
    <SynStatus>Unsynchronized</SynStatus>
    <SmartAGType>sag-100wm</SmartAGType>
    <Version>2.3.1.1</Version>
    <VpnState>Abnormal</VpnState>
    <StartupTime>2021-06-15 17:33:43</StartupTime>
    <ResettableStatus>Enabled</ResettableStatus>
</DescribeSAGDeviceInfoResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "ControllerState" : "Normal",
  "RequestId" : "B6A991F4-F533-1627-8144-B64E01C5EE85",
  "SynStatus" : "Unsynchronized",
  "SmartAGType" : "sag-100wm",
  "Version" : "2.3.1.1",
  "VpnState" : "Abnormal",
  "StartupTime" : "2021-06-15 17:33:43",
  "ResettableStatus" : "Enabled"
}

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 between the SAG device and Alibaba Cloud.
400 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.
400 SmartAccessGatewayInArrears The specified Smart Access Gateway has expired. The error message returned because the specified SAG instance has expired. Renew the SAG instance.
400 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.
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.
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.

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