本接口用于獲取端對端指標數據。
接口說明
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| rtc:DescribeEndPointMetricData | get | *全部資源 * |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| AppId | string | 是 | APP ID。 | testappid |
| ChannelId | string | 是 | 頻道 ID | testid |
| CreatedTs | long | 是 | 查詢時間區間的開始時間，該時間不得早于頻道實際的創建時間，不得早于 30 天之前。使用 UNIX 時間戳表示，單位：秒。 | 1614936817 |
| DestroyedTs | long | 否 | 查詢時間區間的結束時間，該時間不得晚于頻道釋放時間。使用 UNIX 時間戳表示，單位：秒。參數為空，表示獲取當前時間。 說明
如果傳入的結束時間超過頻道的釋放時間，將返回從開始時間開始到頻道釋放時間之間的數據，且最多返回最近 3 個小時的數據。
| 1614936817 |
| SubUserId | string | 否 | 訂閱端用戶 ID。 | testuserid |
| PubUserId | string | 否 | 發布端用戶 ID。 說明
PubUserId 和 PubCallIdList 參數只能二選一輸入。
| testuserid2 |
| PubCallIdList | string | 否 | 發布端用戶通信流的 Call ID，多個用英文逗號（,）分隔。 說明
PubUserId 和 PubCallIdList 參數只能二選一輸入。
| testcall1,testcall2 |
| Metrics | string | 是 | 指標枚舉列表，多個用英文逗號（,）分隔。 | VIDEO_STUCK_CAMERA |
指標如下所示：
| 名稱 | 說明 |
|---|---|
| APP_CPU | APP 占用 CPU。 |
| SYSTEM_CPU | 系統占用 CPU。 |
| APP_MEMORY | APP 占用內存。 |
| SYSTEM_MEMORY | 系統占用內存。 |
| SYSTEM_TOTAL_MEMORY | 系統總內存。 |
| AUDIO_LOST_RATE | 音頻丟包率。 |
| VIDEO_LOST_RATE | 視頻丟包率。 |
| AUDIO_RTT | 音頻延時。 |
| VIDEO_RTT | 視頻延時。 |
| AUDIO_BIT_RATE | 音頻碼率。 |
| AUDIO_STUCK | 音頻卡頓。 |
| AUDIO_LEVEL | 音量。 |
| VIDEO_BIT_RATE_CAMERA | 攝像頭視頻碼率。 |
| VIDEO_BIT_RATE_SHARE | 視頻碼率（屏幕分享）。 |
| VIDEO_STUCK_CAMERA | 攝像頭視頻卡頓。 |
| VIDEO_STUCK_SHARE | 視頻卡頓（屏幕分享）。 |
| VIDEO_RESOLUTION_CAMERA | 攝像頭視頻分辨率。 |
| VIDEO_RESOLUTION_SHARE | 視頻分辨率（屏幕分享）。 |
| VIDEO_FPS_CAMERA | 攝像頭視頻幀率。 |
| VIDEO_FPS_SHARE | 視頻幀率（屏幕分享）。 |
返回參數
示例
正常返回示例
JSON格式
{
"SubMetrics": [
{
"Type": "VIDEO_STUCK_CAMERA",
"UserId": "testuserid",
"Nodes": [
{
"X": "1548670257",
"Y": "230100",
"Ext": {
"test": "test",
"test2": 1
}
}
]
}
],
"PubMetrics": [
{
"Type": "VIDEO_STUCK_CAMERA",
"UserId": "testuserid",
"Nodes": [
{
"X": "1548670257",
"Y": "230100",
"Ext": {
"test": "test",
"test2": 1
}
}
]
}
],
"RequestId": "231470C1-ACFB-4C9F-844F-4CFE1E3804C5"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | ApiParamError | API %s. | Api參數錯誤 |
| 403 | BizAppError | A business application permission error occurred. | 業務應用權限錯誤 |
| 403 | BizUidError | A business UID error occurred. | 業務主賬號錯誤 |
| 403 | BizCreatedTsError | A business CreatedTs error occurred. | 參數會議創建時間不準確。 |
| 500 | ServerInternalError | An internal error occurred. | 服務器內部錯誤 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-05-09 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |