1. 接口描述
接口请求域名: rum.tencentcloudapi.com 。
从对象存储读取录屏帧数据
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeReplayData。 |
| Version | 是 | String | 公共参数,本接口取值:2021-06-22。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| AppId | 是 | String | 应用id 示例值:1****2 |
| ReplayId | 是 | String | 回放id 示例值:cd745a80dc454d1ea5f482758c36ca30 |
| SessionId | 否 | String | session id 示例值:427f1ec920614e579aafc99f726af883 |
| SegmentId | 否 | Integer | segment id 示例值:0 |
| MaxDecodedBytes | 否 | Integer | 单个录制分片解压后的最大允许字节数 取值范围:[1, 8388608] 单位:字节(Byte) 示例值:8388608 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | String | 返回结果 示例值:{"Events":[{"data":{":1080,"href":"https://app.example.com/user/profile","timestamp":1776651631942,"type":2}],"Platform":"web","ReplayFormat":"rrweb","ReplayId":"cd745a80dc454d1ea5f482758c36ca30","SegmentId":0} |
| ErrorMsg | String | 错误信息 示例值:{"Code":"UnauthorizedOperation","Message":"project doesn't belong to this user"} |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 DescribeReplayData示例
输入示例
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeReplayData
<公共请求参数>
{
"AppId": "1****2",
"ReplayId": "cd745a80dc454d1ea5f482758c36ca30",
"SessionId": "427f1ec920614e579aafc99f726af883",
"SegmentId": 0
}
输出示例
{
"Response": {
"Result": "{\"Events\":[{\"data\":{\"height\":1080,\"href\":\"https://app.example.com/user/profile\",\"width\":1920},\"timestamp\":1776651631842,\"type\":4},{\"data\":{\"node\":{\"childNodes\":[{\"name\":\"html\",\"publicId\":\"\",\"systemId\":\"\",\"type\":1},{\"attributes\":{\"lang\":\"zh-CN\"},\"childNodes\":[{\"attributes\":{},\"childNodes\":[],\"id\":3,\"tagName\":\"head\",\"type\":2},{\"attributes\":{},\"childNodes\":[{\"attributes\":{\"id\":\"app\"},\"childNodes\":[{\"id\":6,\"textContent\":\"TDEM-cont_**_00828\",\"type\":3}],\"id\":5,\"tagName\":\"div\",\"type\":2}],\"id\":4,\"tagName\":\"body\",\"type\":2}],\"id\":2,\"tagName\":\"html\",\"type\":2}],\"id\":1,\"type\":0}},\"timestamp\":1776651631942,\"type\":2}],\"Platform\":\"web\",\"ReplayFormat\":\"rrweb\",\"ReplayId\":\"cd745a80dc454d1ea5f482758c36ca30\",\"SegmentId\":0}",
"RequestId": "1c48154d-15a6-42af-99c4-5f9cb563f184"
}
}
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 | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded | 超过配额限制。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| RegionError | 地域错误 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| ResourceInUse | 资源被占用。 |
| ResourceInsufficient | 资源不足。 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.NoInstance | 实例不存在 |
| ResourceUnavailable | 资源不可用。 |
| ResourcesSoldOut | 资源售罄。 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |