数据上报接口

开发中

POST

/mldatahub/api/v2/events

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Header 参数

Content-Type

string

必需

请求内容类型，application/json或者application/gzip;utf-8

示例值:

application/json

Authorization

string

用户鉴权

必需

示例值:

Bearer 187fba87-d64f-42e0-8c26-f38aa3af24dd

x-session-id

string

视频会议id

必需

示例值:

187fba87-d64f-42e0-8c26-f38aa3af24dd

x-nonce

string

必需

用于接口重放判断，值为UUIDV4

示例值:

3525e007-3930-4705-b3e5-7cc38fe61816

x-timestamp

string

数据上报时间

必需

示例值:

1590474541

x-os-type

string

必需

操作系统类型，全小写

示例值:

android,ios,ipados,macos,windows,linux

x-platform-type

string

必需

设备平台类型，全小写

示例值:

mobile,pc,pad,board,browser,applet,sip,pstn,h323,mh-cooperation

x-mldatahub-topic

string

可选

数据指定流入的topic

示例值:

video

x-mldatahub-signature

string

可选

MD5签名
盐：32a787de-7003-4eed-bfae-86f728cbf887
body：{"msg":"hello"}
拼接格式：{"msg":"hello"}32a787de-7003-4eed-bfae-86f728cbf887
md5散列后的值： 9b789dfcd97ce2e5363ac782cb0c92e3

示例值:

9b789dfcd97ce2e5363ac782cb0c92e3

x-mldatahub-ver

string

数据版本

可选

示例值:

1.0

Content-Encoding

string

请求内容编码

可选

示例值:

gzip

Body 参数application/json

network_mode

string

联网模式

必需

wifi/4g/5g

os_version

string

操作系统的版本

必需

通过系统API获取的系统版本信息

user_type

integer

用户类型

必需

区分用户类型，属于已注册用户，还是设备用户，或未注册用户
0：未注册用户（未登录的用户）
1：注册用户（采用非设备登录方式登录的用户）
2：设备用户（采用设备登录方式登录的用户）

sdk_version

string

SDK版本号

必需

device_model

string

设备型号

必需

如小米5、华为P30等

device_brand

string

设备品牌

必需

大板端根据设备计费提供的获取品牌方法获取 Android：ro.product.vendor.brand
windows：wmic computersystem的Manufacturer linux：/sys/devices/virtual/dmi/id/sys_vendor

device_name

string

设备名称

必需

如XXX的iphone

device_cpu

string

设备cpu

必需

device_gpu

string

设备gpu

必需

cpu_frequency

number

主频

必需

单位，GHz

memory

integer

内存信息

必需

events

array [object {4}]

必需

device_ts

integer

设备时间

必需

事件触发时设备时间的毫秒时间戳

event_code

string

事件编码

必需

path

string

事件页面路径

必需

用于描述事件在各个应用端的位置

additional

array[string]

事件的业务属性

必需

用于存储业务属性数据如音视频的各类原子指标等 addtitional中各事件对应的业务属性可参考文档：https://www.kdocs.cn/l/ct4Rnf03suwo

示例

{
    "cpu_frequency": 3.191999912261963,
    "device_brand": "gigabyte technology co., ltd.",
    "device_cpu": "Intel(R) Core(TM) i7-8700 CPU @ 3.20GHz",
    "device_gpu": "Intel(R) UHD Graphics 630",
    "device_model": "z370 hd3",
    "device_name": "UNDEFINED",
    "events": [
        {
            "additional": {
                "confNum": "98453164840",
                "nn": "Win_demo_18808888888",
                "sessionId": "60bb7445-8297-45b4-aa4b-f6b9610e1e66",
                "userId": "ef14ec2b-63d2-4012-9027-ef0eb903666f"
            },
            "device_ts": 1663207991452,
            "event_code": "VIDEO_SEND",
            "path": "SDK"
        }
    ],
    "memory": 16255,
    "network_mode": "wired",
    "os_version": "10-Pro-NT10.0.19044",
    "sdk_version": "2.43.0",
    "user_type": 0
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/mldatahub/api/v2/events' \
--header 'Authorization: Bearer 187fba87-d64f-42e0-8c26-f38aa3af24dd' \
--header 'x-session-id: 187fba87-d64f-42e0-8c26-f38aa3af24dd' \
--header 'x-nonce: 3525e007-3930-4705-b3e5-7cc38fe61816' \
--header 'x-timestamp: 1590474541' \
--header 'x-os-type: android,ios,ipados,macos,windows,linux' \
--header 'x-platform-type: mobile,pc,pad,board,browser,applet,sip,pstn,h323,mh-cooperation' \
--header 'x-mldatahub-topic: video' \
--header 'x-mldatahub-signature: 9b789dfcd97ce2e5363ac782cb0c92e3' \
--header 'x-mldatahub-ver: 1.0' \
--header 'Content-Encoding: gzip' \
--header 'Content-Type: application/json' \
--data-raw '{
    "cpu_frequency": 3.191999912261963,
    "device_brand": "gigabyte technology co., ltd.",
    "device_cpu": "Intel(R) Core(TM) i7-8700 CPU @ 3.20GHz",
    "device_gpu": "Intel(R) UHD Graphics 630",
    "device_model": "z370 hd3",
    "device_name": "UNDEFINED",
    "events": [
        {
            "additional": {
                "confNum": "98453164840",
                "nn": "Win_demo_18808888888",
                "sessionId": "60bb7445-8297-45b4-aa4b-f6b9610e1e66",
                "userId": "ef14ec2b-63d2-4012-9027-ef0eb903666f"
            },
            "device_ts": 1663207991452,
            "event_code": "VIDEO_SEND",
            "path": "SDK"
        }
    ],
    "memory": 16255,
    "network_mode": "wired",
    "os_version": "10-Pro-NT10.0.19044",
    "sdk_version": "2.43.0",
    "user_type": 0
}'

返回响应

🟢200成功

application/json

Body

object {0}

示例

{}

校验设备账号或IP是否匹配服务区的区号或IP段规则

filebeat 上报数据接口