本接口用于查詢頻道概覽數(shù)據(jù)。
接口說(shuō)明
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語(yǔ)句的Action
元素中使用,用來(lái)給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說(shuō)明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問(wèn)級(jí)別:是指每個(gè)操作的訪問(wèn)級(jí)別,取值為寫(xiě)入(Write)、讀取(Read)或列出(List)。
- 資源類(lèi)型:是指操作中支持授權(quán)的資源類(lèi)型。具體說(shuō)明如下:
- 對(duì)于必選的資源類(lèi)型,用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問(wèn)級(jí)別 | 資源類(lèi)型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
rtc:DescribeChannelOverallData | *全部資源 * |
| 無(wú) |
請(qǐng)求參數(shù)
名稱 | 類(lèi)型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
AppId | string | 是 | APP ID。 | testappid |
ChannelId | string | 是 | 頻道 ID。 | testid |
CreatedTs | long | 是 | 創(chuàng)建頻道的時(shí)間戳,支持查詢最近 30 天的數(shù)據(jù)。使用 UNIX 時(shí)間戳表示,單位:秒。 | 1615860711 |
DestroyedTs | long | 否 | 頻道釋放時(shí)間,使用 UNIX 時(shí)間戳表示,單位:秒。參數(shù)為空表示獲取當(dāng)前時(shí)間。 說(shuō)明
如果傳入的頻道釋放時(shí)間超過(guò)真實(shí)的釋放時(shí)間,將返回從創(chuàng)建時(shí)間開(kāi)始到真實(shí)釋放時(shí)間之間的數(shù)據(jù)。
| 1615860811 |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"MetricDatas": [
{
"Type": "CALL_QUALITY",
"Nodes": [
{
"X": "1612418625",
"Y": "123",
"Ext": {
"test": "test",
"test2": 1
}
}
]
}
],
"OverallData": {
"ConnAvgTime": 0.5,
"FiveSecJoinRate": 0.91,
"TotalAudioStuckRate": 0.02,
"TotalVideoStuckRate": 0.02,
"TotalVideoVagueRate": 0.02
},
"CallInfo": {
"AppId": "testappid",
"ChannelId": "testid",
"CallStatus": "IN",
"CreatedTs": 1615860711,
"DestroyedTs": 1615860811,
"Duration": 100
},
"RequestId": "231470C1-ACFB-4C9F-844F-4CFE1E3804C5"
}
錯(cuò)誤碼
HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
---|---|---|---|
400 | ApiParamError | API %s. | Api參數(shù)錯(cuò)誤 |
403 | BizCreatedTsError | A business CreatedTs error occurred. | 參數(shù)會(huì)議創(chuàng)建時(shí)間不準(zhǔn)確。 |
403 | BizAppError | A business application permission error occurred. | 業(yè)務(wù)應(yīng)用權(quán)限錯(cuò)誤 |
403 | BizUidError | A business UID error occurred. | 業(yè)務(wù)主賬號(hào)錯(cuò)誤 |
500 | ServerInternalError | An internal error occurred. | 服務(wù)器內(nèi)部錯(cuò)誤 |
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。