文档首页/ 应用性能管理 APM/ API参考（2.0）/ API/ 前端监控/ 查询RUM实例列表 - ListRumInstances
更新时间：2026-08-19 GMT+08:00
查看PDF
分享

查询RUM实例列表 - ListRumInstances

功能介绍

分页查询当前项目下所有RUM应用实例。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    apm：application：getService

    Read

    -

    g：EnterpriseProjectId

    apm：apm2Service：get

    -

URI

GET /v2/rum/apps/get-rum-instance

表1 Query参数

参数

是否必选

参数类型

描述

page

否

Integer

参数解释：

查询某一页的实例列表。

约束限制：

不涉及。

取值范围：

大于0的整数。

默认取值：

1。

page_size

否

Integer

参数解释：

每页显示多少个实例。

约束限制：

不涉及。

取值范围：

大于0的整数。

默认取值：

10。

app_name_matcher

否

String

参数解释：

应用名称模糊匹配关键词。

约束限制：

不涉及。

取值范围：

字符串。

默认取值：

不涉及。

get_sdk_configs

否

Boolean

参数解释：

是否获取SDK配置信息。

约束限制：

不涉及。

取值范围：

  • true：获取SDK配置信息。
  • false：不获取SDK配置信息。

默认取值：

false。

start_timestamp

是

String

参数解释：

查询开始时间戳。

约束限制：

不涉及。

取值范围：

字符串。

默认取值：

不涉及。

end_timestamp

是

String

参数解释：

查询结束时间戳。

约束限制：

不涉及。

取值范围：

字符串。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

从IAM服务获取的用户Token。获取方式请参见：获取Token。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

rum_instances

Array of RumInstanceInfoParam objects

参数解释：

RUM实例列表。

total_count

Integer

参数解释：

实例总条数。

取值范围：

不涉及。

page_count

Integer

参数解释：

总页数。

取值范围：

不涉及。

status

String

参数解释：

实例状态。

取值范围：

不涉及。
表4 RumInstanceInfoParam

参数

参数类型

描述

app_id

String

参数解释：

应用ID。

取值范围：

不涉及。

app_name

String

参数解释：

应用名称。

取值范围：

不涉及。

enable

Boolean

参数解释：

是否启用。

取值范围：

不涉及。

business_info

Object

参数解释：

业务信息。

取值范围：

不涉及。

sdk_configs

RumSdkConfigs object

参数解释：

RUM实例的SDK配置信息。

uv

Integer

参数解释：

UV数。

取值范围：

不涉及。

pv

Integer

参数解释：

PV数。

取值范围：

不涉及。

avg_load_time

Double

参数解释：

平均加载时间。

取值范围：

不涉及。

js_error_rate

Double

参数解释：

JS错误率。

取值范围：

不涉及。

api_success_rate

Double

参数解释：

API成功率。

取值范围：

不涉及。

env_id

Long

参数解释：

环境ID。

取值范围：

不涉及。

region

String

参数解释：

区域。

取值范围：

不涉及。

app_type

String

参数解释：

应用类型。

取值范围：

不涉及。

status

String

参数解释：

状态。

取值范围：

不涉及。

rtt_limit

String

参数解释：

RTT限制。

取值范围：

不涉及。

transfer_limit

String

参数解释：

传输限制。

取值范围：

不涉及。
表5 RumSdkConfigs

参数

参数类型

描述

hotspot_auto_report

String

参数解释：

热点自动上报。

取值范围：

字符串。

consistency_auto_report

String

参数解释：

一致性自动上报。

取值范围：

字符串。

api_auto_report

String

参数解释：

API自动上报。

取值范围：

字符串。

third_party_api_auto_report

String

参数解释：

第三方API自动上报。

取值范围：

字符串。

hash_mode_auto_parse

String

参数解释：

Hash模式自动解析。

取值范围：

字符串。

js_error_trace

String

参数解释：

JS错误追踪。

取值范围：

字符串。

js_error_auto_clean

String

参数解释：

JS错误自动清理。

取值范围：

字符串。

page_resource_report

String

参数解释：

页面资源上报。

取值范围：

字符串。

user_behavior_trace

String

参数解释：

用户行为追踪。

取值范围：

字符串。

page_long_task_trace

String

参数解释：

页面长任务追踪。

取值范围：

字符串。

trace_report

String

参数解释：

Trace上报。

取值范围：

字符串。

rtt_limit

Integer

参数解释：

RTT限制。

取值范围：

大于0的整数。

transfer_limit

Integer

参数解释：

传输限制。

取值范围：

大于0的整数。

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

状态码：403

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

状态码：429

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

请求示例

/v2/rum/apps/get-rum-instance?get_sdk_configs=true&start_timestamp=1783441669463&end_timestamp=1783528069463

响应示例

状态码：200

请求响应成功，获取RUM实例列表。

{
  "status" ： "success",
  "rum_instances" ： [ {
    "app_id" ： "238bf646xxxx65ac85e",
    "app_name" ： "test_auto001",
    "enable" ： false,
    "business_info" ： {
      "default" ： true,
      "id" ： 108903,
      "is_default" ： true,
      "display_name" ： "APM",
      "inner_domain_id" ： 2,
      "name" ： "LubanApm",
      "eps_id" ： "0",
      "cmdb_datasource_type" ： "APM",
      "uuid" ： "6797f68854xxxxxx7e5b54b5db64e"
    },
    "sdk_configs" ： {
      "hotspot_auto_report" ： "true",
      "consistency_auto_report" ： "true",
      "api_auto_report" ： "true",
      "third_party_api_auto_report" ： "true",
      "hash_mode_auto_parse" ： "true",
      "js_error_trace" ： "true",
      "js_error_auto_clean" ： "true",
      "page_resource_report" ： "true"
    },
    "uv" ： 0,
    "pv" ： 0,
    "avg_load_time" ： 0,
    "js_error_rate" ： 0,
    "api_success_rate" ： 0,
    "env_id" ： 379208,
    "region" ： "cn-north-7",
    "app_type" ： "WEB",
    "status" ： "STOPPED"
  } ],
  "total_count" ： 1,
  "page_count" ： 1
}

状态码

状态码

描述

200

OK

400

Bad Request

403

Forbidden

429

Too Many Requests

错误码

请参见错误码。

父主题： 前端监控

相关文档