调用DescribeSmartAccessGateways接口查询智能接入网关实例的信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
RegionId | String | 否 | cn-shanghai | 智能接入网关实例所属地域的ID。 |
AssociatedCcnId | String | 否 | ccn-bxuau4ezctt**** | 智能接入网关实例绑定的云连接网实例ID。 |
SmartAGId | String | 否 | sag-6z21oj0vjjrx6s**** | 智能接入网关实例ID。 |
Status | String | 否 | Active | 智能接入网关实例的状态。取值:
|
Name | String | 否 | nametest | 智能接入网关实例的名称。 名称长度为2~128个字符,以大小写字母或中文开头,可包含数字、下划线(_)和短划线(-)。 |
PageSize | Integer | 否 | 10 | 分页查询时每页显示的条目数。默认值:10。取值范围:1~50。 |
PageNumber | Integer | 否 | 1 | 查询页码。默认值:1。 |
Action | String | 是 | DescribeSmartAccessGateways | 系统规定参数。取值:DescribeSmartAccessGateways。 |
SerialNumber | String | 否 | sag32a3**** | 智能接入网关设备的序列号。 |
AclIds | String | 否 | acl-xhwhyuo43l0n**** | 智能接入网关实例绑定的访问控制实例ID。 |
UnboundAclIds | String | 否 | acl-sjfbgngj**** | 访问控制实例ID。 本参数表示查询未绑定该访问控制实例ID的智能接入网关实例信息。多个访问控制实例ID以半角逗号(,)隔开。 |
InstanceType | String | 否 | hardware | 智能接入网关实例类型。取值:
|
CanAssociateQos | Boolean | 否 | false | 可否关联QoS策略实例。取值:
本参数表示查询可否关联QoS策略实例的智能接入网关实例的信息。 |
HardwareType | String | 否 | sag-100wm | 智能接入网关设备硬件规格。取值:
|
SoftwareVersion | String | 否 | 2.3.0.0 | 智能接入网关设备运行的软件版本。 |
VersionComparator | String | 否 | equals | 版本过滤符。取值:
|
BusinessState | String | 否 | Normal | 智能接入网关实例的业务状态。取值:
|
ResourceGroupId | String | 否 | rg-acfm2iu4fnc**** | 智能接入网关实例所属的资源组ID。 |
SmartAGIds.N | String | 否 | sag-6z21oj0vjjrx6s**** | 智能接入网关实例ID。 |
AssociatedCcnName | String | 否 | ccn | 绑定的云连接网实例的名称。 名称长度为2~100个字符,以大小写字母或中文开头,可包含数字、下划线(_)、半角句号(.)和短划线(-)。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
TotalCount | Integer | 1 | 列表条目数。 |
PageSize | Integer | 10 | 分页查询时每页包含的条目数。 |
RequestId | String | ADE68CEE-8E4F-4D0B-9EE9-2C2FFAABF41F | 请求ID。 |
PageNumber | Integer | 1 | 列表的页码。 |
SmartAccessGateways | Array of SmartAccessGateway | 智能接入网关实例信息列表。 |
|
SmartAccessGateway | |||
SerialNumber | String | sage6gsdllbid****,sage6nniq3dqa**** | 智能接入网关设备的序列号。 |
Status | String | Active | 智能接入网关实例的状态。
|
UpBandwidth4G | Integer | 3 | 智能接入网关设备4G公网最大上行带宽。单位:Mbps。 |
BackupStatus | String | Active | 智能接入网关的备份状态。 取值:
|
IdaasApplicationId | String | idaas-cn-hangzhou-l7j0wf0crzea**** | 智能接入网关实例关联的IDaaS应用ID。 |
SoftwareVersion | String | 2.3.0.0 | 智能接入网关主设备运行的软件版本。 |
CreateTime | Long | 1622617250000 | 智能接入网关实例的创建时间戳。单位:毫秒。 时间戳的格式采用Unix时间戳,表示从格林威治时间1970年01月01日00时00分00秒至创建智能接入网关实例时的总时长。 |
SmartAGId | String | sag-6z21oj0vjjrx6s**** | 智能接入网关实例ID。 |
UpBandwidthWan | Integer | 2 | 智能接入网关设备WAN口最大上行带宽。单位:Mbps。 |
City | String | cn-shanghai | 智能接入网关设备所在城市ID。 |
AclIds | String | acl-shfhfhhfbnvkdg**** | 智能接入网关实例绑定的访问控制实例ID。 |
QosIds | String | qos-djh**** | 智能接入网关实例绑定的QoS策略实例ID。 |
IRIds | String | ir-7unf5nom01ygrg**** | 智能接入网关实例关联的智能选路ID列表 |
CidrBlock | String | 10.0.9.0/24 | 本地网络或客户端要与云上通信的私网网段。 |
Description | String | docdesc | 智能接入网关实例的描述信息。 |
IpsecStatus | String | up | ipsecVPN连接状态。
|
EnterpriseCode | String | 12P**** | 智能接入网关实例绑定的企业码ID。 |
DpiStatus | String | Off | 智能接入网关实例DPI功能开启状态。
|
AssociatedCcnId | String | ccn-iz26o9zye6lhoo**** | 智能接入网关实例绑定的云连接网实例ID。 |
Name | String | testname | 智能接入网关实例的名称。 |
HardwareVersion | String | sag-100wm | 智能接入网关实例类型。
|
IdaasId | String | idaas-cn-hangzhou-1ahixtl**** | 智能接入网关实例绑定的IDaaS实例ID。 |
DataPlan | Long | 5 | 智能接入网关实例的流量套餐。单位:GB。 说明 目前仅支持每个账号每个月赠送5 GB流量。 |
AssociatedCcnName | String | ccn | 智能接入网关实例绑定的云连接网实例名称。 |
ResellerUid | String | 25346073170691**** | 经销商的阿里云账号ID。 |
DpiMonitorStatus | String | Inactive | 智能接入网关实例DPI监控功能开启状态。
|
MaxBandwidth | String | 50M | 智能接入网关实例的带宽峰值。单位:Mbps。 |
SmartAGUid | Long | 1210123456123456 | 智能接入网关实例的所属的账号ID。 |
BackupSoftwareVersion | String | 2.3.0.0 | 智能接入网关备设备运行的软件版本。 |
EndTime | Long | 1628265600000 | 智能接入网关实例的到期时间戳。单位:毫秒。 时间戳的格式采用Unix时间戳,表示从格林威治时间1970年01月01日00时00分00秒至智能接入网关实例到期时的总时长。 |
ResellerInstanceId | String | sag-v0fkpk4akfz5**** | 经销商智能接入网关实例ID。 |
VpnStatus | String | down | aliVPN连接状态。
|
RoutingStrategy | String | static | 智能接入网关实例的线下路由同步方式。
|
SecurityLockThreshold | Integer | 3600 | 智能接入网关设备离线锁定的时间阈值。 单位:秒。 |
Links | Array of Link | 本地网络接入阿里云的链路信息列表。 |
|
Link | |||
Type | String | ccn | 链路类型。
|
Status | String | Active | 链路状态。 宽带链路状态:
物理专线链路状态:
|
EndTime | Long | 1628265600000 | 链路到期时间戳。单位:毫秒。 时间戳的格式采用Unix时间戳,表示从格林威治时间1970年01月01日00时00分00秒至链路到期时的总时长。 |
Bandwidth | String | 50M | 链路带宽值。单位:Mbps。 |
RelateInstanceRegionId | String | cn-shanghai | 链路相关实例所在的地域ID。 |
RelateInstanceId | String | ccn-iz26o9zye6lhoo**** | 链路相关实例ID。 |
InstanceId | String | sag-6z21oj0vjjrx6s**** | 商品实例ID。 |
CommodityType | String | smartag | 链路带宽的商品类型。
|
ResourceGroupId | String | rg-acfm2iu4fnc**** | 智能接入网关实例所属资源组ID。 |
UserCount | Integer | 3 | 智能接入网关实例客户端账号数量。 |
AccessPointId | String | 238 | 智能接入网关实例接入点ID。 |
ApplicationBandwidthPackageId | String | abwp-7963l7iqnquyj3**** | 智能接入网关实例绑定的应用加速带宽包ID。 |
AccelerateBandwidth | Long | 1 | 智能接入网关实例的应用加速带宽峰值。单位:Mbps。 |
EnableSoftwareConnectionAudit | Boolean | true | 是否已开启SAG App连接日志审计。取值:
|
Position | String | [{\"adcode\":\"\",\"label\":\"山东省青岛市即墨区\",\"value\":\"B02140800T\",\"center\":\"120.989576,36.487512\",\"_new\":\"true\"}] | 智能接入网关实例位置信息。 |
Isp | String | 电信 | 智能接入网关实例使用的运营商名字。 |
EnableAdvancedMonitor | Boolean | true | 智能接入网关实例是否已开启深度监控。取值:
|
示例
请求示例
http(s)://[Endpoint]/?RegionId=cn-shanghai
&AssociatedCcnId=ccn-bxuau4ezctt****
&SmartAGId=sag-6z21oj0vjjrx6s****
&Status=Active
&Name=nametest
&PageSize=10
&PageNumber=1
&Action=DescribeSmartAccessGateways
&SerialNumber=sag32a3****
&AclIds=acl-xhwhyuo43l0n****
&UnboundAclIds=acl-sjfbgngj****
&InstanceType=hardware
&CanAssociateQos=false
&HardwareType=sag-100wm
&SoftwareVersion=2.3.0.0
&VersionComparator=equals
&BusinessState=Normal
&ResourceGroupId=rg-acfm2iu4fnc****
&SmartAGIds=["sag-6z21oj0vjjrx6s****"]
&AssociatedCcnName=ccn
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeSmartAccessGatewaysResponse>
<TotalCount>1</TotalCount>
<PageSize>10</PageSize>
<RequestId>ADE68CEE-8E4F-4D0B-9EE9-2C2FFAABF41F</RequestId>
<PageNumber>1</PageNumber>
<SmartAccessGateways>
<SerialNumber>sage6gsdllbid****,sage6nniq3dqa****</SerialNumber>
<Status>Active</Status>
<UpBandwidth4G>3</UpBandwidth4G>
<BackupStatus>Active</BackupStatus>
<IdaasApplicationId>idaas-cn-hangzhou-l7j0wf0crzea****</IdaasApplicationId>
<SoftwareVersion>2.3.0.0</SoftwareVersion>
<CreateTime>1622617250000</CreateTime>
<SmartAGId>sag-6z21oj0vjjrx6s****</SmartAGId>
<UpBandwidthWan>2</UpBandwidthWan>
<City>cn-shanghai</City>
<AclIds>acl-shfhfhhfbnvkdg****</AclIds>
<QosIds>qos-djh****</QosIds>
<IRIds>ir-7unf5nom01ygrg****</IRIds>
<CidrBlock>10.0.9.0/24</CidrBlock>
<Description>docdesc</Description>
<IpsecStatus>up</IpsecStatus>
<EnterpriseCode>12P****</EnterpriseCode>
<DpiStatus>Off</DpiStatus>
<AssociatedCcnId>ccn-iz26o9zye6lhoo****</AssociatedCcnId>
<Name>testname</Name>
<HardwareVersion>sag-100wm</HardwareVersion>
<IdaasId>idaas-cn-hangzhou-1ahixtl****</IdaasId>
<DataPlan>5</DataPlan>
<AssociatedCcnName>ccn</AssociatedCcnName>
<ResellerUid>25346073170691****</ResellerUid>
<DpiMonitorStatus>Inactive</DpiMonitorStatus>
<MaxBandwidth>50M</MaxBandwidth>
<SmartAGUid>1210123456123456</SmartAGUid>
<BackupSoftwareVersion>2.3.0.0</BackupSoftwareVersion>
<EndTime>1628265600000</EndTime>
<ResellerInstanceId>sag-v0fkpk4akfz5****</ResellerInstanceId>
<VpnStatus>down</VpnStatus>
<RoutingStrategy>static</RoutingStrategy>
<SecurityLockThreshold>3600</SecurityLockThreshold>
<Links>
<Type>ccn</Type>
<Status>Active</Status>
<EndTime>1628265600000</EndTime>
<Bandwidth>50M</Bandwidth>
<RelateInstanceRegionId>cn-shanghai</RelateInstanceRegionId>
<RelateInstanceId>ccn-iz26o9zye6lhoo****</RelateInstanceId>
<InstanceId>sag-6z21oj0vjjrx6s****</InstanceId>
<CommodityType>smartag</CommodityType>
</Links>
<ResourceGroupId>rg-acfm2iu4fnc****</ResourceGroupId>
<UserCount>3</UserCount>
<AccessPointId>238</AccessPointId>
<ApplicationBandwidthPackageId>abwp-7963l7iqnquyj3****</ApplicationBandwidthPackageId>
<AccelerateBandwidth>1</AccelerateBandwidth>
<EnableSoftwareConnectionAudit>true</EnableSoftwareConnectionAudit>
<Position>[{\"adcode\":\"\",\"label\":\"山东省青岛市即墨区\",\"value\":\"B02140800T\",\"center\":\"120.989576,36.487512\",\"_new\":\"true\"}]</Position>
<Isp>电信</Isp>
<EnableAdvancedMonitor>true</EnableAdvancedMonitor>
</SmartAccessGateways>
</DescribeSmartAccessGatewaysResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"TotalCount" : 1,
"PageSize" : 10,
"RequestId" : "ADE68CEE-8E4F-4D0B-9EE9-2C2FFAABF41F",
"PageNumber" : 1,
"SmartAccessGateways" : [ {
"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" : [ {
"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
} ]
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
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. | 用户没有操作此资源的权限。 |
访问错误中心查看更多错误码。