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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeSmartAccessGatewayAttribute

要执行的操作。取值:DescribeSmartAccessGatewayAttribute

RegionId String cn-shanghai

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

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

SmartAGId String sag-6z21oj0vjjrx****

智能接入网关实例ID。

返回数据

名称 类型 示例值 描述
UpBandwidth4G Integer 3

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

Description String testdesc

智能接入网关实例描述。

EndTime Long 1628265600000

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

ResourceGroupId String rg-acfm2iu4fnc****

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

UserCount Integer 3

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

AssociatedCcnName String testname

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

MaxBandwidth String 50 M

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

VpnStatus String down

aliVPN连接状态。

  • up:aliVPN连接正常。
  • down:aliVPN连接异常。
BoxControllerIp String 112.XX.XX.25

智能接入网关主设备的公网IP。

UpBandwidthWan Integer 4

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

CidrBlock String 10.0.9.0/24

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

QosIds Array of String qos-yca8p30w1jcrbt****

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

Devices Array of Device

智能接入网关设备信息列表。

Device
SerialNumber String sage6gsdllbid****"

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

HaState String Active

智能接入网关设备高可用状态。

  • Active:标识当前设备为主设备。
  • Standby:标识当前设备为备设备。
SecretKey String +T4nV8xkS4****

智能接入网关设备密钥。

DpiSignatureDbVersion String 20201117_1_0-0.0.1

智能接入网关设备使用的应用识别数据库版本。

SoftwareVersion String 2.3.0.0

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

DistributeSkStatus Integer 1

智能接入网关设备密钥激活状态。

  • 1:已激活。
  • 0:未激活。
MonitorVersion String 0.1.11.17

智能接入网关设备使用的监控版本。

HcState String online

智能接入网关设备健康检查状态。

  • online:设备在线,已经接入阿里云。
  • offline:设备离线,未接入阿里云。
Name String testname

智能接入网关实例名称。

OptimizationType Boolean fec

智能接入网关实例优化重传类型。优化重传类型开启后,默认为fec

IpsecStatus String up

ipsecVPN连接状态。

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

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

  • static:静态路由。
  • dynamic:动态路由。
AssociatedCcnId String ccn-iz26o9zye6lhoo****

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

FlowLogIds Array of String fl-0vv40lyu2un5qh****

智能接入网关实例绑定的流日志实例ID。

SmartAGId String sag-6z21oj0vjjrx6s****

智能接入网关实例ID。

InstanceType String sag-vcpe

智能接入网关实例类型。

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

经销商账号ID。

SecurityLockThreshold Integer 3600

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

单位:秒。

Status String Active

智能接入网关实例状态。

  • Ordered:待发货。
  • Delivered:已发货。
  • Received:已激活。
  • Unconfirmed:待确认。
  • Active:可用。
  • Offline:离线。
  • Arrearage:欠费锁定。
RequestId String F02D092B-A0B7-4BA1-BCA7-014B953C5DC7

请求ID。

CreateTime Long 1622617250000

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

DataPlan Long 5

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

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

智能接入网关实例是否开启优化重传功能。

  • true:已开启。
  • false:未开启。

提交工单开启优化重传功能。

City String cn-shanghai

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

ResellerInstanceId String sag-v0fkpk4akfz5******

经销商实例ID。

SerialNumber String sage6gsdllbidl****,sage6nniq3d****

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

BackupBoxControllerIp String 112.XX.XX.27

智能接入网关备设备的公网IP。

TrafficMasterSn String sage6nniq3d****

当前主要负责传输流量的智能接入网关设备序列号。

AccessPointId String 238

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

Links Array of Link

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

Link
HealthCheckTargetIp String 100.XX.XX.144

边界路由器IP地址。

说明 在您创建关于专线的健康检查实例时,需指定边界路由器IP地址为目标地址。
EndTime Long 1628265600000

链路到期时间戳。

Status String Active

链路状态。

宽带链路状态:

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

专线链路状态:

  • normal:正常。
  • arrears:欠费。
Type String ccn

链路类型。

  • ccn:表示本地网络通过云连接网接入阿里云。
  • vbr:表示本地网络通过边界路由器的专线接入阿里云。
Bandwidth String 50 M

链路带宽值。单位:Mbps。

RelateInstanceRegionId String cn-shanghai

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

RelateInstanceId String ccn-iz26o9zye6lho****

链路相关实例ID。

InstanceId String sag-6z21oj0vjjrx****

商品实例ID。

CommodityType String smartag

链路带宽的商品类型:

  • bandwidth:表示智能接入网关和带宽为拆分售卖类型。
  • smartag:表示智能接入网关和带宽为组合售卖类型。
AclIds Array of String acl-9p14e8y1red6kv****

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

ApplicationBandwidthPackageId String abwp-7963l7iqnquyj3****

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

ApplicationBandwidthPackageName String testname

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

AccelerateBandwidth Long 1

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

ApplicationBandwidthPackageBussinessStatus String Normal

应用加速带宽包实例的状态。

  • Abnormal:异常。
  • Normal:正常。
ApplicationBandwidthPackageOperationLocks Object

应用加速带宽包实例锁定信息。

LockType String FinancialLocked

锁定类型。取值:FinancialLocked

LockReason String Message

锁定原因。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeSmartAccessGatewayAttribute
&RegionId=cn-shanghai
&SmartAGId=sag-6z21oj0vjjrx****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeSmartAccessGatewayAttributeResponse>
    <EndTime>1628265600000</EndTime>
    <ResourceGroupId>rg-acfm2iu4fnc****</ResourceGroupId>
    <AssociatedCcnName>zxtest-202106</AssociatedCcnName>
    <MaxBandwidth>50M</MaxBandwidth>
    <VpnStatus>down</VpnStatus>
    <BoxControllerIp>112.XX.XX.25</BoxControllerIp>
    <CidrBlock>10.0.9.0/24</CidrBlock>
    <Devices>
        <Device>
            <MonitorVersion>2.0.3.0</MonitorVersion>
            <SecretKey>+T4nV8xkS4****</SecretKey>
            <SoftwareVersion>2.3.0.0</SoftwareVersion>
            <SerialNumber>sage6gsdllbid****</SerialNumber>
            <HaState>Active</HaState>
            <DpiSignatureDbVersion>20201117_1_0-0.0.1</DpiSignatureDbVersion>
            <DistributeSkStatus>1</DistributeSkStatus>
            <HcState>online</HcState>
        </Device>
        <Device>
            <MonitorVersion>2.0.3.0</MonitorVersion>
            <SecretKey>X8Sfepq8qIn****</SecretKey>
            <SoftwareVersion>2.3.0.0</SoftwareVersion>
            <SerialNumber>sage6nniq3dqa****</SerialNumber>
            <HaState>Standby</HaState>
            <DpiSignatureDbVersion>20201117_1_0-0.0.1</DpiSignatureDbVersion>
            <DistributeSkStatus>0</DistributeSkStatus>
            <HcState>online</HcState>
        </Device>
    </Devices>
    <Name>zxtest-202106</Name>
    <IpsecStatus>up</IpsecStatus>
    <RoutingStrategy>static</RoutingStrategy>
    <AssociatedCcnId>ccn-iz26o9zye6lhoo****</AssociatedCcnId>
    <SmartAGId>sag-6z21oj0vjjrx6s****</SmartAGId>
    <InstanceType>sag-vcpe</InstanceType>
    <SecurityLockThreshold>0</SecurityLockThreshold>
    <Status>Active</Status>
    <RequestId>F02D092B-A0B7-4BA1-BCA7-014B953C5DC7</RequestId>
    <CreateTime>1622617250000</CreateTime>
    <SerialNumber>sage6gsdllbidl****,sage6nniq3d****</SerialNumber>
    <BackupBoxControllerIp>112.XX.XX.27</BackupBoxControllerIp>
    <TrafficMasterSn>sage6nniq3d****</TrafficMasterSn>
    <AccessPointId>238</AccessPointId>
    <Links>
        <Link>
            <Status>Active</Status>
            <Type>ccn</Type>
            <EndTime>1628265600000</EndTime>
            <InstanceId>sag-6z21oj0vjjrx****</InstanceId>
            <RelateInstanceId>ccn-iz26o9zye6lho****</RelateInstanceId>
            <Bandwidth>50M</Bandwidth>
            <CommodityType>smartag</CommodityType>
        </Link>
    </Links>
</DescribeSmartAccessGatewayAttributeResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "EndTime" : 1628265600000,
  "ResourceGroupId" : "rg-acfm2iu4fnc****",
  "AssociatedCcnName" : "zxtest-202106",
  "MaxBandwidth" : "50M",
  "VpnStatus" : "down",
  "BoxControllerIp" : "112.XX.XX.25",
  "CidrBlock" : "10.0.9.0/24",
  "Devices" : {
    "Device" : [ {
      "MonitorVersion" : "2.0.3.0",
      "SecretKey" : "+T4nV8xkS4****",
      "SoftwareVersion" : "2.3.0.0",
      "SerialNumber" : "sage6gsdllbid****",
      "HaState" : "Active",
      "DpiSignatureDbVersion" : "20201117_1_0-0.0.1",
      "DistributeSkStatus" : 1,
      "HcState" : "online"
    }, {
      "MonitorVersion" : "2.0.3.0",
      "SecretKey" : "X8Sfepq8qIn****",
      "SoftwareVersion" : "2.3.0.0",
      "SerialNumber" : "sage6nniq3dqa****",
      "HaState" : "Standby",
      "DpiSignatureDbVersion" : "20201117_1_0-0.0.1",
      "DistributeSkStatus" : 0,
      "HcState" : "online"
    } ]
  },
  "Name" : "zxtest-202106",
  "IpsecStatus" : "up",
  "RoutingStrategy" : "static",
  "AssociatedCcnId" : "ccn-iz26o9zye6lhoo****",
  "SmartAGId" : "sag-6z21oj0vjjrx6s****",
  "InstanceType" : "sag-vcpe",
  "SecurityLockThreshold" : 0,
  "Status" : "Active",
  "RequestId" : "F02D092B-A0B7-4BA1-BCA7-014B953C5DC7",
  "CreateTime" : 1622617250000,
  "SerialNumber" : "sage6gsdllbidl****,sage6nniq3d****",
  "BackupBoxControllerIp" : "112.XX.XX.27",
  "TrafficMasterSn" : "sage6nniq3d****",
  "AccessPointId" : 238,
  "Links" : {
    "Link" : [ {
      "Status" : "Active",
      "Type" : "ccn",
      "EndTime" : 1628265600000,
      "InstanceId" : "sag-6z21oj0vjjrx****",
      "RelateInstanceId" : "ccn-iz26o9zye6lho****",
      "Bandwidth" : "50M",
      "CommodityType" : "smartag"
    } ]
  }
}

错误码

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

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