1. 接口描述
接口请求域名: rum.tencentcloudapi.com 。
根据条件获取指定 Issue 的错误事件列表,支持按时间范围、关键字和扩展过滤器查询,返回分页事件数据
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeIssueEvents。 |
| Version | 是 | String | 公共参数,本接口取值:2021-06-22。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| AppId | 是 | String | 应用 ID 示例值:146692 |
| IssueId | 是 | String | Issue ID 示例值:ca5ac1fb1f4d2993581ea232a73d4575e69579f254f110460c544117ae275fd9 |
| StartTime | 是 | Integer | 开始时间,Unix 毫秒时间戳 示例值:1781420460000 |
| EndTime | 是 | Integer | 结束时间,Unix 毫秒时间戳 示例值:1781689660000 |
| Keyword | 否 | String | 事件关键字过滤 示例值:这是 |
| Filters | 否 | String | 扩展过滤器 JSON 字符串;白名单字段包括 app_version、country、province、city、device_type、browser、os、isp、referrer、user_type、platform、normalized_page_url、event_type、issue_id、environment、process_type 示例值:[{"Key":"app_version","Op":"eq","Values":"2.0.4"}] |
| Page | 否 | Integer | 页码,默认 1 示例值:1 |
| PageSize | 否 | Integer | 分页大小,默认 20,范围 1~100 示例值:20 |
| SortOrder | 否 | String | 排序方向,可选值:asc、desc 示例值:asc |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | String | 业务结果 JSON 字符串;前端会再做一次 JSON 解析。Result 内业务 JSON 为 Data,内容是 total + items 示例值:{"Data":{"total":0,"items":[]}} |
| ErrorMsg | String | 错误信息;正常返回时为空 示例值:{"Code":"InvalidParameter","Message":"Filters JSON 解析失败: json: cannot unmarshal string into Go struct field CAPIFilter.Values of type []string"} |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例
输入示例
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeIssueEvents
<公共请求参数>
{
"AppId": "146692",
"IssueId": "ca5ac1fb1f4d2993581ea232a73d4575e69579f254f110460c544117ae275fd9",
"StartTime": 1781420460000,
"EndTime": 1781689660000,
"Keyword": "这是",
"Filters": "[{\"Key\":\"app_version\",\"Op\":\"eq\",\"Values\":\"2.0.4\"}]",
"Page": 1,
"PageSize": 20
}
输出示例
{
"Response": {
"ErrorMsg": "{\"Code\":\"InvalidParameter\",\"Message\":\"Filters JSON 解析失败: json: cannot unmarshal string into Go struct field CAPIFilter.Values of type []string\"}",
"RequestId": "af852781-2f64-4cde-bb80-919c5df34531"
}
}
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授权 |
| DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
| FailedOperation | 操作失败。 |
| FailedOperation.ChargeNoBalance | 计费相关 - 账户余额不足。 |
| FailedOperation.ChargeNoPayRight | 计费相关 - 账户没有付费权限。 |
| FailedOperation.ChargeParamInvalid | 计费相关 - 计费参数无效。 |
| FailedOperation.ClsCallFail | CLS调用失败 |
| FailedOperation.DataBaseException | 数据操作异常 |
| FailedOperation.InfrastructureError | 第三方依赖异常。 |
| InternalError | 内部错误。 |
| InvalidFilter | 无效的过滤器 |
| InvalidParameter | 参数错误。 |
| InvalidParameterCombination | 无效参数组合 |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded | 超过配额限制。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| RegionError | 地域错误 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| ResourceInUse | 资源被占用。 |
| ResourceInsufficient | 资源不足。 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.NoInstance | 实例不存在 |
| ResourceUnavailable | 资源不可用。 |
| ResourcesSoldOut | 资源售罄。 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |