1. 接口描述
接口请求域名: rum.tencentcloudapi.com 。
获取 app 监控指标数据
默认接口请求频率限制:50次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeAppMetricsData。 |
Version | 是 | String | 公共参数,本接口取值:2021-06-22。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
ProjectID | 是 | Integer | app 项目ID 示例值:1 |
From | 是 | String | 查询的表名 示例值:kv_7_dist |
Fields | 是 | String | 查询指标 field 示例值:[["as",["if",["equals","launch_cnt",["toInt64",0]],0,[ |
Filter | 是 | String | 查询的过滤条件 示例值:["or",["and",["equals","category","'PERF_CRASH'"],["i |
FilterSimple | 否 | String | 查询简单过滤条件 示例值:{"category__in":["PERF_CRASH","APP_LAUNCH","PERF_MASTER_T |
GroupBy.N | 否 | Array of String | group by 条件 |
OrderBy.N | 否 | Array of String | order by 条件 |
Limit | 否 | Integer | limit 参数 示例值:1 |
Offset | 否 | Integer | offset 参数 示例值:1 |
GroupByModifier | 否 | String | group by 参数 示例值:rollup |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | String | 查询数据返回 示例值:{\n "status": "ok",\n "code": 10000,\n "msg": \ |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询 app 指标数据
输入示例
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAppMetricsData
<公共请求参数>
{
"Filter": "'[\\\"or\\\",[\\\"and\\\",[\\\"equals\\\",\\\"category\\\",\\\"'PERF_CRASH'\\\"],[\\\"in\\\",\\\"d4\\\",[\\\"array\\\",\\\"'Java'\\\",\\\"'Native'\\\",\\\"'normal_crash'\\\",\\\"'no_crash'\\\",\\\"'deadlock'\\\",\\\"'foom'\\\"]],[\\\"in\\\",\\\"sd1\\\",[\\\"array\\\",\\\"'v1'\\\",\\\"'v2'\\\"]]],[\\\"and\\\",[\\\"equals\\\",\\\"category\\\",\\\"'APP_LAUNCH'\\\"],[\\\"greaterOrEquals\\\",\\\"sdk_ver\\\",\\\"'5.2.1'\\\"]],[\\\"and\\\",[\\\"equals\\\",\\\"category\\\",\\\"'PERF_MASTER_TOKEN_FLOW'\\\"],[\\\"less\\\",\\\"sdk_ver\\\",\\\"'5.2.1'\\\"]],[\\\"and\\\",[\\\"equals\\\",\\\"category\\\",\\\"'PERF_MASTER_TOKEN_FLOW'\\\"],[\\\"equals\\\",\\\"sdk_ver\\\",\\\"'unknown'\\\"]]]'",
"ProjectID": 1,
"FilterSimple": "{\"category__in\":[\"PERF_CRASH\",\"APP_LAUNCH\",\"PERF_MASTER_TOKEN_FLOW\"],\"entrance_time__gte\":\"1670939782000\",\"entrance_time__lte\":\"1671026182000\"}",
"From": "'kv_7_dist'",
"Fields": "'[[\\\"as\\\",[\\\"if\\\",[\\\"equals\\\",\\\"launch_cnt\\\",[\\\"toInt64\\\",0]],0,[\\\"div\\\",\\\"crash_cnt\\\",\\\"launch_cnt\\\"]],\\\"crash_rate\\\"],[\\\"as\\\",[\\\"countIf\\\",[\\\"and\\\",[\\\"equals\\\",\\\"category\\\",\\\"'PERF_CRASH'\\\"],[\\\"notEquals\\\",\\\"d4\\\",\\\"'no_crash'\\\"]]],\\\"crash_cnt\\\"],[\\\"as\\\",[\\\"if\\\",[\\\"equals\\\",\\\"launch_cnt\\\",[\\\"toInt64\\\",0]],0,[\\\"div\\\",\\\"crash_user_cnt\\\",\\\"user_cnt\\\"]],\\\"crash_user_rate\\\"],[\\\"as\\\",[\\\"uniq\\\",[\\\"if\\\",[\\\"and\\\",[\\\"equals\\\",\\\"category\\\",\\\"'PERF_CRASH'\\\"],[\\\"notEquals\\\",\\\"d4\\\",\\\"'no_crash'\\\"]],\\\"device_id\\\",\\\"null\\\"]],\\\"crash_user_cnt\\\"],[\\\"as\\\",[\\\"uniq\\\",[\\\"if\\\",[\\\"or\\\",[\\\"and\\\",[\\\"equals\\\",\\\"category\\\",\\\"'APP_LAUNCH'\\\"],[\\\"greaterOrEquals\\\",\\\"sdk_ver\\\",\\\"'5.2.1'\\\"]],[\\\"and\\\",[\\\"equals\\\",\\\"category\\\",\\\"'PERF_MASTER_TOKEN_FLOW'\\\"],[\\\"less\\\",\\\"sdk_ver\\\",\\\"'5.2.1'\\\"]],[\\\"and\\\",[\\\"equals\\\",\\\"d4\\\",\\\"'no_crash'\\\"],[\\\"less\\\",\\\"sdk_ver\\\",\\\"'5.2.1'\\\"]],[\\\"and\\\",[\\\"equals\\\",\\\"category\\\",\\\"'PERF_MASTER_TOKEN_FLOW'\\\"],[\\\"equals\\\",\\\"sdk_ver\\\",\\\"'unknown'\\\"]],[\\\"and\\\",[\\\"equals\\\",\\\"d4\\\",\\\"'no_crash'\\\"],[\\\"equals\\\",\\\"sdk_ver\\\",\\\"'unknown'\\\"]]],\\\"device_id\\\",\\\"null\\\"]],\\\"user_cnt\\\"],[\\\"as\\\",[\\\"countIf\\\",[\\\"or\\\",[\\\"and\\\",[\\\"equals\\\",\\\"category\\\",\\\"'APP_LAUNCH'\\\"],[\\\"greaterOrEquals\\\",\\\"sdk_ver\\\",\\\"'5.2.1'\\\"]],[\\\"and\\\",[\\\"equals\\\",\\\"category\\\",\\\"'PERF_MASTER_TOKEN_FLOW'\\\"],[\\\"less\\\",\\\"sdk_ver\\\",\\\"'5.2.1'\\\"]],[\\\"and\\\",[\\\"equals\\\",\\\"d4\\\",\\\"'no_crash'\\\"],[\\\"less\\\",\\\"sdk_ver\\\",\\\"'5.2.1'\\\"]],[\\\"and\\\",[\\\"equals\\\",\\\"category\\\",\\\"'PERF_MASTER_TOKEN_FLOW'\\\"],[\\\"equals\\\",\\\"sdk_ver\\\",\\\"'unknown'\\\"]],[\\\"and\\\",[\\\"equals\\\",\\\"d4\\\",\\\"'no_crash'\\\"],[\\\"equals\\\",\\\"sdk_ver\\\",\\\"'unknown'\\\"]]]],\\\"launch_cnt\\\"],[\\\"as\\\",\\\"launch_cnt\\\",\\\"total_cnt\\\"]]'"
}
输出示例
{
"Response": {
"Data": "{\n \"status\": \"ok\",\n \"code\": 10000,\n \"msg\": \"ok\",\n \"data\": [\n {\n \"crash_cnt\": 18782,\n \"crash_rate\": 0.7724132258595163,\n \"crash_user_cnt\": 1,\n \"crash_user_rate\": 1,\n \"launch_cnt\": 24316,\n \"total_cnt\": 24316,\n \"user_cnt\": 1\n }\n ]\n}",
"RequestId": "77b45639-2b70-40b5-b9af-739488787109"
}
}
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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
ResourceNotFound | 资源不存在。 |