本接口用于獲取端對端用戶事件列表。
接口說明
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯(lián)操作:是指成功執(zhí)行操作所需要的其他權限。操作者必須同時具備關聯(lián)操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯(lián)操作 |
---|---|---|---|---|
rtc:DescribeEndPointEventList | get | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
AppId | string | 是 | APP ID。 | testappid |
ChannelId | string | 是 | 頻道 ID。 | testid |
CreatedTs | long | 是 | 事件查詢時間區(qū)間的開始時間,該時間不得早于頻道實際的創(chuàng)建時間,不得早于 30 天之前。使用 UNIX 時間戳表示,單位:秒。 | 1614936817 |
DestroyedTs | long | 否 | 事件查詢時間區(qū)間的結束時間,該時間不得晚于頻道釋放時間。使用 UNIX 時間戳表示,單位:秒。參數為空,表示獲取當前時間。 | 1614936817 |
UserIdList | string | 是 | 用戶 ID 列表,多個用英文逗號(,)分隔。 | testuserid1,testuserid2 |
返回參數
示例
正常返回示例
JSON
格式
{
"Nodes": [
{
"UserId": "testuserid",
"EventDataItems": [
{
"Ts": 1614936817,
"EventList": [
{
"EventName": "開始發(fā)布",
"EventType": "USER",
"Ts": 1614936817,
"TsInMs": "1614936817123"
}
]
}
]
}
],
"RequestId": "231470C1-ACFB-4C9F-844F-4CFE1E3804C5"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | ApiParamError | API %s. | Api參數錯誤 |
403 | BizAppError | A business application permission error occurred. | 業(yè)務應用權限錯誤 |
403 | BizUidError | A business UID error occurred. | 業(yè)務主賬號錯誤 |
403 | BizCreatedTsError | A business CreatedTs error occurred. | 參數會議創(chuàng)建時間不準確。 |
500 | ServerInternalError | An internal error occurred. | 服務器內部錯誤 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-05-09 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |