文档

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

更新时间:

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

调试

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

调试

授权信息

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

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

请求参数

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

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

cn-shanghai
AssociatedCcnIdstring

智能接入网关实例绑定的云连接网实例ID。

ccn-bxuau4ezctt****
SmartAGIdstring

智能接入网关实例ID。

sag-6z21oj0vjjrx6s****
Statusstring

智能接入网关实例的状态。取值:

  • Ordered:已下单。

  • Delivered:已发货。

  • Received:已收货。

  • Returning:退货中。

  • Active:活跃。

  • Init:初始化。

  • Offline:离线。

Active
Namestring

智能接入网关实例的名称。

名称长度为2~128个字符,以大小写字母或中文开头,可包含数字、下划线(_)和短划线(-)。

nametest
PageSizeinteger

分页查询时每页显示的条目数。默认值:10。取值范围:1~50

10
PageNumberinteger

查询页码。默认值:1

1
SerialNumberstring

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

sag32a3****
AclIdsstring

智能接入网关实例绑定的访问控制实例ID。

acl-xhwhyuo43l0n****
UnboundAclIdsstring

访问控制实例ID。

本参数表示查询未绑定该访问控制实例ID的智能接入网关实例信息。多个访问控制实例ID以半角逗号(,)隔开。

acl-sjfbgngj****
InstanceTypestring

智能接入网关实例类型。取值:

  • software:智能接入网关App版实例。
  • hardware:智能接入网关硬件版实例。
hardware
CanAssociateQosboolean

可否关联QoS策略实例。取值:

  • true:可以。
  • false:不可以。

本参数表示查询可否关联QoS策略实例的智能接入网关实例的信息。

false
HardwareTypestring

智能接入网关设备硬件规格。取值:

  • sag-1000
  • sag-100wm
sag-100wm
SoftwareVersionstring

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

2.3.0.0
VersionComparatorstring

版本过滤符。取值:

  • greater:大于当前版本。
  • less:小于当前版本。
  • equals:等于当前版本。
equals
BusinessStatestring

智能接入网关实例的业务状态。取值:

  • Normal:正常。
  • Arrearage:欠费锁定。
Normal
ResourceGroupIdstring

智能接入网关实例所属的资源组ID。

rg-acfm2iu4fnc****
SmartAGIdsarray

智能接入网关实例ID列表。

string

智能接入网关实例ID。

sag-6z21oj0vjjrx6s****
AssociatedCcnNamestring

绑定的云连接网实例的名称。

名称长度为2~100个字符,以大小写字母或中文开头,可包含数字、下划线(_)、半角句号(.)和短划线(-)。

ccn

返回参数

名称类型描述示例值
object

返回结果。

TotalCountinteger

列表条目数。

1
PageSizeinteger

分页查询时每页包含的条目数。

10
RequestIdstring

请求ID。

ADE68CEE-8E4F-4D0B-9EE9-2C2FFAABF41F
PageNumberinteger

列表的页码。

1
SmartAccessGatewaysobject []

智能接入网关实例信息列表。

SerialNumberstring

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

sage6gsdllbid****,sage6nniq3dqa****
Statusstring

智能接入网关实例的状态。

  • Ordered:已下单。

  • Delivered:已发货。

  • Received:已收货。

  • Returning:退货中。

  • Active:活跃。

  • Init:初始化。

  • Offline:离线。

Active
UpBandwidth4Ginteger

智能接入网关设备4G公网最大上行带宽。单位:Mbps。

3
BackupStatusstring

智能接入网关的备份状态。 取值:

  • closed:未开启。

  • opened:已开启。

  • opening:开启中。

Active
IdaasApplicationIdstring

智能接入网关实例关联的IDaaS应用ID。

idaas-cn-hangzhou-l7j0wf0crzea****
SoftwareVersionstring

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

2.3.0.0
CreateTimelong

智能接入网关实例的创建时间戳。单位:毫秒。

时间戳的格式采用Unix时间戳,表示从格林威治时间1970年01月01日00时00分00秒至创建智能接入网关实例时的总时长。

1622617250000
SmartAGIdstring

智能接入网关实例ID。

sag-6z21oj0vjjrx6s****
UpBandwidthWaninteger

智能接入网关设备WAN口最大上行带宽。单位:Mbps。

2
Citystring

智能接入网关设备所在城市ID。

cn-shanghai
AclIdsstring

智能接入网关实例绑定的访问控制实例ID。

acl-shfhfhhfbnvkdg****
QosIdsstring

智能接入网关实例绑定的QoS策略实例ID。

qos-djh****
IRIdsstring

智能接入网关实例关联的智能选路ID列表

ir-7unf5nom01ygrg****
CidrBlockstring

本地网络或客户端要与云上通信的私网网段。

10.0.9.0/24
Descriptionstring

智能接入网关实例的描述信息。

docdesc
IpsecStatusstring

ipsecVPN连接状态。

  • up:ipsecVPN连接正常。
  • down:ipsecVPN连接异常。
up
EnterpriseCodestring

智能接入网关实例绑定的企业码ID。

12P****
DpiStatusstring

智能接入网关实例DPI功能开启状态。

  • On:已开启。
  • Off:未开启。
Off
AssociatedCcnIdstring

智能接入网关实例绑定的云连接网实例ID。

ccn-iz26o9zye6lhoo****
Namestring

智能接入网关实例的名称。

testname
HardwareVersionstring

智能接入网关实例类型。

  • sag-1000:标识当前实例为智能接入网关硬件版实例,且实例绑定的设备类型为SAG-1000。
  • sag-100wm:标识当前实例为智能接入网关硬件版实例,且实例绑定的设备类型为SAG-100WM。
  • sag-software:标识当前实例为智能接入网关APP实例。
  • sag-vcpe:标识当前实例为智能接入网关vCPE实例。
sag-100wm
IdaasIdstring

智能接入网关实例绑定的IDaaS实例ID。

idaas-cn-hangzhou-1ahixtl****
DataPlanlong

智能接入网关实例的流量套餐。单位:GB。

说明 目前仅支持每个账号每个月赠送5 GB流量。
5
AssociatedCcnNamestring

智能接入网关实例绑定的云连接网实例名称。

ccn
ResellerUidstring

经销商的阿里云账号ID。

25346073170691****
DpiMonitorStatusstring

智能接入网关实例DPI监控功能开启状态。

  • Active:已开启。
  • Inactive:未开启。
Inactive
MaxBandwidthstring

智能接入网关实例的带宽峰值。单位:Mbps。

50M
SmartAGUidlong

智能接入网关实例的所属的账号ID。

1210123456123456
BackupSoftwareVersionstring

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

2.3.0.0
EndTimelong

智能接入网关实例的到期时间戳。单位:毫秒。

时间戳的格式采用Unix时间戳,表示从格林威治时间1970年01月01日00时00分00秒至智能接入网关实例到期时的总时长。

1628265600000
ResellerInstanceIdstring

经销商智能接入网关实例ID。

sag-v0fkpk4akfz5****
VpnStatusstring

aliVPN连接状态。

  • up:aliVPN连接正常。
  • down:aliVPN连接异常。
down
RoutingStrategystring

智能接入网关实例的线下路由同步方式。

  • static:静态路由。
  • dynamic:动态路由。
static
SecurityLockThresholdinteger

智能接入网关设备离线锁定的时间阈值。

单位:秒。

3600
Typestring

链路类型。

  • ccn:表示本地网络通过云连接网接入阿里云。
  • vbr:表示本地网络通过边界路由器及物理专线接入阿里云。
ccn
Statusstring

链路状态。

宽带链路状态:

  • Ordered:待发货。
  • Delivered:已发货。
  • Offline:离线。
  • Active:可用。
  • Arrearage:欠费锁定。

物理专线链路状态:

  • normal:正常。
  • arrears:欠费。
Active
EndTimelong

链路到期时间戳。单位:毫秒。

时间戳的格式采用Unix时间戳,表示从格林威治时间1970年01月01日00时00分00秒至链路到期时的总时长。

1628265600000
Bandwidthstring

链路带宽值。单位:Mbps。

50M
RelateInstanceRegionIdstring

链路相关实例所在的地域ID。

cn-shanghai
RelateInstanceIdstring

链路相关实例ID。

ccn-iz26o9zye6lhoo****
InstanceIdstring

商品实例ID。

sag-6z21oj0vjjrx6s****
CommodityTypestring

链路带宽的商品类型。

  • bandwidth:表示智能接入网关和带宽为拆分售卖类型。
  • smartag:表示智能接入网关和带宽为组合售卖类型。
smartag
ResourceGroupIdstring

智能接入网关实例所属资源组ID。

rg-acfm2iu4fnc****
UserCountinteger

智能接入网关实例客户端账号数量。

3
AccessPointIdstring

智能接入网关实例接入点ID。

238
ApplicationBandwidthPackageIdstring

智能接入网关实例绑定的应用加速带宽包ID。

abwp-7963l7iqnquyj3****
AccelerateBandwidthlong

智能接入网关实例的应用加速带宽峰值。单位:Mbps。

1
EnableSoftwareConnectionAuditboolean

是否已开启SAG App连接日志审计。取值:

  • true:已开启SAG App连接日志审计。

  • false:未开启SAG App连接日志审计。

true
Positionstring

智能接入网关实例位置信息。

[{\"adcode\":\"\",\"label\":\"山东省青岛市即墨区\",\"value\":\"B02140800T\",\"center\":\"120.989576,36.487512\",\"_new\":\"true\"}]
Ispstring

智能接入网关实例使用的运营商名字。

电信
EnableAdvancedMonitorboolean

智能接入网关实例是否已开启深度监控。取值:

  • 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错误码错误信息描述
400Param.InvalidVersionComparatorThe specified version comparison operator is invalid.非法的版本比较操作值。
400InvalidRegionIDThe specified regionId does not exist.指定的RegionId不存在。
403ForbiddenUser not authorized to operate on the specified resource.用户没有操作此资源的权限。

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

  • 本页导读 (1)
文档反馈