接口列表

本节包含流量数据查询相关接口等。

注:流量相关接口,子账户无权限调用

接口列表如下:

序号 接口功能 描述
1 查询账号下流量消耗汇总 查询账号下流量消耗汇总信息,包括流量总量、剩余总量、日均使用量等
2 查询账户下流量消耗详情 查询账号下流量消耗汇总详情,包括设备数、通道数、流量消耗分类等
3 查询账户下某天流量消耗详情 查询账号下某天流量消耗详情,包括每个设备消耗详情数据等
4 查询指定设备在某一时间段消耗流量数据 查询指定设备在某一时间段消耗流量信息,包括指定设备消耗数据等

查询账号下流量消耗汇总

  • 接口功能

    该接口用于查询账号下流量消耗汇总。

  • 请求地址

    https://open.ys7.com/api/lapp/traffic/user/total

  • 请求方式

    POST

  • 子账户token无权限请求

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
  • HTTP请求报文
POST /api/lapp/traffic/user/total HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p
  • 返回数据
{
    "code": "200",
    "msg": "操作成功",
    "data": {
        "totalFlow": 16565165,
        "usedFlow": 14523,
        "averageConsume": 200
    }
}
  • 返回字段
字段名 类型 描述
totalFlow long 拥有的总流量,单位字节(企业版被赋予带宽能力,不计算该流量)
usedFlow long 已使用的流量,单位字节
averageConsume long 日平均消耗,单位字节/天
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken过期或异常
10005 appKey异常 appKey被冻结
10017 appKey不存在 确认appKey是否正确
49999 数据异常 接口调用异常

查询账户下流量消耗详情

  • 接口功能

    该接口用于查询账户下流量消耗详情,默认只能查询前一天以前的数据。

  • 请求地址

    https://open.ys7.com/api/lapp/traffic/user/detail

  • 请求方式

    POST

  • 子账户token无权限请求

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
startTime long 开始时间,时间格式为1457420564508,精确到毫秒,默认为当前日期往前推算1周。最多只能查询当前日期往前1周内的数据 N
endTime long 结束时间,时间格式为1457420564508,精确到毫秒,默认为当前日期往前推算1天。只能查询1天前的数据 N
pageStart int 分页起始页,从0开始,默认为0 N
pageSize int 分页大小,默认为10,最大为50 N
  • HTTP请求报文
POST /api/lapp/traffic/user/detail HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&startTime=1495209600000&endTime=1494604800000&pageStart=0&pageSize=2
  • 返回数据
{
    "data": [
        {
            "flowDate": 1495209600000,
            "deviceCount": 1,
            "channelCount": 1,
            "hlsFlow": 11566,
            "appFlow": 5566,
            "rtmpFlow": 2234,
            "flowCount": 19366
        },
        {
            "flowDate": 1495123200000,
            "deviceCount": 1,
            "channelCount": 1,
            "hlsFlow": 6566,
            "appFlow": 546,
            "rtmpFlow": 1234,
            "flowCount": 8346
        }
    ],
    "code": "200",
    "msg": "操作成功!"
}
  • 返回字段
字段名 类型 描述
flowDate long 日期
deviceCount int 当日消耗流量设备数
channelCount int 当日消耗流量通道数
hlsFlow long 轻应用HLS地址预览消耗,单位字节
appFlow long APP应用预览消耗,单位字节
rtmpFlow long 轻应用RTMP地址预览消耗,单位字节
flowCount long 流量消耗汇总,单位字节
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken过期或异常
10005 appKey异常 appKey被冻结
10017 appKey不存在 确认appKey是否正确
49999 数据异常 接口调用异常

查询账户下某天流量消耗详情

  • 接口功能

    该接口用于查询账户下某天流量消耗详情。

  • 请求地址

    https://open.ys7.com/api/lapp/traffic/day/detail

  • 请求方式

    POST

  • 子账户token无权限请求

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
flowTime long 日期,时间格式为1457420564508,精确到毫秒,默认为当前日期往前1天。只能查询当前日期往前推算7天内、1天前的数据 N
pageStart int 分页起始页,从0开始,默认为0 N
pageSize int 分页大小,默认为10,最大为50 N
  • HTTP请求报文
POST /api/lapp/traffic/day/detail HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&flowTime=1495209600000&pageStart=0&pageSize=2
  • 返回数据
{
    "data": [
        {
            "flowDate": 1495209600000,
            "deviceSerial": "427734222",
            "channelNo": 1,
            "hlsFlow": 11566,
            "appFlow": 5566,
            "rtmpFlow": 2234,
            "flowCount": 19366
        },
        {
            "flowDate": 1495209600000,
            "deviceSerial": "427734333",
            "channelNo": 3,
            "hlsFlow": 11566,
            "appFlow": 5566,
            "rtmpFlow": 2234,
            "flowCount": 19366
        }
    ],
    "code": "200",
    "msg": "操作成功!"
}
  • 返回字段
字段名 类型 描述
flowDate long 日期
deviceSerial S 设备序列号
channelNo int 通道号
hlsFlow long 轻应用HLS地址预览消耗,单位字节
appFlow long APP应用预览消耗,单位字节
rtmpFlow long 轻应用RTMP地址预览消耗,单位字节
flowCount long 流量消耗汇总,单位字节
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken过期或异常
10005 appKey异常 appKey被冻结
10017 appKey不存在 确认appKey是否正确
49999 数据异常 接口调用异常

查询指定设备在某一时间段消耗流量数据

  • 接口功能

    该接口用于查询指定设备在某一时间段消耗流量数据。

  • 请求地址

    https://open.ys7.com/api/lapp/traffic/device/detail

  • 请求方式

    POST

  • 子账户token无权限请求

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String Y
startTime long 开始时间,时间格式为1457420564508,精确到毫秒,默认为当前日期往前推算1周。最多只能查询当前日期往前1周内的数据 N
endTime long 结束时间,时间格式为1457420564508,精确到毫秒,默认为当前日期往前推算1天。只能查询1天前的数据 N
pageStart int 分页起始页,从0开始,默认为0 N
pageSize int 分页大小,默认为10,最大为50 N
  • HTTP请求报文
POST /api/lapp/traffic/device/detail HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&deviceSerial=427734333&startTime=1495209600000&endTime=1494604800000&pageStart=0&pageSize=2
  • 返回数据
{
    "data": [
        {
            "flowDate": 1495209600000,
            "deviceSerial": "427734333",
            "channelNo": 1,
            "hlsFlow": 11566,
            "appFlow": 5566,
            "rtmpFlow": 2234,
            "flowCount": 19366
        },
        {
            "flowDate": 1495209600000,
            "deviceSerial": "427734333",
            "channelNo": 3,
            "hlsFlow": 11566,
            "appFlow": 5566,
            "rtmpFlow": 2234,
            "flowCount": 19366
        }
    ],
    "code": "200",
    "msg": "操作成功!"
}
  • 返回字段
字段名 类型 描述
flowDate long 日期
deviceSerial int 设备序列号
channelNo int 通道号
hlsFlow long 轻应用HLS地址预览消耗,单位字节
appFlow long APP应用预览消耗,单位字节
rtmpFlow long 轻应用RTMP地址预览消耗,单位字节
flowCount long 流量消耗汇总,单位字节
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken过期或异常
10005 appKey异常 appKey被冻结
10017 appKey不存在 确认appKey是否正确
49999 数据异常 接口调用异常

results matching ""

    No results matching ""