文档首页/ 应用性能管理 APM/ API参考(2.0)/ API/ APP监控/ 根据APPID查询APP详情 - ShowRumAppInstance
更新时间:2026-11-20 GMT+08:00
分享

根据APPID查询APP详情 - ShowRumAppInstance

功能介绍

根据App应用ID查询APP监控实例的详细信息。

调用方法

请参见如何调用API。

授权信息

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

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

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    apm:application:getService

    Read

    -

    -

    apm:apm2Service:get

    -

URI

GET /v2/rum-app/apps/get-rum-app-instance/{app_id}

表1 路径参数

参数

是否必选

参数类型

描述

app_id

是

String

参数解释:

App应用ID。

约束限制:

不涉及。

取值范围:

字符串。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

get_sdk_configs

否

Boolean

参数解释:

是否返回SDK配置信息。

约束限制:

不涉及。

取值范围:

  • true:返回SDK配置。

  • false:不返回SDK配置。

默认取值:

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

status

String

参数解释:

操作结果状态,成功时返回“success”。

取值范围:

不涉及。

rum_app_instance

RumAppInstanceParam object

参数解释:

App应用实例详情。

表5 RumAppInstanceParam

参数

参数类型

描述

app_id

String

参数解释:

App应用ID。

取值范围:

不涉及。

app_name

String

参数解释:

App应用名称。

取值范围:

不涉及。

enable

Boolean

参数解释:

是否启用。

取值范围:

  • true:启用

  • false:禁用

business_info

BusinessNodeModel object

参数解释:

所属业务的节点信息。

app_sdk_configs

RumAppSdkConfigJsonParam object

参数解释:

App SDK采集配置。

env_id

Long

参数解释:

环境ID。

取值范围:

不涉及。

region

String

参数解释:

区域。

取值范围:

不涉及。

app_type

String

参数解释:

应用类型。

取值范围:

  • android-app:Android应用。

  • ios-app:iOS应用。

status

String

参数解释:

App应用状态。

取值范围:

不涉及。

create_time

String

参数解释:

创建时间。

取值范围:

不涉及。

authorization

String

参数解释:

SDK采集授权信息。

取值范围:

不涉及。

overview_cards

Object

参数解释:

App实例的总览卡片数据,键为数据类型(如anr、crash、error、device等),值为对应的卡片详情,未查询到数据时返回空。

表6 BusinessNodeModel

参数

参数类型

描述

id

Long

参数解释:

业务ID。

取值范围:

不涉及。

name

String

参数解释:

业务名称。

取值范围:

不涉及。

display_name

String

参数解释:

业务显示名称。

取值范围:

不涉及。

eps_id

String

参数解释:

企业项目ID。

取值范围:

不涉及。

uuid

String

参数解释:

业务唯一标识。

取值范围:

不涉及。

is_default

Boolean

参数解释:

是否为默认业务。

取值范围:

  • true:默认。

  • false:非默认。

default

Boolean

参数解释:

是否为默认业务。

取值范围:

  • true:默认。

  • false:非默认。

inner_domain_id

Integer

参数解释:

租户域ID。

取值范围:

不涉及。

cmdb_datasource_type

String

参数解释:

CMDB数据来源类型,标识业务是SkyWalking类型还是OpenTelemetry类型。

取值范围:

不涉及。

表7 RumAppSdkConfigJsonParam

参数

参数类型

描述

enable_network

String

参数解释:

网络监控开关。

取值范围:

  • true:开启。

  • false:关闭。

enable_crash

String

参数解释:

崩溃监控开关。

取值范围:

  • true:开启。

  • false:关闭。

enable_launch

String

参数解释:

启动监控开关。

取值范围:

  • true:开启。

  • false:关闭。

enable_anr

String

参数解释:

ANR监控开关。

取值范围:

  • true:开启。

  • false:关闭。

enable_error

String

参数解释:

错误监控开关。

取值范围:

  • true:开启。

  • false:关闭。

enable_device

String

参数解释:

设备监控开关。

取值范围:

  • true:开启。

  • false:关闭。

enable_action

String

参数解释:

行为监控开关。

取值范围:

  • true:开启。

  • false:关闭。

enable_event

String

参数解释:

事件监控开关。

取值范围:

  • true:开启。

  • false:关闭。

trace_report

String

参数解释:

链路上报开关。

取值范围:

  • true:开启。

  • false:关闭。

状态码:400

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

不涉及。

error_msg

String

参数解释:

错误信息。

取值范围:

不涉及。

状态码:403

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

不涉及。

error_msg

String

参数解释:

错误信息。

取值范围:

不涉及。

请求示例

/v2/rum-app/apps/get-rum-app-instance/app-xxxxxx?get_sdk_configs=false

响应示例

状态码:200

{
  "status" : "success",
  "rum_app_instance" : {
    "app_id" : "app-xxxxxx",
    "app_name" : "appDemo",
    "enable" : true,
    "business_info" : {
      "default" : true,
      "id" : 100001,
      "is_default" : true,
      "display_name" : "demoBusiness",
      "inner_domain_id" : 1,
      "name" : "demoBusiness",
      "eps_id" : "0",
      "cmdb_datasource_type" : "APM",
      "uuid" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    },
    "authorization" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "overview_cards" : { }
  }
}

状态码: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

查询App实例详情成功。

400

非法请求,建议根据error_msg检查修改该请求。

403

请求被拒绝访问。

错误码

请参见错误码。

相关文档