1. 接口描述
接口请求域名: rum.tencentcloudapi.com 。
获取问题分布数据
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeIssuesDistribution。 |
| Version | 是 | String | 公共参数,本接口取值:2021-06-22。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou, ap-singapore 。 |
| ProductId | 否 | String | 产品Id 示例值:1025 |
| FormListString | 否 | String | 接口调试专用,当 token 为空时,以这里的 value 作为筛选表单信息 |
| DimType | 否 | String | 分布维度是自定义维度时,填‘user_custom’ 示例值:user_custom |
| Dimension | 否 | String | 维度,e.g. os_version, app_version, model等 示例值:app_version |
| Intervals.N | 否 | Array of Integer | 数字类型字段的区间范围 示例值:[2,6] |
| ParamToken | 否 | String | 提供给前端使用,当填写本字段时,会覆盖 form_list 的值 |
| IssueId | 否 | String | 问题Id 示例值:13ed5*** |
| IssueType | 否 | Integer | 问题类型 示例值:1 |
| ParamLimit | 否 | Integer | 限制返回的个数,默认返回所有值 示例值:10 |
| MapKey | 否 | String | 键 示例值:key1 |
| MapName | 否 | String | 名称 示例值:name1 |
| MetricType | 否 | Integer | 指标类型 示例值:2 |
| PageSize | 否 | Integer | 每页数目 示例值:10 |
| PageNumber | 否 | Integer | 页码 示例值:5 |
| UserCustomKey | 否 | String | 用户自定义维度key 示例值:os_version |
| ExtraData | 否 | String | 拓展字段 示例值:data |
| RequestHeader | 否 | String | 请求头 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | String | 返回值 |
| Code | Integer | 状态码 示例值:200 |
| Message | String | 消息 示例值:success |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 拉取统计分布数据
输入示例
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeIssuesDistribution
<公共请求参数>
{
"ProductId": "5d4fa0e8d8",
"Dimension": "bundle_id",
"IssueType": 1,
"MetricType": 1,
"RequestHeader": "BEGIN{\"X-ProductId\": \"5d4fa0e8d8\"}END"
}
输出示例
{
"Response": {
"Code": 0,
"Data": "{\"base_rsp\":{\"code\":0,\"msg\":\"success\"},\"distributions\":[{\"field\":\"com.example.sdkapp\",\"value\":47,\"device_uv\":0,\"user_uv\":0,\"lag_time_cost_avg\":0,\"lag_time_cost_p50\":0,\"lag_time_cost_p75\":0,\"lag_time_cost_p90\":0,\"lag_time_cost_p99\":0,\"http_succ_rate\":0,\"http_conn_rate\":0,\"http_err_count\":\"0\",\"http_total_cost_p50\":0,\"http_dns_cost_p50\":0,\"http_tcp_cost_p50\":0,\"http_ssl_cost_p50\":0,\"http_req_cost_p50\":0,\"http_wait_cost_p50\":0,\"http_res_cost_p50\":0,\"http_first_package_cost_p50\":0,\"http_req_size_p50\":0,\"http_res_size_p50\":0,\"issue_count\":\"0\",\"lag_report_rate\":0,\"lag_device_rate\":0,\"lag_user_rate\":0},{\"field\":\"com.tencent.bugly\",\"value\":6,\"device_uv\":0,\"user_uv\":0,\"lag_time_cost_avg\":0,\"lag_time_cost_p50\":0,\"lag_time_cost_p75\":0,\"lag_time_cost_p90\":0,\"lag_time_cost_p99\":0,\"http_succ_rate\":0,\"http_conn_rate\":0,\"http_err_count\":\"0\",\"http_total_cost_p50\":0,\"http_dns_cost_p50\":0,\"http_tcp_cost_p50\":0,\"http_ssl_cost_p50\":0,\"http_req_cost_p50\":0,\"http_wait_cost_p50\":0,\"http_res_cost_p50\":0,\"http_first_package_cost_p50\":0,\"http_req_size_p50\":0,\"http_res_size_p50\":0,\"issue_count\":\"0\",\"lag_report_rate\":0,\"lag_device_rate\":0,\"lag_user_rate\":0}],\"valid_reported_count\":\"53\",\"valid_device_uv\":\"4\",\"valid_user_uv\":\"11\"}",
"Message": "",
"RequestId": "c022ad6a-e994-411c-bd4c-40c3b9d1aab8"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |