All Products
Search

This Product

    Smart Access Gateway:DescribeSAGDeviceInfo

    Document Center

    Smart Access Gateway:DescribeSAGDeviceInfo

    Last Updated:Jun 17, 2026

    Queries information about a Smart Access Gateway device by calling the DescribeSAGDeviceInfo operation.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    smartag:DescribeSAGDeviceInfo

    get

    *SmartAccessGateway

    acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    The ID of the region where the Smart Access Gateway instance is deployed.

    You can call the DescribeRegions operation to query region IDs.

    cn-shanghai
    SmartAGId

    string

    Yes

    The instance ID of the Smart Access Gateway.

    sag-7f3d9b6jwnuqn6****
    SmartAGSn

    string

    Yes

    The serial number of the associated Smart Access Gateway device.

    sag32a30****

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    ServiceIP

    string

    The service IP address of the Smart Access Gateway device.

    42.XX.XX.151
    ControllerState

    string

    The control status of the Smart Access Gateway device. Valid values:

    • Normal: Normal.

    • Abnormal: Abnormal.

    Normal
    RequestId

    string

    The request ID.

    B6A991F4-F533-1627-8144-B64E01C5EE85
    SynStatus

    string

    The synchronization status between the local Smart Access Gateway device and the cloud. Valid values:

    • Synchronized: Synchronization is complete.

    • Unsynchronized: Not synchronized.

    • Synchronizing: Synchronization is in progress.

    Unsynchronized
    SmartAGType

    string

    The type of the Smart Access Gateway device. Valid values:

    • sag-100wm.

    • sag-1000.

    sag-100wm
    Version

    string

    The software version that runs on the Smart Access Gateway device.

    2.3.1.1
    VpnState

    string

    The VPN connection status of the Smart Access Gateway device. Valid values:

    • Normal: Normal.

    • Abnormal: Abnormal.

    Abnormal
    StartupTime

    string

    The startup time of the Smart Access Gateway device.

    2021-06-15 17:33:43
    LastConnectedControllerTime

    string

    The most recent time when the Smart Access Gateway device connected to the controller.

    2021-07-14 00:27:48
    ResettableStatus

    string

    Indicates whether the reset button of the Smart Access Gateway device is enabled. Valid values:

    • Enabled: Enabled.

    • Disabled: Disabled.

    Enabled

    Examples

    Success response

    JSON format

    {
  "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 code

    Error code

    Error message

    Description
    400 SAG.InstanceNoFound The specified SAG instance does not exist. The specified SAG instance does not exist.
    400 SAG.SoftwareNotSupport The specified SAG software edition instance does not support ACL. The specified SAG software edition instance does not support ACL.
    400 InstanceNotExit The specified instance does not exist. The specified instance does not exist.
    400 ConfigUnsynchronized The network configuration is not synchronized. Network settings are not synchronized.
    400 SmartAccessGatewayNotActivated The specified Smart Access Gateway has not been activated. The specified SAG instance is inactive. You must activate the instance first.
    400 SmartAccessGatewayInArrears The specified Smart Access Gateway has expired. The specified Smart Access Gateway has expired.
    400 SmartAccessGatewayOffline The request cannot be completed. The Smart Access Gateway is offline. The SAG device is disconnected. The request cannot be processed.
    403 FeatureNotSupport The current edition of the smart access gateway does not support this feature. The current version of Smart Access Gateway does not support this feature.
    403 FeatureNotSupportForActiveSmartAG The 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.
    403 FeatureNotSupportForStandBySmartAG The 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.
    403 SmartAccessGatewayNotOnline The specified smart access gateway is not online. The specified SAG device is disconnected. The operation cannot be processed.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.