调用DescribeSmartAccessGatewayAttribute查询SAG实例详情信息_智能接入网关(SAG)-阿里云帮助中心

调用DescribeSmartAccessGatewayAttribute接口查询指定智能接入网关实例信息。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

smartag:DescribeSmartAccessGatewayAttribute

get

*SmartAccessGateway

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

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	智能接入网关实例所属的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-shanghai
SmartAGId	string	是	智能接入网关实例 ID。	sag-6z21oj0vjjrx****

返回参数

名称	类型	描述	示例值
	object	返回结果。
UpBandwidth4G	integer	智能接入网关设备 4G 公网最大上行带宽。单位：Mbps。	3
Description	string	智能接入网关实例描述。	testdesc
EndTime	integer	智能接入网关实例到期时间戳。	1628265600000
ResourceGroupId	string	智能接入网关实例所属资源组 ID。	rg-acfm2iu4fnc****
UserCount	integer	智能接入网关实例客户端账号数量。	3
AssociatedCcnName	string	智能接入网关实例绑定的云连接网名称。	testname
MaxBandwidth	string	智能接入网关实例的带宽峰值。单位：Mbps。	50 M
VpnStatus	string	aliVPN 连接状态。 up：aliVPN 连接正常。 down：aliVPN 连接异常。	down
BoxControllerIp	string	智能接入网关主设备的公网 IP。	112.XX.XX.25
UpBandwidthWan	integer	智能接入网关设备 WAN 口最大上行带宽。单位：Mbps。	4
CidrBlock	string	本地网络或客户端要和云上互通的私网网段。	10.0.9.0/24
QosIds	object
QosId	array	智能接入网关实例绑定的 QoS 策略实例信息。
	string	智能接入网关实例绑定的 QoS 策略实例 ID。	qos-yca8p30w1jcrbt****
IRIds	object
IRId	array	智能接入网关实例绑定的智能选路策略实例信息。
	string	智能接入网关实例绑定的智能选路策略实例 ID。	ir-yca8p30w1jcrbt****
Devices	object
Device	array<object>	智能接入网关设备信息列表。
	object	智能接入网关设备信息。
SerialNumber	string	智能接入网关设备序列号。	sage6gsdllbid****"
HaState	string	智能接入网关设备高可用状态。 Active：标识当前设备为主设备。 Standby：标识当前设备为备设备。	Active
SecretKey	string	智能接入网关设备密钥。	+T4nV8xkS4****
DpiSignatureDbVersion	string	智能接入网关设备使用的应用识别数据库版本。	20201117_1_0-0.0.1
SoftwareVersion	string	智能接入网关设备运行的软件版本。	2.3.0.0
DistributeSkStatus	integer	智能接入网关设备密钥激活状态。 1：已激活。 0：未激活。	1
MonitorVersion	string	智能接入网关设备使用的监控版本。	0.1.11.17
HcState	string	智能接入网关设备健康检查状态。 online：设备在线，已经接入阿里云。 offline：设备离线，未接入阿里云。	online
Name	string	智能接入网关实例名称。	testname
OptimizationType	boolean	智能接入网关实例优化重传类型。优化重传类型开启后，默认为 fec。	fec
IpsecStatus	string	ipsecVPN 连接状态。 up：ipsecVPN 连接正常。 down：ipsecVPN 连接异常。	up
RoutingStrategy	string	智能接入网关实例的线下路由同步方式。 static：静态路由。 dynamic：动态路由。	static
AssociatedCcnId	string	智能接入网关实例绑定的云连接网 ID。	ccn-iz26o9zye6lhoo****
FlowLogIds	object
FlowLogId	array	智能接入网关实例绑定的流日志实例信息。
	string	智能接入网关实例绑定的流日志实例 ID。	fl-0vv40lyu2un5qh****
SmartAGId	string	智能接入网关实例 ID。	sag-6z21oj0vjjrx6s****
InstanceType	string	智能接入网关实例类型。 sag-1000：标识当前实例为智能接入网关硬件版实例，且实例绑定的设备类型为 SAG-1000。 sag-10wm：标识当前实例为智能接入网关硬件版实例，且实例绑定的设备类型为 SAG-100WM。 sag-software：标识当前实例为智能接入网关 APP 实例。 sag-vcpe：标识当前实例为智能接入网关 vCPE 实例。	sag-vcpe
ResellerUid	string	经销商账号 ID。	1210123456123456
SecurityLockThreshold	integer	智能接入网关设备离线锁定的时间阈值。单位：秒。	3600
Status	string	智能接入网关实例状态。 Ordered：待发货。 Delivered：已发货。 Received：已激活。 Unconfirmed：待确认。 Active：可用。 Offline：离线。 Arrearage：欠费锁定。	Active
RequestId	string	请求 ID。	F02D092B-A0B7-4BA1-BCA7-014B953C5DC7
CreateTime	integer	智能接入网关实例创建时间戳。	1622617250000
DataPlan	integer	智能接入网关实例的流量套餐。单位：GB。说明目前仅支持每个账号每个月赠送 5 GB 流量。	5
EnableOptimization	boolean	智能接入网关实例是否开启优化重传功能。 true：已开启。 false：未开启。	false
City	string	智能接入网关设备所在城市 ID。	cn-shanghai
ResellerInstanceId	string	经销商实例 ID。	sag-v0fkpk4akfz5******
SerialNumber	string	智能接入网关设备序列号。	sage6gsdllbidl**,sage6nniq3d**
BackupBoxControllerIp	string	智能接入网关备设备的公网 IP。	112.XX.XX.27
TrafficMasterSn	string	当前主要负责传输流量的智能接入网关设备序列号。	sage6nniq3d****
AccessPointId	string	智能接入网关实例接入点 ID。	238
Links	object
Link	array<object>	本地网络接入阿里云的链路信息列表。
	object	本地网络接入阿里云的链路信息。
HealthCheckTargetIp	string	边界路由器 IP 地址。说明在您创建关于专线的健康检查实例时，需指定边界路由器 IP 地址为目标地址。	100.XX.XX.144
EndTime	integer	链路到期时间戳。	1628265600000
Status	string	链路状态。宽带链路状态： Ordered：待发货。 Delivered：已发货。 Offline：离线。 Active：可用。 Arrearage：欠费锁定。专线链路状态： normal：正常。 arrears：欠费。	Active
Type	string	链路类型。 ccn：表示本地网络通过云连接网接入阿里云。 vbr：表示本地网络通过边界路由器的专线接入阿里云。	ccn
Bandwidth	string	链路带宽值。单位：Mbps。	50 M
RelateInstanceRegionId	string	链路相关实例所在的地域 ID。	cn-shanghai
RelateInstanceId	string	链路相关实例 ID。	ccn-iz26o9zye6lho****
InstanceId	string	商品实例 ID。	sag-6z21oj0vjjrx****
CommodityType	string	链路带宽的商品类型： bandwidth：表示智能接入网关和带宽为拆分售卖类型。 smartag：表示智能接入网关和带宽为组合售卖类型。	smartag
AclIds	object
AclId	array	智能接入网关实例绑定的访问控制实例信息。
	string	智能接入网关实例绑定的访问控制实例 ID。	acl-9p14e8y1red6kv****
ApplicationBandwidthPackageId	string	智能接入网关实例绑定的应用加速带宽包 ID。	abwp-7963l7iqnquyj3****
ApplicationBandwidthPackageName	string	智能接入网关实例绑定的应用加速带宽包名称。	testname
AccelerateBandwidth	integer	智能接入网关实例的应用加速带宽峰值。单位：Mbps。	1
ApplicationBandwidthPackageBussinessStatus	string	应用加速带宽包实例的状态。 Abnormal：异常。 Normal：正常。	Normal
ApplicationBandwidthPackageOperationLocks	object	应用加速带宽包实例锁定信息。
LockType	string	锁定类型。取值：FinancialLocked。	FinancialLocked
LockReason	string	锁定原因。	Message
Position	string	盒子所在位置。	阿里巴巴西溪园区
EnableSoftwareConnectionAudit	boolean	是否开启智能接入网关 App 实例连接日志审计。取值： true：开启智能接入网关 App 实例连接日志审计。 false：关闭智能接入网关 App 实例连接日志审计。	true

示例

正常返回示例

JSON格式

{
  "UpBandwidth4G": 3,
  "Description": "testdesc",
  "EndTime": 1628265600000,
  "ResourceGroupId": "rg-acfm2iu4fnc****",
  "UserCount": 3,
  "AssociatedCcnName": "testname",
  "MaxBandwidth": "50 M",
  "VpnStatus": "down",
  "BoxControllerIp": "112.XX.XX.25",
  "UpBandwidthWan": 4,
  "CidrBlock": "10.0.9.0/24",
  "QosIds": {
    "QosId": [
      "qos-yca8p30w1jcrbt****"
    ]
  },
  "IRIds": {
    "IRId": [
      "ir-yca8p30w1jcrbt****"
    ]
  },
  "Devices": {
    "Device": [
      {
        "SerialNumber": "sage6gsdllbid****\"",
        "HaState": "Active",
        "SecretKey": "+T4nV8xkS4****",
        "DpiSignatureDbVersion": "20201117_1_0-0.0.1",
        "SoftwareVersion": "2.3.0.0",
        "DistributeSkStatus": 1,
        "MonitorVersion": "0.1.11.17",
        "HcState": "online"
      }
    ]
  },
  "Name": "testname",
  "OptimizationType": true,
  "IpsecStatus": "up",
  "RoutingStrategy": "static",
  "AssociatedCcnId": "ccn-iz26o9zye6lhoo****",
  "FlowLogIds": {
    "FlowLogId": [
      "fl-0vv40lyu2un5qh****"
    ]
  },
  "SmartAGId": "sag-6z21oj0vjjrx6s****",
  "InstanceType": "sag-vcpe",
  "ResellerUid": "1210123456123456",
  "SecurityLockThreshold": 3600,
  "Status": "Active",
  "RequestId": "F02D092B-A0B7-4BA1-BCA7-014B953C5DC7",
  "CreateTime": 1622617250000,
  "DataPlan": 5,
  "EnableOptimization": false,
  "City": "cn-shanghai",
  "ResellerInstanceId": "sag-v0fkpk4akfz5******",
  "SerialNumber": "sage6gsdllbidl****,sage6nniq3d****",
  "BackupBoxControllerIp": "112.XX.XX.27",
  "TrafficMasterSn": "sage6nniq3d****",
  "AccessPointId": "238",
  "Links": {
    "Link": [
      {
        "HealthCheckTargetIp": "100.XX.XX.144",
        "EndTime": 1628265600000,
        "Status": "Active",
        "Type": "ccn",
        "Bandwidth": "50 M",
        "RelateInstanceRegionId": "cn-shanghai",
        "RelateInstanceId": "ccn-iz26o9zye6lho****",
        "InstanceId": "sag-6z21oj0vjjrx****",
        "CommodityType": "smartag"
      }
    ]
  },
  "AclIds": {
    "AclId": [
      "acl-9p14e8y1red6kv****"
    ]
  },
  "ApplicationBandwidthPackageId": "abwp-7963l7iqnquyj3****",
  "ApplicationBandwidthPackageName": "testname",
  "AccelerateBandwidth": 1,
  "ApplicationBandwidthPackageBussinessStatus": "Normal",
  "ApplicationBandwidthPackageOperationLocks": {
    "LockType": "FinancialLocked",
    "LockReason": "Message"
  },
  "Position": "阿里巴巴西溪园区",
  "EnableSoftwareConnectionAudit": true
}

错误码

HTTP status code	错误码	错误信息	描述
400	SAG.InstanceNoFound	The specified SAG instance does not exist.	智能接入网关实例不存在。

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

变更历史

更多信息，参考变更详情。