DescribeUsageDistributionStatData - 获取用量统计的分布数据

本接口用于获取用量统计的分布数据。

接口说明

使用说明

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

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

QPS 限制

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rtc:DescribeUsageDistributionStatData
  • 全部资源
    *

请求参数

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

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

1615824000
EndDatelong

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

1615910399
StatDimstring

统计维度。取值:

  • CHANNEL_ONLINE:按照频道在线人数统计。
  • NETWORK:按照网络类型统计。
  • OS:按照系统类型统计。
CHANNEL_ONLINE
AppIdstring

APP ID。

0rbd****

返回参数

名称类型描述示例值
object
UsageStatListarray<object>

用量统计数据列表。

UsageStatDataobject
Namestring

统计维度。取值:

  • 当 StatDim 为 CHANNEL_ONLINE 时,取值:ONE_TO_FIVE(1~5 人)、SIX_TO_TEN(6~10 人)、ELEVEN_TO_TWENTY(11~20 人)、TWENTY_ONE_TO_FIFTY(21~50 人)、ABOVE_FIFTY(50 人以上)。
  • 当 StatDim 为 NETWORK 时,取值:WiFi4G 等。
  • 当 StatDim 为 OS 时,取值:iOSAndroid 等。
ONE_TO_FIVE
AudioCallDurationlong

音频通话时长,单位分钟。

51
VideoCallDurationlong

视频通话时长,单位分钟。

10585
TotalCallDurationlong

总通话时长,单位分钟。

10636
CallDurationRatiostring

通话时长占比,四位小数表示,如 0.9782。

0.9782
RequestIdstring

请求 ID。

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

示例

正常返回示例

JSON格式

{
  "UsageStatList": [
    {
      "Name": "ONE_TO_FIVE",
      "AudioCallDuration": 51,
      "VideoCallDuration": 10585,
      "TotalCallDuration": 10636,
      "CallDurationRatio": "0.9782"
    }
  ],
  "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.服务器内部错误

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