调用DescribeSAGDeviceInfo接口查询智能接入网关设备信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeSAGDeviceInfo

要执行的操作。取值:DescribeSAGDeviceInfo

RegionId String cn-shanghai

智能接入网关实例所属地域ID。

您可以通过调用DescribeRegions接口获取地域ID。

SmartAGId String sag-7f3d9b6jwnuqn6****

智能接入网关实例ID。

SmartAGSn String sag32a30****

绑定的智能接入网关设备序列号。

返回数据

名称 类型 示例值 描述
ServiceIP String 42.XX.XX.151

智能接入网关设备的业务IP地址。

ControllerState String Normal

智能接入网关设备的管控状态:

  • Normal:正常。
  • Abnormal:异常。
RequestId String B6A991F4-F533-1627-8144-B64E01C5EE85

请求ID。

SynStatus String Unsynchronized

智能接入网关设备本地和云上的同步状态:

  • Synchronized:同步完成。
  • Unsynchronized:未同步。
  • Synchronizing:正在同步。
SmartAGType String sag-100wm

智能接入网关设备类型:

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

智能接入网关设备运行的软件版本号。

VpnState String Abnormal

智能接入网关设备的VPN连接状态:

  • Normal:正常。
  • Abnormal:异常。
StartupTime String 2021-06-15 17:33:43

智能接入网关设备的启动时间。

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

智能接入网关设备最近一次连接管控的时间。

ResettableStatus String Enabled

智能接入网关设备的重置键是否启用。

  • Enabled:已启用。
  • Disabled:未启用。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeSAGDeviceInfo
&RegionId=cn-shanghai
&SmartAGId=sag-7f3d9b6jwnuqn6****
&SmartAGSn=sag32a30****
&公共请求参数

正常返回示例

XML格式

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格式

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"
}

错误码

HttpCode 错误码 错误信息 描述
400 SAG.InstanceNoFound The specified SAG instance does not exist. 智能接入网关实例不存在。
400 SAG.SoftwareNotSupport The specified SAG software edition instance does not support ACL. 智能接入网关软件版实例不支持ACL。
400 InstanceNotExit The specified instance does not exist. 指定的实例不存在。
400 ConfigUnsynchronized The network configuration is not synchronized. 网络配置未同步。
400 SmartAccessGatewayNotActivated The specified Smart Access Gateway has not been activated. 该智能接入网关尚未激活,请先激活该实例。
400 SmartAccessGatewayInArrears The specified Smart Access Gateway has expired. 该智能接入网关已经到期停服,请续费。
400 SmartAccessGatewayOffline The request cannot be completed. The Smart Access Gateway is offline. 智能接入网关离线,请求无法完成。
403 FeatureNotSupport The current edition of the smart access gateway does not support this feature. 智能接入网关当前版本不支持该功能特性。
403 FeatureNotSupportForActiveSmartAG The current edition of the active smart access gateway does not support this feature. 主智能接入网关的当前版本不支持该功能特性。
403 FeatureNotSupportForStandBySmartAG The current edition of the standby smart access gateway does not support this feature. 备智能接入网关的当前版本不支持该功能特性。
403 SmartAccessGatewayNotOnline The specified smart access gateway is not online. 该智能接入网关当前不是在线状态,无法完成操作。

访问错误中心查看更多错误码。