文档

DescribeSAGDeviceInfo - 获取设备概况

更新时间:

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
smartag:DescribeSAGDeviceInfoRead
  • SmartAccessGateway
    acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}

请求参数

名称类型必填描述示例值
RegionIdstring

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

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

cn-shanghai
SmartAGIdstring

智能接入网关实例 ID。

sag-7f3d9b6jwnuqn6****
SmartAGSnstring

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

sag32a30****

返回参数

名称类型描述示例值
object

返回结果。

ServiceIPstring

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

42.XX.XX.151
ControllerStatestring

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

  • Normal:正常。
  • Abnormal:异常。
Normal
RequestIdstring

请求 ID。

B6A991F4-F533-1627-8144-B64E01C5EE85
SynStatusstring

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

  • Synchronized:同步完成。
  • Unsynchronized:未同步。
  • Synchronizing:正在同步。
Unsynchronized
SmartAGTypestring

智能接入网关设备类型:

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

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

2.3.1.1
VpnStatestring

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

  • Normal:正常。
  • Abnormal:异常。
Abnormal
StartupTimestring

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

2021-06-15 17:33:43
LastConnectedControllerTimestring

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

2021-07-14 00:27:48
ResettableStatusstring

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

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

示例

正常返回示例

JSON格式

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

错误码

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

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈