文档

DescribeUsageOverallData - 获取用量统计的概览数据

更新时间:

本接口用于获取用量统计的概览数据。

接口说明

使用说明

本接口用于获取用量统计的概览数据。使用该接口时,限制如下:

  • 支持查询最近 365 天(不包含查询当天)任意范围的数据。
  • 如果查询范围小于 24 小时,则按小时统计查询的数据;如果查询范围大于或等于 24 小时,则按天统计查询的数据。

QPS 限制

本接口的单用户 QPS 限制为 5 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
StartDatelong

查询的开始时间,使用 UNIX 时间戳表示,单位:秒。

1615824000
EndDatelong

查询的结束时间,使用 UNIX 时间戳表示,单位:秒。

1615910399
Typesstring

查询的指标类型,多个用英文逗号(,)分隔。取值:

  • TOTAL_CALL_DURATION:总时长。
  • VIDEO_CALL_DURATION:视频通信时长。
  • AUDIO_CALL_DURATION:音频通信时长。
  • CALL_CHANNEL_COUNT:通信频道数。
  • HIGHLY_CONCURRENT_CHANNEL_COUNT:高并发通信频道数。
  • CHANNEL_CONCURRENT_PEAK:并发频道数峰值。
  • ONLINE_USER_PEAK:在线人数峰值。
  • TOTAL_CALL_USER:累计通话人数。
  • TOTAL_INOUT_NUM:累计进出人次。
ONLINE_USER_PEAK
AppIdstring

APP ID。

a2hz****

返回参数

名称类型描述示例值
object
UsageOverallDataobject []

用量概览数据列表。

Typestring

查询的指标类型。

ONLINE_USER_PEAK
Nodesobject []

指标趋势图坐标点列表。

Xstring

指标趋势图中 x 轴横坐标。

1615824000
Ystring

指标趋势图中 y 轴纵坐标。

1
RequestIdstring

请求 ID。

231470C1-ACFB-4C9F-844F-4CFE1E3804C5

示例

正常返回示例

JSON格式

{
  "UsageOverallData": [
    {
      "Type": "ONLINE_USER_PEAK",
      "Nodes": [
        {
          "X": "1615824000",
          "Y": "1"
        }
      ]
    }
  ],
  "RequestId": "231470C1-ACFB-4C9F-844F-4CFE1E3804C5"
}

错误码

HTTP status code错误码错误信息描述
400ApiParamErrorAPI %s.Api参数错误
403BizAppErrorA business application permission error occurred.业务应用权限错误
403BizUidErrorA business UID error occurred.业务主账号错误
500ServerInternalErrorAn internal error occurred.服务器内部错误

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