1. 接口描述
接口请求域名: rum.tencentcloudapi.com 。
获取TDEM字段值列表
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeFieldValues。 |
| Version | 是 | String | 公共参数,本接口取值:2021-06-22。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| AppId | 是 | String | 应用id 示例值:146662 |
| StartTime | 是 | Integer | 开始时间 单位:毫秒 示例值:123 |
| EndTime | 是 | Integer | 结束时间 单位:毫秒 示例值:3545 |
| FieldName | 是 | String | 字段名 示例值:app_version |
| Limit | 否 | Integer | 数量限制 示例值:20 |
| Filters | 否 | String | 过滤条件 示例值:[{"Key":"country","Op":"in","Values":["中国"]}] |
| Category | 否 | String | 事件分类 示例值:session |
| Prefix | 否 | String | 可选。按前缀过滤字段去重结果。查询 user_id 或 device_id 且开启 StrictPiiPrefix 时必填,去除首尾空格后长度须不少于 2。 示例值:us |
| StrictPiiPrefix | 否 | Boolean | 用于采样配置,是否对 user_id、device_id 强制前缀匹配。为 true 时必须同时传入合法 Prefix,否则返回 InvalidParameter,且不会返回无前缀的全量去重列表。为 false 或不传时,按字段返回热门去重值,行为与历史接口一致。 默认值:false 示例值:false |
| Scope | 否 | String | 查询口径。可选。只允许空或 event。Issue 标签分布传 event。为 event 时不能同时传 HasError、MinDuration、MaxDuration,也不能把 Category 设为 session。 示例值:event |
| HasError | 否 | Boolean | 是否只看有错误的会话。可选。不传表示不过滤。Scope 为 event 时不能传。 示例值:false |
| MinDuration | 否 | Integer | 会话最短时长,单位毫秒。可选。0 或不传表示不限制。Scope 为 event 时不能传。 示例值:1000 |
| MaxDuration | 否 | Integer | 会话最长时长,单位毫秒。可选。0 或不传表示不限制。Scope 为 event 时不能传。 示例值:60000 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | String | 返回结果 示例值:{"Total":0,"Values":[]} |
| ErrorMsg | String | 错误信息 示例值:{"Code":"InvalidParameter","Message":"不支持的字段: page_url"} |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 DescribeFieldValues示例
输入示例
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeFieldValues
<公共请求参数>
{
"AppId": "146662",
"StartTime": 123,
"EndTime": 3545,
"FieldName": "app_version",
"Limit": 20
}
输出示例
{
"Response": {
"Result": "{\"Total\":0,\"Values\":[]}",
"RequestId": "5493d519-23b0-4c53-bf70-43404dc71b8d"
}
}
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 | 操作不支持。 |