調用DescribeUsageDistributionStatData獲取用量統計的分布數據。

使用說明

本接口用于獲取用量統計的分布數據。使用該接口時，限制如下：

  • 支持查詢最近365天（不包含查詢當天）任意范圍的數據。
  • 如果查詢范圍小于24小時，則按小時統計查詢的數據；如果查詢范圍大于或等于24小時，則按天統計查詢的數據。

QPS限制

本接口的單用戶QPS限制為10次/秒。超過限制，API調用會被限流，這可能會影響您的業務，請合理調用。更多信息，請參見QPS限制。

調試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求頭

該接口使用公共請求頭，無特殊請求頭。請參見公共請求參數文檔。

請求語法

POST /api/usage/describeUsageDistributionStatData HTTP/1.1

請求參數

名稱 類型 位置 是否必選 示例值 描述
StartDate Long Query 是 1615824000

查詢的開始時間，使用UNIX時間戳表示，單位：秒。
EndDate Long Query 是 1615910399

查詢的結束時間，使用UNIX時間戳表示，單位：秒。
StatDim String Query 是 CHANNEL_ONLINE

統計維度，取值：

  • CHANNEL_ONLINE：按照頻道在線人數統計。
  • NETWORK：按照網絡類型統計。
  • OS：按照系統類型統計。
AppId String Query 是 0rbd****

App ID，可通過控制臺創建和查詢。

返回數據

名稱 類型 示例值 描述
UsageStatList Array of UsageStatData

用量統計數據列表。
Name String ONE_TO_FIVE

統計維度，取值：

  • 當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時，取值：WiFi、4G等。
  • 當StatDim為OS時，取值：iOS、Android等。
AudioCallDuration Long 408

音頻通話時長，單位：分鐘。
VideoCallDuration Long 45556

視頻通話時長，單位：分鐘。
TotalCallDuration Long 45964

總通話時長，單位：分鐘。
CallDurationRatio String 0.9782

通話時長占比，用四位小數表示，例如1.0000表示通話時長占比為100%。
RequestId String AAF6805E-D9DF-43E4-B94A-396A7EF69A0A

請求ID。

示例

請求示例

POST /api/usage/describeUsageDistributionStatData?StartDate=1615824000&EndDate=1615910399&StatDim=CHANNEL_ONLINE&AppId=0rbd**** HTTP/1.1
Host: vdc.cn-shenzhen.aliyuncs.com 
Date: GMT Date

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeUsageDistributionStatDataResponse>
    <code>200</code>
    <data>
        <UsageStatList>
            <AudioCallDuration>408</AudioCallDuration>
            <TotalCallDuration>45964</TotalCallDuration>
            <CallDurationRatio>0.9782</CallDurationRatio>
            <VideoCallDuration>45556</VideoCallDuration>
            <Name>ONE_TO_FIVE</Name>
        </UsageStatList>
        <UsageStatList>
            <AudioCallDuration>0</AudioCallDuration>
            <TotalCallDuration>1025</TotalCallDuration>
            <CallDurationRatio>0.0218</CallDurationRatio>
            <VideoCallDuration>1025</VideoCallDuration>
            <Name>SIX_TO_TEN</Name>
        </UsageStatList>
        <RequestId>AAF6805E-D9DF-43E4-B94A-396A7EF69A0A</RequestId>
    </data>
    <httpStatusCode>200</httpStatusCode>
    <requestId>AAF6805E-D9DF-43E4-B94A-396A7EF69A0A</requestId>
    <successResponse>true</successResponse>
</DescribeUsageDistributionStatDataResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "code" : "200",
  "data" : {
    "UsageStatList" : [ {
      "AudioCallDuration" : 408,
      "TotalCallDuration" : 45964,
      "CallDurationRatio" : "0.9782",
      "VideoCallDuration" : 45556,
      "Name" : "ONE_TO_FIVE"
    }, {
      "AudioCallDuration" : 0,
      "TotalCallDuration" : 1025,
      "CallDurationRatio" : "0.0218",
      "VideoCallDuration" : 1025,
      "Name" : "SIX_TO_TEN"
    } ],
    "RequestId" : "AAF6805E-D9DF-43E4-B94A-396A7EF69A0A"
  },
  "httpStatusCode" : "200",
  "requestId" : "AAF6805E-D9DF-43E4-B94A-396A7EF69A0A",
  "successResponse" : true
}