調用DescribeUsageOverallData獲取用量統計的概覽數據。

使用說明

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

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

QPS限制

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

調試

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

請求頭

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

請求語法

POST /api/usage/describeUsageOverallData HTTP/1.1

請求參數

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

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

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

查詢的指標類型，多個用英文逗號（,）分隔。取值：

  • 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：累計進出人次。
AppId String Query 是 0rbd****

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

返回數據

名稱 類型 示例值 描述
UsageOverallData Array of MetricDataItem

用量的概覽數據列表。
Type String VIDEO_CALL_DURATION

查詢的指標類型。
Nodes Array of Nodes

指標趨勢圖坐標點列表。
X String 1620144000

指標趨勢圖中x軸橫坐標。
Y String 64

指標趨勢圖中y軸縱坐標。
RequestId String 51E9F79B-A198-43F0-8E24-1322FAB1E244

請求ID。

示例

請求示例

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

正常返回示例

XML格式 

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

<DescribeUsageOverallDataResponse>
    <code>200</code>
    <data>
        <RequestId>51E9F79B-A198-43F0-8E24-1322FAB1E244</RequestId>
        <UsageOverallData>
            <Type>VIDEO_CALL_DURATION</Type>
            <Nodes>
                <X>1620144000</X>
                <Y>64</Y>
            </Nodes>
        </UsageOverallData>
        <UsageOverallData>
            <Type>TOTAL_CALL_DURATION</Type>
            <Nodes>
                <X>1620144000</X>
                <Y>64</Y>
            </Nodes>
        </UsageOverallData>
    </data>
    <httpStatusCode>200</httpStatusCode>
    <requestId>51E9F79B-A198-43F0-8E24-1322FAB1E244</requestId>
    <successResponse>true</successResponse>
</DescribeUsageOverallDataResponse>

JSON格式 

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

{
  "code" : "200",
  "data" : {
    "RequestId" : "51E9F79B-A198-43F0-8E24-1322FAB1E244",
    "UsageOverallData" : [ {
      "Type" : "VIDEO_CALL_DURATION",
      "Nodes" : [ {
        "X" : "1620144000",
        "Y" : "64"
      } ]
    }, {
      "Type" : "TOTAL_CALL_DURATION",
      "Nodes" : [ {
        "X" : "1620144000",
        "Y" : "64"
      } ]
    } ]
  },
  "httpStatusCode" : "200",
  "requestId" : "51E9F79B-A198-43F0-8E24-1322FAB1E244",
  "successResponse" : true
}