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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
RegionId String cn-shanghai

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

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

AssociatedCcnId String ccn-bxuau4ezctt****

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

SmartAGId String sag-c3m3n1khz58l****

智能接入网关实例ID。

Status String Active

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

  • Ordered:待发货。
  • Delivered:已发货。
  • Received:已激活。
  • Unconfirmed:待确认。
  • Active:可用。
  • Offline:离线。
  • Arrearage:欠费锁定。
Name String nametest

智能接入网关实例名称。

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

PageSize Integer 10

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

PageNumber Integer 1

查询页码。默认值为1

Action String DescribeSmartAccessGateways

要执行的操作。取值:DescribeSmartAccessGateways

SerialNumber String sag32a3****

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

AclIds String acl-xhwhyuo43l****

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

UnboundAclIds String acl-sjfbgngj****

访问控制实例ID。

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

InstanceType String hardware

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

  • software:智能接入网关APP版实例。
  • hardware:智能接入网关硬件版实例。
CanAssociateQos Boolean false

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

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

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

HardwareType String sag-1000

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

  • sag-1000
  • sag-100wm
SoftwareVersion String 2.3.0.0

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

VersionComparator String equals

版本过滤符。取值:

  • greater:大于当前版本。
  • less:小于当前版本。
  • equals:等于当前版本。
BusinessState String Normal

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

  • Normal:正常。
  • Arrearage:欠费锁定。
ResourceGroupId String rg-acfm2iu4fnc****

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

SmartAGIds.N String sag-v0a6qd069p7zk****

智能接入网关实例ID。

返回数据

名称 类型 示例值 描述
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

智能接入网关实例的创建时间戳。

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。

CidrBlock String 172.16.1.0/24

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

Description String docdesc

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

IpsecStatus String down

ipsecVPN连接状态。

  • up:ipsecVPN连接正常。
  • down:ipsecVPN连接异常。
EnterpriseCode String 12P****

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

DpiStatus String Off

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

  • On:已开启。
  • Off:未开启。
AssociatedCcnId String ccn-iz26o9zye6lhoo****

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

Name String testname

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

HardwareVersion String sag-100wm

智能接入网关实例类型。

  • sag-1000:标识当前实例为智能接入网关硬件版实例,且实例绑定的设备类型为SAG-1000。
  • sag-10wm:标识当前实例为智能接入网关硬件版实例,且实例绑定的设备类型为SAG-100WM。
  • sag-software:标识当前实例为智能接入网关APP实例。
  • sag-vcpe:标识当前实例为智能接入网关vCPE实例。
IdaasId String idaas-cn-hangzhou-1ahixtl****

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

DataPlan Long 5

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

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

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

ResellerUid String 12345556345555

经销商账号ID。

DpiMonitorStatus String Active

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

  • Active:已开启。
  • Inactive:未开启。
MaxBandwidth String 50 M

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

SmartAGUid Long 12345556345555

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

BackupSoftwareVersion String 2.3.0.0

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

EndTime Long 1628265600000

智能接入网关实例的到期时间戳。

ResellerInstanceId String sag-v0fkpk4akfz5******

经销商实例ID。

VpnStatus String down

aliVPN连接状态。

  • up:aliVPN连接正常。
  • down:aliVPN连接异常。
RoutingStrategy String static

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

  • static:静态路由。
  • dynamic:动态路由。
SecurityLockThreshold Integer 3600

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

单位:秒。

Links Array of Link

本地网络接入阿里云的链路信息列表。

Link
Type String ccn

链路类型。

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

链路状态。

宽带链路状态:

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

物理专线链路状态:

  • normal:正常。
  • arrears:欠费。
EndTime Long 1628265600000

链路到期时间戳。

Bandwidth String 50 M

链路带宽值。单位:Mbps。

RelateInstanceRegionId String cn-shanghai

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

RelateInstanceId String ccn-iz26o9zye6lhoo****

链路相关实例ID。

InstanceId String sag-6z21oj0vjjrx6s****

商品实例ID。

CommodityType String smartag

链路带宽的商品类型:

  • bandwidth:表示智能接入网关和带宽为拆分售卖类型。
  • smartag:表示智能接入网关和带宽为组合售卖类型。
ResourceGroupId String rg-acfm2iu4fnc****

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

UserCount Integer 3

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

AccessPointId String 238

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

ApplicationBandwidthPackageId String abwp-7963l7iqnquyj3****

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

AccelerateBandwidth Long 1

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

示例

请求示例

http(s)://[Endpoint]/?RegionId=cn-shanghai
&AssociatedCcnId=ccn-bxuau4ezctt****
&SmartAGId=sag-c3m3n1khz58l****
&Status=Active
&Name=nametest
&PageSize=10
&PageNumber=1
&Action=DescribeSmartAccessGateways
&SerialNumber=sag32a3****
&AclIds=acl-xhwhyuo43l****
&UnboundAclIds=acl-sjfbgngj****
&InstanceType=hardware
&CanAssociateQos=false
&HardwareType=sag-1000
&SoftwareVersion=2.3.0.0
&BusinessState=Normal
&ResourceGroupId=rg-acfm2iu4fnc****
&SmartAGIds=["sag-v0a6qd069p7zk****"]
&公共请求参数

正常返回示例

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>
        <SmartAccessGateway>
            <Status>Active</Status>
            <EndTime>1628265600000</EndTime>
            <ResourceGroupId>rg-acfm2iu4fnc****</ResourceGroupId>
            <CreateTime>1622617250000</CreateTime>
            <AssociatedCcnName>zxtest-202106</AssociatedCcnName>
            <MaxBandwidth>50M</MaxBandwidth>
            <VpnStatus>down</VpnStatus>
            <CidrBlock>10.0.9.0/24</CidrBlock>
            <DpiMonitorStatus>Inactive</DpiMonitorStatus>
            <HardwareVersion>sag-vcpe</HardwareVersion>
            <Name>zxtest-202106</Name>
            <SoftwareVersion>2.3.0.0</SoftwareVersion>
            <SerialNumber>sage6gsdllbid****,sage6nniq3dqa****</SerialNumber>
            <IpsecStatus>up</IpsecStatus>
            <RoutingStrategy>static</RoutingStrategy>
            <AccessPointId>238</AccessPointId>
            <Links>
                <Link>
                    <Status>Active</Status>
                    <Type>ccn</Type>
                    <EndTime>1628265600000</EndTime>
                    <InstanceId>sag-6z21oj0vjjrx6s****</InstanceId>
                    <RelateInstanceId>ccn-iz26o9zye6lhoo****</RelateInstanceId>
                    <Bandwidth>50M</Bandwidth>
                    <CommodityType>smartag</CommodityType>
                </Link>
            </Links>
            <AssociatedCcnId>ccn-iz26o9zye6lhoo****</AssociatedCcnId>
            <BackupSoftwareVersion>2.3.0.0</BackupSoftwareVersion>
            <SmartAGId>sag-6z21oj0vjjrx6s****</SmartAGId>
            <DpiStatus>Off</DpiStatus>
            <SecurityLockThreshold>0</SecurityLockThreshold>
            <BackupStatus>Active</BackupStatus>
        </SmartAccessGateway>
    </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" : {
    "SmartAccessGateway" : [ {
      "Status" : "Active",
      "EndTime" : 1628265600000,
      "ResourceGroupId" : "rg-acfm2iu4fnc****",
      "CreateTime" : 1622617250000,
      "AssociatedCcnName" : "zxtest-202106",
      "MaxBandwidth" : "50M",
      "VpnStatus" : "down",
      "CidrBlock" : "10.0.9.0/24",
      "DpiMonitorStatus" : "Inactive",
      "HardwareVersion" : "sag-vcpe",
      "Name" : "zxtest-202106",
      "SoftwareVersion" : "2.3.0.0",
      "SerialNumber" : "sage6gsdllbid****,sage6nniq3dqa****",
      "IpsecStatus" : "up",
      "RoutingStrategy" : "static",
      "AccessPointId" : 238,
      "Links" : {
        "Link" : [ {
          "Status" : "Active",
          "Type" : "ccn",
          "EndTime" : 1628265600000,
          "InstanceId" : "sag-6z21oj0vjjrx6s****",
          "RelateInstanceId" : "ccn-iz26o9zye6lhoo****",
          "Bandwidth" : "50M",
          "CommodityType" : "smartag"
        } ]
      },
      "AssociatedCcnId" : "ccn-iz26o9zye6lhoo****",
      "BackupSoftwareVersion" : "2.3.0.0",
      "SmartAGId" : "sag-6z21oj0vjjrx6s****",
      "DpiStatus" : "Off",
      "SecurityLockThreshold" : 0,
      "BackupStatus" : "Active"
    } ]
  }
}

错误码

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. 用户没有操作此资源的权限。

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