ActivateHardware
激活设备
被如下接口引用：ActivateHardware。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Vendor | String | 是 | 厂商名称 示例值：vendor1 |
| SN | String | 是 | 设备SN序列号 示例值：AN |
| DeviceName | String | 是 | 设备名称 示例值：mna-w795bzezug |
| Description | String | 否 | 备注 示例值：this is descript |
| DataKey | String | 否 | 设备密钥 示例值：123drer43sr |
| AccessScope | Integer | 否 | 接入环境。0：公有云网关；1：自有网关；2：公有云网关和自有网关。不填默认公有云网关。 具体含义： 公有云网关：即该设备只能接入公有云网关（就近接入） 自有网关：即该设备只能接入已经注册上线的自有网关（就近接入或固定ip接入） 公有云网关和自有网关：即该设备同时可以接入公有云网关和已经注册上线的自有网关（就近接入或固定ip接入） 示例值：0 |
| LicensePayMode | Integer | 否 | 当付费方为租户时，可选择租户license付费方式： 0，月度授权 1，永久授权 若不传则默认为月度授权。 当付费方为厂商时，此参数无效 示例值：0 |
| GroupId | String | 否 | 设备分组ID 示例值：cliGrp-xf8rboasbh |
| GroupName | String | 否 | 设备分组名称，预留参数，需要分组时传入GroupId 示例值：group-name |
| FlowTrunc | Integer | 否 | 设备无流量包处理方式，0: 按量付费，1: 截断加速 示例值：0 |
| DeviceId | String | 否 | 激活后的设备ID 示例值：mna-w795bzezug |
ActiveDeviceList
激活设备数统计
被如下接口引用：GetActiveDeviceCount。
| 名称 | 类型 | 描述 |
|---|---|---|
| Count | Integer | 数量 示例值：1 |
| Time | String | 时间 示例值：2024-11-20 |
Capacity
接口能力扩展，用于填充电信的加速Token，并为未来参数提供兼容空间
被如下接口引用：CreateQos。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| CTCCToken | String | 否 | 电信鉴权的Token。要加速的电信手机终端访问 http://qos.189.cn/qos-api/getToken?appid=TencentCloud 页面，获取返回结果中result的值 示例值：177cc9c4ab0-7b93546e8a7a89c7716b38139af3ba6b580045e9 |
| Province | String | 否 | 终端所处在的省份，建议不填写由服务端自动获取，若需填写请填写带有省、市、自治区、特别行政区等后缀的省份中文全称 示例值：广东省 |
Context
加速策略关键数据
被如下接口引用：CreateQos。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| NetworkData | NetworkData | 否 | 测速数据 示例值：略 |
| ExpectedLowThreshold | ExpectedThreshold | 否 | 用户期望最低门限 示例值：略 |
| ExpectedHighThreshold | ExpectedThreshold | 否 | 用户期望最高门限 示例值：略 |
DestAddressInfo
多网聚合加速目标地址结构体
被如下接口引用：CreateQos。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| DestIp | Array of String | 是 | 加速业务目标 ip 地址数组 示例值：[10.1.135.152, 10.1.133.14] |
DeviceBaseInfo
设备的基本信息
被如下接口引用：GetDevice, GetDevices, GetGroupDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| DeviceId | String | 设备唯一ID 示例值："mna-2x2tllhb18" |
| DeviceName | String | 设备名称 示例值："mna-2x2tllhb18" |
| CreateTime | String | 设备创建的时间，单位：ms 示例值：169043203113091072 |
| LastTime | String | 设备最后在线时间，单位：ms 示例值：169043203113091072 |
| Remark | String | 设备的备注 示例值："remark" |
| AccessScope | Integer | 接入环境。0：公有云网关；1：自有网关；2：公有云网关和自有网关。默认公有云网关。 具体含义： 公有云网关：即该设备只能接入公有云网关（就近接入） 自有网关：即该设备只能接入已经注册上线的自有网关（就近接入或固定ip接入） 公有云网关和自有网关：即该设备同时可以接入公有云网关和已经注册上线的自有网关（就近接入或固定ip接入） 示例值：0 |
| LicensePayMode | Integer | license授权有效期 0：月度授权 1：永久授权 示例值：1 |
| Payer | Integer | 付费方 0：厂商付费 1：客户付费 示例值：1 |
| GroupId | String | 设备分组ID 示例值："cliGrp-xf8rboasbh" |
| GroupName | String | 设备分组名称 示例值："cliGrp-xf8rboasbh" |
| FlowTrunc | Integer | 设备无流量包处理方式，0: 按量付费，1: 截断加速 示例值：0 |
| Sn | String | 设备sn 示例值："AN" |
| Vendor | String | 厂商 示例值："vendor" |
DeviceDetails
设备详细信息
被如下接口引用：GetDevice。
| 名称 | 类型 | 描述 |
|---|---|---|
| DeviceBaseInfo | DeviceBaseInfo | 设备基本信息 |
| DeviceNetInfo | Array of DeviceNetInfo | 设备网络信息 |
| GatewaySite | String | 聚合服务器地址 示例值：gz |
| BusinessDownRate | Float | 业务下行速率 示例值：10 |
| BusinessUpRate | Float | 业务上行速率 示例值：12 |
DeviceInfo
设备信息结构体
被如下接口引用：CreateQos。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Vendor | Integer | 否 | 运营商 1：移动 2：电信 3：联通 4：广电 99：其他 示例值：1 |
| OS | Integer | 否 | 设备操作系统： 1：Android 2： IOS 99：其他 示例值：1 |
| DeviceId | String | 否 | 设备唯一标识 IOS 填写 IDFV Android 填写 IMEI 示例值：357315094232545 |
| PhoneNum | String | 否 | 用户手机号码 示例值：18649853764 |
| Wireless | Integer | 否 | 无线信息 1：4G 2：5G 3：WIFI 99：其他 示例值：1 |
DeviceNetInfo
设备网络状态信息
被如下接口引用：GetDevice。
| 名称 | 类型 | 描述 |
|---|---|---|
| Type | Integer | 网络类型： 0:数据 1:Wi-Fi 2:有线 示例值：1 |
| DataEnable | Boolean | 启用/禁用 示例值：true |
| UploadLimit | String | 上行限速 示例值：10000 |
| DownloadLimit | String | 下行限速 示例值：10000 |
| DataRx | Integer | 接收实时速率 示例值：100 |
| DataTx | Integer | 发送实时速率 示例值：100 |
| Vendor | Integer | 运营商类型： 1: 中国移动； 2: 中国电信; 3: 中国联通 示例值：1 |
| State | Integer | 连接状态： 0:无连接 1:连接中 2:已连接 示例值：1 |
| PublicIp | String | 公网IP 示例值："xxx.xxx.xxx.xx" |
| SignalStrength | Integer | 信号强度/单位：dbm 示例值：-85 |
| Rat | Integer | 数据网络类型： -1 ：无效值 2：2G 3：3G 4：4G 5：5G 示例值：4 |
| NetInfoName | String | 网卡名 示例值："eth1" |
| DownRate | Float | 下行实时速率（浮点数类型代替上一版本DataRx的整型） 示例值：12.3 |
| UpRate | Float | 上行实时速率（浮点数类型代替上一版本TxRate的整型） 示例值：1.23 |
DevicePayModeInfo
设备付费模式信息
被如下接口引用：GetDevicePayMode。
| 名称 | 类型 | 描述 |
|---|---|---|
| DeviceId | String | 设备ID 示例值：mna-dev1 |
| PayMode | Integer | 付费模式。 1：预付费流量包 0：按流量后付费 示例值：1 |
| PayModeDesc | String | 付费模式描述 示例值：50G流量包 |
| ResourceId | String | 流量包ID，仅当付费模式为流量包类型时才有。 示例值：res-1 |
ExpectedThreshold
用户期望门限
被如下接口引用：CreateQos。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| RTT | Float | 是 | 期望发起加速的时延阈值 示例值：60 |
| Loss | Float | 是 | 期望发起加速的丢包率阈值 示例值：0.02 |
| Jitter | Float | 是 | 期望发起加速的抖动阈值 示例值：60 |
FlowDetails
设备流量信息
被如下接口引用：GetMultiFlowStatistic。
| 名称 | 类型 | 描述 |
|---|---|---|
| NetDetails | Array of NetDetails | 流量数据点 |
| DeviceId | String | 设备ID 示例值："mna-xxx" |
| MaxValue | Float | 流量最大值（单位：bytes） 示例值：51548 |
| AvgValue | Float | 流量平均值（单位：bytes） 示例值：15441 |
| TotalValue | Float | 流量总值（单位：bytes） 示例值：656546 |
FlowPackageInfo
流量包信息
被如下接口引用：GetFlowPackages。
| 名称 | 类型 | 描述 |
|---|---|---|
| ResourceId | String | 流量包的唯一资源ID 示例值：resoiurce-id |
| AppId | Integer | 流量包所属的用户AppId 示例值：1009876765 |
| PackageType | String | 流量包规格类型。可取值如下： DEVICE_1_FLOW_20G、DEVICE_2_FLOW_50G、 DEVICE_3_FLOW_100G、 DEVICE_5_FLOW_500G，分别代表20G、50G、100G、500G档位的流量包。 档位也影响流量包可绑定的设备数量上限： 20G：最多绑定1个设备 50G：最多绑定2个设备 100G：最多绑定3个设备 500G：最多绑定5个设备 示例值：DEVICE_1_FLOW_20G |
| Status | Integer | 流量包状态，0：未生效，1：有效期内，2：已过期 示例值：1 |
| CreateTime | Integer | 购买时间，Unix时间戳格式，单位：秒 示例值：1697181612 |
| ActiveTime | Integer | 生效时间，Unix时间戳格式，单位：秒 示例值：1697181612 |
| ExpireTime | Integer | 过期时间，Unix时间戳格式，单位：秒 示例值：1699860012 |
| DeviceList | Array of String | 流量包绑定的设备ID列表 示例值：["mna-test1","mna-test2"] |
| CapacitySize | Integer | 流量包总容量，单位：MB 示例值：20000 |
| CapacityRemain | Integer | 流量包余量，单位：MB 示例值：10000 |
| RenewFlag | Boolean | 自动续费标识。true代表自动续费，false代表不自动续费 示例值：true |
| ModifyStatus | Integer | 资源包变更状态，0：未发生变配；1：变配中；2：已变配或已续费 示例值：0 |
| TruncFlag | Boolean | 流量截断标识。true代表开启流量截断，false代表不开启流量截断 示例值：false |
| CapacityRemainPrecise | Integer | 流量包精确余量，单位：MB 示例值：200 |
GroupInfo
分组的基本信息
被如下接口引用：GetGroupDetail, GetGroupList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| GroupId | String | 否 | 分组ID 示例值："1a2b3c4d5e" |
| GroupName | String | 否 | 分组名 示例值："group-test" |
| CreateTime | String | 否 | 分组创建的时间，单位：ms 示例值：169043203113091072 |
| UpdateTime | String | 否 | 分组更新的时间，单位：ms 示例值：169043203113091072 |
| Description | String | 否 | 分组描述 示例值："description for group" |
| DeviceNum | Integer | 否 | 分组中的设备数量 示例值：5 |
Hardware
新建Hardware入参
被如下接口引用：AddHardware。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| SN | String | 是 | 硬件序列号 示例值：AN |
| LicenseChargingMode | Integer | 是 | license计费模式： 1，租户付费 2，厂商月付费 3，厂商永久授权 示例值：1 |
| Description | String | 否 | 设备描述 示例值：this is descript |
| HardwareId | String | 否 | 硬件ID，入参无需传递 示例值：cpe-9oii2ew1z4 |
HardwareInfo
硬件信息
被如下接口引用：GetHardwareList。
| 名称 | 类型 | 描述 |
|---|---|---|
| DeviceId | String | 设备ID 示例值：mna-dev1 |
| DeviceName | String | 设备名称 示例值：dev-name |
| ActiveTime | String | 激活时间 示例值：1676800844 |
| LastOnlineTime | String | 最后在线时间 示例值：1676800844 |
| Description | String | 备注 示例值：this is descript |
| VendorDescription | String | 厂商备注 示例值：厂商备注 |
| LicenseChargingMode | Integer | license计费模式： 1，租户月付费 2，厂商月付费 3，license永久授权 注：后续将废弃此参数，新接入请使用LicensePayMode和Payer 示例值：1 |
| CreateTime | String | 创建时间 示例值：1676800844 |
| SN | String | 硬件序列号 示例值：AN |
| LicensePayMode | Integer | license授权有效期 0：月度授权 1：永久授权 示例值：0 |
| Payer | Integer | 付费方 0：客户付费 1：厂商付费 示例值：1 |
| GroupId | String | 设备分组ID 示例值："group-1" |
| GroupName | String | 设备分组名称 示例值："g-name" |
| FlowTrunc | Integer | 设备无流量包处理方式，0: 按量付费，1: 截断加速 示例值：0 |
L3ConnInfo
三层互通规则信息
被如下接口引用：GetL3ConnList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| L3ConnId | String | 否 | 互通规则ID 示例值：l3conn-abcd |
| DeviceId1 | String | 否 | 互通设备ID 示例值：mna-dex |
| Cidr1 | String | 否 | 互通规则CIDR 示例值：173.12.0.0/16 |
| DeviceId2 | String | 否 | 互通设备ID 示例值：mna-cde |
| Cidr2 | String | 否 | 互通规则CIDR 示例值：173.13.0.0/16 |
| Enable | Boolean | 否 | 互通规则启用状态 示例值：true |
| Description | String | 否 | 互通规则描述 示例值：this is descript |
MonitorData
流量监控指标
被如下接口引用：GetNetMonitor。
| 名称 | 类型 | 描述 |
|---|---|---|
| Time | String | 时间点：s 示例值：1662622200 |
| BusinessMetrics | Float | 业务指标（bps/ms/%） 示例值：1.0 |
| SlotNetInfo | Array of SlotNetInfo | 网卡状态信息 |
NetDetails
网络详细信息
被如下接口引用：GetFlowStatistic, GetFlowStatisticByGroup, GetFlowStatisticByRegion, GetMultiFlowStatistic。
| 名称 | 类型 | 描述 |
|---|---|---|
| Current | Float | 流量值（byte） 示例值：98 |
| Time | String | 时间点，单位：s 示例值：1690424186 |
NetworkData
测速数据
被如下接口引用：CreateQos。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| RTT | Array of Float | 是 | 时延数组，最大长度30 示例值：[10,20,30] |
| Loss | Float | 是 | 丢包率 示例值：0.02 |
| Jitter | Float | 是 | 抖动 示例值：50.5 |
| Timestamp | Integer | 是 | 10位秒级时间戳 示例值：1644891913 |
SlotNetInfo
网卡流量指标数据
被如下接口引用：GetNetMonitor。
| 名称 | 类型 | 描述 |
|---|---|---|
| NetInfoName | String | 网卡名 示例值："eth0" |
| PublicIP | String | 公网IP 示例值："xxx.xxx.xx.xxx" |
| Current | Float | 指标数据（bps/ms/%） 示例值：2.3 |
SrcAddressInfo
移动网络加速源地址结构体
被如下接口引用：CreateQos。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| SrcIpv4 | String | 否 | 用户私网 ipv4 地址 示例值：10.1.135.152 |
| SrcPublicIpv4 | String | 否 | 用户公网 ipv4 地址 示例值：223.104.63.10 |
| SrcIpv6 | String | 否 | 用户 ipv6 地址 示例值：1050:0:0:0:5:600:300c:326b |
UpdateNetInfo
更新设备网络状态信息
被如下接口引用：UpdateDevice。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Type | Integer | 否 | 网络类型： 0:数据 1:Wi-Fi 示例值：1 |
| DataEnable | Boolean | 否 | 启用/禁用 示例值：true |
| UploadLimit | Integer | 否 | 上行限速：bit 示例值：10000 |
| DownloadLimit | Integer | 否 | 下行限速：bit 示例值：10000 |
| NetInfoName | String | 否 | 网卡名 示例值："eth1" |
VendorHardware
厂商硬件详细信息
被如下接口引用：GetVendorHardware。
| 名称 | 类型 | 描述 |
|---|---|---|
| HardwareId | String | 硬件id 示例值：cpe-ids1 |
| SN | String | 硬件序列号 示例值：AN |
| CreateTime | String | 创建时间 示例值：1680019225 |
| Status | Integer | 激活状态， 空：全部； 1:待激活； 2:已激活 示例值：1 |
| ActiveTime | String | 激活时间 示例值：1680019225 |
| Description | String | 厂商备注 示例值：this is descript |
| DeviceId | String | 设备id 示例值：mna-dev1 |
| LicenseChargingMode | Integer | license计费模式： 1，租户月付费 2，厂商月付费 3，license永久授权 注：设备为租户付费且未激活（未选择月付还是永久付费）时，此参数返回1，仅代表租户付费。后续将废弃此参数，新接入请使用LicensePayMode和Payer 示例值：1 |
| LastOnlineTime | String | 最后在线时间 示例值：1680019225 |
| LicensePayMode | Integer | license授权有效期 0：月度授权 1：永久授权 -1：未知 示例值：0 |
| Payer | Integer | 付费方 0：客户付费 1：厂商付费 示例值：0 |
