App监控查询总览表格 - ShowRumAppViewOverviewTable
功能介绍
查询APP监控总览页面的统计数据表格。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
apm:application:getService
Read
-
-
apm:apm2Service:get
-
URI
POST /v2/rum-app/view/get-overview-table/{app_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| app_id | 是 | String | 参数解释: App应用ID。 约束限制: 不涉及。 取值范围: 字符串。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 从IAM服务获取的用户Token。获取方式请参见:获取Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| start_timestamp | 是 | String | 参数解释: 查询开始时间,毫秒时间戳。 约束限制: 开始时间和结束时间必须同时设置。 取值范围: 毫秒级时间戳字符串。 默认取值: 不涉及。 |
| end_timestamp | 是 | String | 参数解释: 查询结束时间,毫秒时间戳。 约束限制: 开始时间和结束时间必须同时设置。 取值范围: 毫秒级时间戳字符串。 默认取值: 不涉及。 |
| search_list | 否 | Array of Map<String,String> objects | 参数解释: 搜索条件列表。 约束限制: 不涉及。 |
| request_id | 否 | String | 参数解释: 请求ID。 约束限制: 不涉及。 取值范围: 字符串。 默认取值: 不涉及。 |
| page | 否 | Integer | 参数解释: 当前页码。 约束限制: 不涉及。 取值范围: 大于0的整数。 默认取值: 1 |
| page_size | 否 | Integer | 参数解释: 每页最大返回的记录数。 约束限制: 不涉及。 取值范围: 大于0的整数。 默认取值: 10 |
| match_text | 否 | String | 参数解释: 匹配文本。 约束限制: 不涉及。 取值范围: 字符串。 默认取值: 不涉及。 |
| order_by | 否 | String | 参数解释: 排序规则。 约束限制: 不涉及。 取值范围: 字符串。 默认取值: 不涉及。 |
| type | 否 | String | 参数解释: 查询类型。 约束限制: 不涉及。 取值范围: 字符串。 默认取值: 不涉及。 |
| device_id | 否 | String | 参数解释: 设备ID。 约束限制: 不涉及。 取值范围: 字符串。 默认取值: 不涉及。 |
| state | 否 | String | 参数解释: 状态筛选条件。 约束限制: 不涉及。 取值范围: 字符串。 默认取值: 不涉及。 |
| tags | 否 | String | 参数解释: 标签筛选条件。 约束限制: 不涉及。 取值范围: 字符串。 默认取值: 不涉及。 |
| range_min | 否 | Long | 参数解释: 取值范围最小值。 约束限制: 不涉及。 取值范围: 整数。 默认取值: 不涉及。 |
| range_max | 否 | Long | 参数解释: 取值范围最大值。 约束限制: 不涉及。 取值范围: 整数。 默认取值: 不涉及。 |
| keyword_match | 否 | String | 参数解释: 关键字匹配内容。 约束限制: 不涉及。 取值范围: 字符串。 默认取值: 不涉及。 |
| t | 是 | String | 参数解释: 功能类型,取值决定查询的数据类型。 约束限制: 必填。 取值范围: 默认取值: 不涉及。 |
| timestamp | 否 | Long | 参数解释: 上报时间戳。 约束限制: 不涉及。 取值范围: 整数。 默认取值: 不涉及。 |
| url | 否 | String | 参数解释: 页面URL。 约束限制: 不涉及。 取值范围: 字符串。 默认取值: 不涉及。 |
| uuid | 否 | String | 参数解释: 会话唯一标识。 约束限制: 不涉及。 取值范围: 字符串。 默认取值: 不涉及。 |
| custom_key | 否 | String | 参数解释: 自定义维度键。 约束限制: 不涉及。 取值范围: 字符串。 默认取值: 不涉及。 |
| str_val | 否 | String | 参数解释: 自定义维度值。 约束限制: 不涉及。 取值范围: 字符串。 默认取值: 不涉及。 |
| ssid | 否 | String | 参数解释: 会话标识。 约束限制: 不涉及。 取值范围: 字符串。 默认取值: 不涉及。 |
| name | 否 | String | 参数解释: 名称。 约束限制: 不涉及。 取值范围: 字符串。 默认取值: 不涉及。 |
| function_type | 否 | String | 参数解释: 查询的功能类型。 约束限制: 不涉及。 取值范围: 字符串。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| result_id | String | 参数解释: 查询结果标识。 取值范围: 不涉及。 |
| total_count | Integer | 参数解释: 总记录数。 取值范围: 不涉及。 |
| row_list | Array<Array<String>> | 参数解释: 表格行数据列表。 |
| sum | Integer | 参数解释: 汇总值。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息。 取值范围: 不涉及。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息。 取值范围: 不涉及。 |
请求示例
/v2/rum-app/view/get-overview-table/app-xxxxxx
{
"start_timestamp" : "1783651200000",
"end_timestamp" : "1783737599000",
"t" : "custom-event-value"
} 响应示例
状态码:200
{
"result_id" : "09c55038-8d9d-42f2-8a19-709905d8c631",
"total_count" : 0,
"row_list" : [ [ "str_val", "invoke_count", "device_count", "last_report_ts" ] ],
"sum" : 0
} 状态码:400
"\"\\\"{\\\\n \\\\\\\"error_code\\\\\\\": \\\\\\\"apm2.00000005\\\\\\\",\\\\n \\\\\\\"error_msg\\\\\\\": \\\\\\\"invalid parameter\\\\\\\"\\\\n}\\\"\"" 状态码:403
"\"\\\"{\\\\n \\\\\\\"error_code\\\\\\\": \\\\\\\"apm2.00000004\\\\\\\",\\\\n \\\\\\\"error_msg\\\\\\\": \\\\\\\"has no privilege\\\\\\\"\\\\n}\\\"\"" 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询总览表格成功。 |
| 400 | 非法请求,建议根据error_msg检查修改该请求。 |
| 403 | 请求被拒绝访问。 |
错误码
请参见错误码。