本接口用于獲取用量統(tǒng)計的概覽數(shù)據(jù)。
接口說明
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下：
- 操作：是指具體的權(quán)限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| rtc:DescribeUsageOverallData | *全部資源 * |
| 無 |
請求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| StartDate | long | 是 | 查詢的開始時間，使用 UNIX 時間戳表示，單位：秒。 | 1615824000 |
| EndDate | long | 是 | 查詢的結(jié)束時間，使用 UNIX 時間戳表示，單位：秒。 | 1615910399 |
| Types | string | 是 | 查詢的指標類型，多個用英文逗號（,）分隔。取值：
| ONLINE_USER_PEAK |
| AppId | string | 是 | APP ID。 | a2hz**** |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"UsageOverallData": [
{
"Type": "ONLINE_USER_PEAK",
"Nodes": [
{
"X": "1615824000",
"Y": "1"
}
]
}
],
"RequestId": "231470C1-ACFB-4C9F-844F-4CFE1E3804C5"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | ApiParamError | API %s. | Api參數(shù)錯誤 |
| 403 | BizAppError | A business application permission error occurred. | 業(yè)務(wù)應(yīng)用權(quán)限錯誤 |
| 403 | BizUidError | A business UID error occurred. | 業(yè)務(wù)主賬號錯誤 |
| 500 | ServerInternalError | An internal error occurred. | 服務(wù)器內(nèi)部錯誤 |
訪問錯誤中心查看更多錯誤碼。