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

查询问题受影响用户清单

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

1. 接口描述

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

按用户维度聚合某问题的受影响用户清单,服务端分页。AppId 与 IssueId 必填;AppVersion / StartTime / EndTime / Keyword 用于收窄范围,同时作用于清单与 Total,因此 Total 为当前条件下去重后的用户数, 条件全空时等于问题详情的影响用户数。OrderKey / OrderBy 只改变行序、不改变结果集合;排序一律由服务端执行, 并保留 uid 作为次级键以保证翻页不重不漏。接口只读。

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

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

2. 输入参数

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

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

应用 ID(string,必填)。空 → InvalidParameter


示例值:sGPZPBrHhKxe
IssueId 是 String

问题 ID(string,必填)。空 → InvalidParameter


示例值:9fd1ac8fd9b45044
Page 否 Integer

页码(整数,选填)。< 1 钳制为 1;缺省 1


示例值:1
PageSize 否 Integer

每页条数(整数,选填)。< 1 或 > 1000 回落默认 20;导出场景按 1000 一批拉全量


示例值:20
AppVersion 否 String

应用版本(string,选填)。按 app_version 精确匹配;空表示不限版本


示例值:1.1.2
StartTime 否 Integer

起始毫秒时间戳(整数,选填)。<= 0 表示该侧不限


示例值:1791820800000
EndTime 否 Integer

结束毫秒时间戳(整数,选填)。<= 0 表示该侧不限;与 StartTime 同时给出且 StartTime > EndTime → InvalidParameter


示例值:1792425599999
Keyword 否 String

身份值关键字(string,选填)。不区分大小写的子串匹配,命中 if(user_id='', session_id, user_id);空表示不限


示例值:tdem_test
OrderKey 否 String

排序字段(string,选填)。可选 last_seen / first_seen / event_count;缺省 last_seen;其它值 → InvalidParameter


示例值:last_seen
OrderBy 否 String

排序方向(string,选填)。可选 asc / desc;缺省 desc;其它值 → InvalidParameter


示例值:desc

3. 输出参数

参数名称 类型 描述
Result String

业务数据 JSON 字符串,反序列化后:{Users,Total,Page,PageSize}。 Users[] 含 UserId(身份值)、HasUin(是否来自 user_id)、EventCount、FirstSeen / LastSeen(毫秒时间戳)。


示例值:{"Data":{"Users":[],"Total":0,"Page":1,"PageSize":20}}
ErrorMsg String

错误信息(成功时为空)


示例值:{ "Response": { "Error": { "Code": "InvalidParameter", "Message": "无效的时间范围" }, "RequestId": "352070f6-d749-4bde-8f30-f62318725803" } }
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 test

输入示例

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

{
    "AppId": "sGPZPBrHhKxe",
    "IssueId": "9fd1ac8fd9b45044",
    "Page": 1,
    "PageSize": 20,
    "AppVersion": "",
    "Keyword": "",
    "OrderKey": "last_seen",
    "StartTime": 1791820800000,
    "EndTime": 1792425599999,
    "OrderBy": "desc"
}

输出示例

{
    "Response": {
        "Result": "{\"Data\":{\"Users\":[],\"Total\":0,\"Page\":1,\"PageSize\":20}}",
        "RequestId": "f1cb7fcf-a0ac-4805-af51-881b5190e9e1"
    }
}

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签名/鉴权错误。
FailedOperation 操作失败。
FailedOperation.DataBaseException 数据操作异常
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
RequestLimitExceeded 请求的次数超过了频率限制。
ResourceNotFound 资源不存在。
UnauthorizedOperation 未授权操作。
UnknownParameter 未知参数错误。