All Products
Search
Document Center

Smart Access Gateway:DescribeSAGDeviceInfo

Last Updated:Mar 03, 2024

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.

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

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region where the SAG instance is deployed.

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

cn-shanghai
SmartAGIdstringYes

The ID of the SAG instance.

sag-7f3d9b6jwnuqn6****
SmartAGSnstringYes

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

sag32a30****

Response parameters

ParameterTypeDescriptionExample
object
ServiceIPstring

The IP address of the SAG device.

42.XX.XX.151
ControllerStatestring

The control status of the SAG device. Valid values:

  • Normal: normal
  • Abnormal: abnormal
Normal
RequestIdstring

The ID of the request.

B6A991F4-F533-1627-8144-B64E01C5EE85
SynStatusstring

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

  • Synchronized: synchronized
  • Unsynchronized: unsynchronized
  • Synchronizing: being synchronized
Unsynchronized
SmartAGTypestring

The model of the SAG device. Valid values:

  • sag-100wm
  • sag-1000
sag-100wm
Versionstring

The version of the SAG device.

2.3.1.1
VpnStatestring

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

  • Normal: normal
  • Abnormal: abnormal
Abnormal
StartupTimestring

The time when the SAG device was started.

2021-06-15 17:33:43
LastConnectedControllerTimestring

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

2021-07-14 00:27:48
ResettableStatusstring

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

  • Enabled: enabled
  • Disabled: disabled
Enabled

Examples

Sample success responses

JSONformat

{
  "ServiceIP": "42.XX.XX.151",
  "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",
  "LastConnectedControllerTime": "2021-07-14 00:27:48",
  "ResettableStatus": "Enabled"
}

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.
400SmartAccessGatewayNotActivatedThe specified Smart Access Gateway has not been activated.The specified SAG instance is inactive. You must activate the instance first.
400SmartAccessGatewayInArrearsThe specified Smart Access Gateway has expired.The specified Smart Access Gateway has expired.
400SmartAccessGatewayOfflineThe request cannot be completed. The Smart Access Gateway is offline.The SAG device is disconnected. The request 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.
403SmartAccessGatewayNotOnlineThe specified smart access gateway is not online.The specified SAG device is disconnected. The operation cannot be processed.

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

Change history

Change timeSummary of changesOperation
No change history