DescribeSmartAccessGateways - 查询已创建的智能接入网关实例 - 智能接入网关

查询已创建的智能接入网关。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
smartag:DescribeSmartAccessGateways	Read	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	智能接入网关实例所属地域的 ID。	cn-shanghai
AssociatedCcnId	string	否	智能接入网关实例绑定的云连接网实例 ID。	ccn-bxuau4ezctt****
SmartAGId	string	否	智能接入网关实例 ID。	sag-6z21oj0vjjrx6s****
Status	string	否	智能接入网关实例的状态。取值： Ordered：已下单。 Delivered：已发货。 Received：已收货。 Returning：退货中。 Active：活跃。 Init：初始化。 Offline：离线。	Active
Name	string	否	智能接入网关实例的名称。名称长度为 2~128 个字符，以大小写字母或中文开头，可包含数字、下划线（_）和短划线（-）。	nametest
PageSize	integer	否	分页查询时每页显示的条目数。默认值：10。取值范围：1~50。	10
PageNumber	integer	否	查询页码。默认值：1。	1
SerialNumber	string	否	智能接入网关设备的序列号。	sag32a3****
AclIds	string	否	智能接入网关实例绑定的访问控制实例 ID。	acl-xhwhyuo43l0n****
UnboundAclIds	string	否	访问控制实例 ID。本参数表示查询未绑定该访问控制实例 ID 的智能接入网关实例信息。多个访问控制实例 ID 以半角逗号（,）隔开。	acl-sjfbgngj****
InstanceType	string	否	智能接入网关实例类型。取值： software：智能接入网关 App 版实例。 hardware：智能接入网关硬件版实例。	hardware
CanAssociateQos	boolean	否	可否关联 QoS 策略实例。取值： true：可以。 false：不可以。本参数表示查询可否关联 QoS 策略实例的智能接入网关实例的信息。	false
HardwareType	string	否	智能接入网关设备硬件规格。取值： sag-1000。 sag-100wm。	sag-100wm
SoftwareVersion	string	否	智能接入网关设备运行的软件版本。	2.3.0.0
VersionComparator	string	否	版本过滤符。取值： greater：大于当前版本。 less：小于当前版本。 equals：等于当前版本。	equals
BusinessState	string	否	智能接入网关实例的业务状态。取值： Normal：正常。 Arrearage：欠费锁定。	Normal
ResourceGroupId	string	否	智能接入网关实例所属的资源组 ID。	rg-acfm2iu4fnc****
SmartAGIds	array	否	智能接入网关实例 ID 列表。
	string	否	智能接入网关实例 ID。	sag-6z21oj0vjjrx6s****
AssociatedCcnName	string	否	绑定的云连接网实例的名称。名称长度为 2~100 个字符，以大小写字母或中文开头，可包含数字、下划线（_）、半角句号（.）和短划线（-）。	ccn

返回参数

名称	类型	描述	示例值
	object	返回结果。
TotalCount	integer	列表条目数。	1
PageSize	integer	分页查询时每页包含的条目数。	10
RequestId	string	请求 ID。	ADE68CEE-8E4F-4D0B-9EE9-2C2FFAABF41F
PageNumber	integer	列表的页码。	1
SmartAccessGateways	object []	智能接入网关实例信息列表。
SerialNumber	string	智能接入网关设备的序列号。	sage6gsdllbid**,sage6nniq3dqa**
Status	string	智能接入网关实例的状态。 Ordered：已下单。 Delivered：已发货。 Received：已收货。 Returning：退货中。 Active：活跃。 Init：初始化。 Offline：离线。	Active
UpBandwidth4G	integer	智能接入网关设备 4G 公网最大上行带宽。单位：Mbps。	3
BackupStatus	string	智能接入网关的备份状态。取值： closed：未开启。 opened：已开启。 opening：开启中。	Active
IdaasApplicationId	string	智能接入网关实例关联的 IDaaS 应用 ID。	idaas-cn-hangzhou-l7j0wf0crzea****
SoftwareVersion	string	智能接入网关主设备运行的软件版本。	2.3.0.0
CreateTime	long	智能接入网关实例的创建时间戳。单位：毫秒。时间戳的格式采用 Unix 时间戳，表示从格林威治时间 1970 年 01 月 01 日 00 时 00 分 00 秒至创建智能接入网关实例时的总时长。	1622617250000
SmartAGId	string	智能接入网关实例 ID。	sag-6z21oj0vjjrx6s****
UpBandwidthWan	integer	智能接入网关设备 WAN 口最大上行带宽。单位：Mbps。	2
City	string	智能接入网关设备所在城市 ID。	cn-shanghai
AclIds	string	智能接入网关实例绑定的访问控制实例 ID。	acl-shfhfhhfbnvkdg****
QosIds	string	智能接入网关实例绑定的 QoS 策略实例 ID。	qos-djh****
IRIds	string	智能接入网关实例关联的智能选路 ID 列表	ir-7unf5nom01ygrg****
CidrBlock	string	本地网络或客户端要与云上通信的私网网段。	10.0.9.0/24
Description	string	智能接入网关实例的描述信息。	docdesc
IpsecStatus	string	ipsecVPN 连接状态。 up：ipsecVPN 连接正常。 down：ipsecVPN 连接异常。	up
EnterpriseCode	string	智能接入网关实例绑定的企业码 ID。	12P****
DpiStatus	string	智能接入网关实例 DPI 功能开启状态。 On：已开启。 Off：未开启。	Off
AssociatedCcnId	string	智能接入网关实例绑定的云连接网实例 ID。	ccn-iz26o9zye6lhoo****
Name	string	智能接入网关实例的名称。	testname
HardwareVersion	string	智能接入网关实例类型。 sag-1000：标识当前实例为智能接入网关硬件版实例，且实例绑定的设备类型为 SAG-1000。 sag-100wm：标识当前实例为智能接入网关硬件版实例，且实例绑定的设备类型为 SAG-100WM。 sag-software：标识当前实例为智能接入网关 APP 实例。 sag-vcpe：标识当前实例为智能接入网关 vCPE 实例。	sag-100wm
IdaasId	string	智能接入网关实例绑定的 IDaaS 实例 ID。	idaas-cn-hangzhou-1ahixtl****
DataPlan	long	智能接入网关实例的流量套餐。单位：GB。说明目前仅支持每个账号每个月赠送 5 GB 流量。	5
AssociatedCcnName	string	智能接入网关实例绑定的云连接网实例名称。	ccn
ResellerUid	string	经销商的阿里云账号 ID。	25346073170691****
DpiMonitorStatus	string	智能接入网关实例 DPI 监控功能开启状态。 Active：已开启。 Inactive：未开启。	Inactive
MaxBandwidth	string	智能接入网关实例的带宽峰值。单位：Mbps。	50M
SmartAGUid	long	智能接入网关实例的所属的账号 ID。	1210123456123456
BackupSoftwareVersion	string	智能接入网关备设备运行的软件版本。	2.3.0.0
EndTime	long	智能接入网关实例的到期时间戳。单位：毫秒。时间戳的格式采用 Unix 时间戳，表示从格林威治时间 1970 年 01 月 01 日 00 时 00 分 00 秒至智能接入网关实例到期时的总时长。	1628265600000
ResellerInstanceId	string	经销商智能接入网关实例 ID。	sag-v0fkpk4akfz5****
VpnStatus	string	aliVPN 连接状态。 up：aliVPN 连接正常。 down：aliVPN 连接异常。	down
RoutingStrategy	string	智能接入网关实例的线下路由同步方式。 static：静态路由。 dynamic：动态路由。	static
SecurityLockThreshold	integer	智能接入网关设备离线锁定的时间阈值。单位：秒。	3600
Links	object []	本地网络接入阿里云的链路信息列表。
Type	string	链路类型。 ccn：表示本地网络通过云连接网接入阿里云。 vbr：表示本地网络通过边界路由器及物理专线接入阿里云。	ccn
Status	string	链路状态。宽带链路状态： Ordered：待发货。 Delivered：已发货。 Offline：离线。 Active：可用。 Arrearage：欠费锁定。物理专线链路状态： normal：正常。 arrears：欠费。	Active
EndTime	long	链路到期时间戳。单位：毫秒。时间戳的格式采用 Unix 时间戳，表示从格林威治时间 1970 年 01 月 01 日 00 时 00 分 00 秒至链路到期时的总时长。	1628265600000
Bandwidth	string	链路带宽值。单位：Mbps。	50M
RelateInstanceRegionId	string	链路相关实例所在的地域 ID。	cn-shanghai
RelateInstanceId	string	链路相关实例 ID。	ccn-iz26o9zye6lhoo****
InstanceId	string	商品实例 ID。	sag-6z21oj0vjjrx6s****
CommodityType	string	链路带宽的商品类型。 bandwidth：表示智能接入网关和带宽为拆分售卖类型。 smartag：表示智能接入网关和带宽为组合售卖类型。	smartag
ResourceGroupId	string	智能接入网关实例所属资源组 ID。	rg-acfm2iu4fnc****
UserCount	integer	智能接入网关实例客户端账号数量。	3
AccessPointId	string	智能接入网关实例接入点 ID。	238
ApplicationBandwidthPackageId	string	智能接入网关实例绑定的应用加速带宽包 ID。	abwp-7963l7iqnquyj3****
AccelerateBandwidth	long	智能接入网关实例的应用加速带宽峰值。单位：Mbps。	1
EnableSoftwareConnectionAudit	boolean	是否已开启 SAG App 连接日志审计。取值： true：已开启 SAG App 连接日志审计。 false：未开启 SAG App 连接日志审计。	true
Position	string	智能接入网关实例位置信息。	[{\"adcode\":\"\",\"label\":\"山东省青岛市即墨区\",\"value\":\"B02140800T\",\"center\":\"120.989576,36.487512\",\"_new\":\"true\"}]
Isp	string	智能接入网关实例使用的运营商名字。	电信
EnableAdvancedMonitor	boolean	智能接入网关实例是否已开启深度监控。取值： true：已开启。 false：未开启。	true

示例

正常返回示例

JSON格式

{
  "TotalCount": 1,
  "PageSize": 10,
  "RequestId": "ADE68CEE-8E4F-4D0B-9EE9-2C2FFAABF41F",
  "PageNumber": 1,
  "SmartAccessGateways": {
    "SmartAccessGateway": [
      {
        "SerialNumber": "sage6gsdllbid****,sage6nniq3dqa****",
        "Status": "Active",
        "UpBandwidth4G": 3,
        "BackupStatus": "Active",
        "IdaasApplicationId": "idaas-cn-hangzhou-l7j0wf0crzea****",
        "SoftwareVersion": "2.3.0.0",
        "CreateTime": 1622617250000,
        "SmartAGId": "sag-6z21oj0vjjrx6s****",
        "UpBandwidthWan": 2,
        "City": "cn-shanghai",
        "AclIds": "acl-shfhfhhfbnvkdg****",
        "QosIds": "qos-djh****",
        "IRIds": "ir-7unf5nom01ygrg****",
        "CidrBlock": "10.0.9.0/24",
        "Description": "docdesc",
        "IpsecStatus": "up",
        "EnterpriseCode": "12P****",
        "DpiStatus": "Off",
        "AssociatedCcnId": "ccn-iz26o9zye6lhoo****",
        "Name": "testname",
        "HardwareVersion": "sag-100wm",
        "IdaasId": "idaas-cn-hangzhou-1ahixtl****",
        "DataPlan": 5,
        "AssociatedCcnName": "ccn",
        "ResellerUid": "25346073170691****",
        "DpiMonitorStatus": "Inactive",
        "MaxBandwidth": "50M",
        "SmartAGUid": 1210123456123456,
        "BackupSoftwareVersion": "2.3.0.0",
        "EndTime": 1628265600000,
        "ResellerInstanceId": "sag-v0fkpk4akfz5****",
        "VpnStatus": "down",
        "RoutingStrategy": "static",
        "SecurityLockThreshold": 3600,
        "Links": {
          "Link": [
            {
              "Type": "ccn",
              "Status": "Active",
              "EndTime": 1628265600000,
              "Bandwidth": "50M",
              "RelateInstanceRegionId": "cn-shanghai",
              "RelateInstanceId": "ccn-iz26o9zye6lhoo****",
              "InstanceId": "sag-6z21oj0vjjrx6s****",
              "CommodityType": "smartag"
            }
          ]
        },
        "ResourceGroupId": "rg-acfm2iu4fnc****",
        "UserCount": 3,
        "AccessPointId": "238",
        "ApplicationBandwidthPackageId": "abwp-7963l7iqnquyj3****",
        "AccelerateBandwidth": 1,
        "EnableSoftwareConnectionAudit": true,
        "Position": "[{\\\"adcode\\\":\\\"\\\",\\\"label\\\":\\\"山东省青岛市即墨区\\\",\\\"value\\\":\\\"B02140800T\\\",\\\"center\\\":\\\"120.989576,36.487512\\\",\\\"_new\\\":\\\"true\\\"}]",
        "Isp": "电信",
        "EnableAdvancedMonitor": true
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	Param.InvalidVersionComparator	The specified version comparison operator is invalid.	非法的版本比较操作值。
400	InvalidRegionID	The specified regionId does not exist.	指定的RegionId不存在。
403	Forbidden	User not authorized to operate on the specified resource.	用户没有操作此资源的权限。

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