1. 接口描述
接口请求域名: rum.tencentcloudapi.com 。
数据探索事件明细分页。会话分类不得调用本接口(Category 禁止 session)。时间单位 Unix 毫秒。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeTDEMEventSearch。 |
| Version | 是 | String | 公共参数,本接口取值:2021-06-22。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| AppId | 是 | String | 应用 ID(必填) 示例值:7 |
| StartTime | 是 | Integer | 开始时间 Unix 毫秒(必填) 示例值:1787404860000 |
| EndTime | 是 | Integer | 结束时间 Unix 毫秒(必填) 示例值:1789996860000 |
| Category | 是 | String | 事件分类(必填,禁止 session) 示例值:lag |
| Filters | 否 | String | 筛选条件 JSON 字符串:[{Key,Op,Values}],须在探索白名单 示例值:[{"Key":"http_status","Op":"in","Values":["200","202"]}] |
| SortBy | 否 | String | 排序字段:timestamp(默认)/ duration 示例值:timestamp |
| SortOrder | 否 | String | 排序方向:asc / desc,默认 desc 示例值:desc |
| Page | 否 | Integer | 页码,>=1,默认 1 示例值:1 |
| PageSize | 否 | Integer | 每页条数,1-100,默认 20 示例值:100 |
| HasError | 否 | Boolean | 是否只看有错误的会话。可选。不传表示不过滤。Category 为 session 的汇总查询会使用该条件。 示例值:false |
| MinDuration | 否 | Integer | 会话最短时长,单位毫秒。可选。0 或不传表示不限制。Category 为 session 的汇总查询会使用该条件。 示例值:0 |
| MaxDuration | 否 | Integer | 会话最长时长,单位毫秒。可选。0 或不传表示不限制。Category 为 session 的汇总查询会使用该条件。 示例值:0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Events | Array of ExplorationEventItem | 事件列表 |
| Total | Integer | 总条数 示例值:3410 |
| Page | Integer | 页码 示例值:1 |
| PageSize | Integer | 每页条数 示例值:20 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 搜索事件列表
输入示例
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTDEMEventSearch
<公共请求参数>
{
"AppId": "7",
"StartTime": 1787404860000,
"EndTime": 1789996860000,
"Category": "lag"
}
输出示例
{
"Response": {
"Events": [
{
"AppVersion": "1.0.4",
"Browser": "***%**C**es",
"City": "北京",
"Country": "中国",
"DeviceType": "iPhone18,1",
"EventCategory": "performance",
"EventId": "33C06D53-C870-4276-8942-D8A970D16475",
"EventProperties": [
{
"Key": "app_state",
"Value": "active"
}
],
"EventType": "lag_detected",
"ExceptionStacks": [
{
"MechanismHandled": 1,
"MechanismType": "hybrid_frame_watchdog",
"Type": "MainThreadStall",
"Value": "main_thread_unresponsive"
}
],
"Ip": "223.******.23",
"Isp": "移动/基站WiFi",
"Measurements": [
{
"Key": "cumulative_frame_delay_ms",
"Value": 150.024917
}
],
"NormalizedPageUrl": "launch",
"Os": "iOS",
"PageUrl": "launch",
"Platform": "ios",
"Province": "北京",
"SessionId": "8B771143-FC48-4E11-B3BC-E328A2337CBC",
"Timestamp": 1789636841337,
"UserId": "tdem_test_2ab8d5"
}
],
"Page": 1,
"PageSize": 20,
"Total": 3410,
"RequestId": "c3971020-ac30-49f0-a02c-8942700aaa43"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| AuthFailure.UnauthorizedOperation | 请求未CAM授权 |
| FailedOperation | 操作失败。 |
| FailedOperation.DataBaseException | 数据操作异常 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterCombination | 无效参数组合 |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded | 超过配额限制。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| ResourceInUse | 资源被占用。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable | 资源不可用。 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误。 |