帮你快速理解、总结文档立即下载

修改 Web 规则化采样配置

最近更新时间:2026-10-23 21:25:21
我的收藏

1. 接口描述

接口请求域名: rum.tencentcloudapi.com 。

整页保存 Web 规则化采样文档:校验 → INSERT 快照 → UPSERT 当前行 → 刷新 Redis 下发缓存。不写 tdem_sample_rate。采样率 0–100、最多两位小数;规则 Conditions 不可为空;Types 含非闭集 key 返回 InvalidParameter。校验失败不写库。无 Restore/Import/Export/Diff。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:ModifyTDEMSampleConfig。
Version 是 String 公共参数,本接口取值:2021-06-22。
Region 否 String 公共参数,此参数为可选参数。
AppId 是 String

应用ID


示例值:10
Event 是 String

事件采样配置 JSON 字符串。反序列化后:{"Enabled":bool,"Types":{<event_type>:{"SampleRate":0-100最多两位小数,"Rules":[{"Name":string,"Enabled":bool,"SampleRate":0-100,"Conditions":[{"Field":string,"Operator":string,"Value":string或string[]}]}]}}}。Types 可只含改过的 type;未出现的 type 服务端视为 100% + 空规则。Types key 闭集:js_error,promise_error,resource_error,api_error,blank_screen,no_response,page_load,web_vitals,lag_detected,memory_usage,memory_oom,resource_load,api_call,sse_call,click,page_view,tab_hidden,tab_visible,form_focus,form_blur,form_change,form_submit,form_submit_result,struggle,custom,log(不含 rage_click/lcp)。Operator 白名单:equals,not_equals,contains,not_contains,in,not_in,starts_with,ends_with。规则 Conditions 至少 1 条;in/not_in 的 Value 为字符串数组。


示例值:{"Enabled":true,"Types":{}}
Replay 是 String

回放采样配置 JSON 字符串。反序列化后:{"Enabled":bool,"ExperienceSampleRate":0-100最多两位小数,"ErrorTraceback":bool,"ErrorSampleRate":0-100最多两位小数}。控制台/远程字段名为 ExperienceSampleRate(非 SessionSampleRate)。


示例值:{"Enabled":false,"ExperienceSampleRate":0,"ErrorTraceback":false,"ErrorSampleRate":100}

3. 输出参数

参数名称 类型 描述
Result String

业务数据 JSON 字符串,反序列化后:{ProjectId,Event,Replay,SnapshotId,UpdatedAt}。SnapshotId 为本次写入的快照主键。


示例值:{"AppId":"10","Event":{"Enabled":true,"Types":{}},"Replay":{"Enabled":false,"ExperienceSampleRate":0,"ErrorTraceback":false,"ErrorSampleRate":100},"UpdatedAt":"2026-10-14T16:39:21.436+08:00"}
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 测试1

输入示例

POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyTDEMSampleConfig
<公共请求参数>

{
    "AppId": "10",
    "Event": "{\"Enabled\":true,\"Types\":{}}",
    "Replay": "{\"Enabled\":false,\"ExperienceSampleRate\":0,\"ErrorTraceback\":false,\"ErrorSampleRate\":100}"
}

输出示例

{
    "Response": {
        "Result": "{\"AppId\":\"10\",\"Event\":{\"Enabled\":true,\"Types\":{}},\"Replay\":{\"Enabled\":false,\"ExperienceSampleRate\":0,\"ErrorTraceback\":false,\"ErrorSampleRate\":100},\"UpdatedAt\":\"2026-10-14T16:39:21.436+08:00\"}",
        "RequestId": "464ed07f-7ebc-409a-896c-ab04b3a12df8"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。

错误码 描述
AuthFailure CAM签名/鉴权错误。
AuthFailure.UnauthorizedOperation 请求未CAM授权
FailedOperation 操作失败。
FailedOperation.DataBaseException 数据操作异常
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterCombination 无效参数组合
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
RequestLimitExceeded 请求的次数超过了频率限制。
ResourceNotFound 资源不存在。
UnauthorizedOperation 未授权操作。
UnknownParameter 未知参数错误。