GetRumAppInfo - 获取RUM应用信息_应用实时监控服务(ARMS)-阿里云帮助中心

获取前端监控单个应用信息。

接口说明

用户体验监控目前仅在杭州、新加坡、硅谷提供服务，请选择正确的 Endpoint。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
Pid	string	是	应用 ID。	atc889zkcf@d8deedfa9bf****
AppGroup	string	否	应用分组。	default
RegionId	string	是	地域 ID。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	Id of the request	A5EC8221-08F2-4C95-9AF1-49FD998C****
Code	integer	状态码。返回 200 代表成功。	200
Success	boolean	查询是否成功。 `true`：成功。 `false`：失败。	true
Message	string	调用失败时返回的信息。	内部错误，请联系管理员。
HttpStatusCode	string	HTTP 状态码。	200
Data	object	应用详情。
CreateTime	string	创建时间，单位是毫秒时间戳。	1683353594000
Name	string	应用名称。	tomcat-demo-test
Pid	string	应用 ID。	avccccefy0@24cccccbf384dc6
Type	string	应用类型，此字段为固定值 RUM。	RUM
NickName	string	应用别名。	nickname
RegionId	string	地域 ID。	cn-hangzhou
AppType	string	应用类型，Web&H5：web，小程序：miniapp，iOS：ios，Android：android。	web
Status	string	应用状态，created：已创建，running：运行中，stopped：停止数据上报。	running
ResourceGroupId	string	资源组 ID。	rg-aek2vezare****
IsSubscription	string	是否收藏，true：收藏，false：未收藏。	true
Description	string	应用描述信息。	门户首页。
PackageName	string	应用程序包名	com.alibaba.rum
Endpoint	string	应用数据的上报 endpoint。	xxxxxxxx-default-cn.rum.aliyuncs.com
SlsProject	string	存储应用数据的 SLS Project 名称。	proj-xtrace-xxxxxxxxxxxxxxxxxxxxxxx-cn-hangzhou
Tags	array<object>	标签。
tags	object	标签。
Key	string	Tag 的键。	Label
Value	string	Tag 的值	Value
SlsLogstore	string	存储应用数据的 SLS Logstore 名称。	logstore-rum
ServiceDomainConfigs	array<object>	服务域名配置列表（当前仅支持移动端应用）
serviceDomainConfigs	object	服务域名配置
Domain	string	域名或 IP	example.com
Description	string	描述	测试
Tracing	boolean	是否启用链路追踪（需要开通可观测链路 OpenTelemetry 版），取值： `true`：启用链路追踪（开启后，将会在该域名请求中插入相关 Header）。 `false`：不启用链路追踪。	true
PropagatorTypes	array	Trace 透传协议列表，开启链路追踪时必传
propagatorTypes	string	Trace 透传协议，当前仅支持 Skywalking V2、V3，分别对应：sw6、sw8	sw8
SamplingRate	integer	Trace 采样率：(0, 100]	100
CdnDomain	string	SDK 域名。	b59xxxxxxxx-sdk.rum.aliyuncs.com/v2/browser-sdk.js
BonreeSDKConfig	object	移动端采集配置
moduleConfig	object	模块功能开关
enable	boolean	总开关	true
defaultConfig	object	应用默认配置
	object	模块配置项
enable	boolean	开关	true
versionConfigs	object	应用版本配置
	object	版本配置
useCustom	boolean	是否使用自定义配置	true
customConfig	object	自定义配置项
	object	模块配置项
enable	boolean	开关	true
description	string	版本配置描述	1.1.0版本配置
updateTime	long	版本配置更新时间	1721112372055
samplingConfig	object	采样配置
samplingType	integer	采样类型，当前仅支持 session 随机采样，即固定传：1	1
samplingRate	integer	采样率：(0, 1000] 之间，千分比	500
AppGroup	string	应用分组。	default
BackendServiceTraceRegion	string	后端应用部署区域（端到端链路场景使用）	cn-hangzhou
AppConfig	string	旧版应用配置，目前已废弃（JSON 格式）	{"apiRequestOfH5":300,"apiRequestOfOriginal":500,"coldStart":5000,"hotStart":3000,"staticResourceLoad":300,"stutter":1000,"viewLoadOfH5":1000,"viewLoadOfOriginal":2000}

示例

正常返回示例

JSON格式

{
  "RequestId": "A5EC8221-08F2-4C95-9AF1-49FD998C****",
  "Code": 200,
  "Success": true,
  "Message": "内部错误，请联系管理员。",
  "HttpStatusCode": 200,
  "Data": {
    "CreateTime": 1683353594000,
    "Name": "tomcat-demo-test",
    "Pid": "avccccefy0@24cccccbf384dc6",
    "Type": "RUM",
    "NickName": "nickname",
    "RegionId": "cn-hangzhou",
    "AppType": "web",
    "Status": "running",
    "ResourceGroupId": "rg-aek2vezare****",
    "IsSubscription": true,
    "Description": "门户首页。",
    "PackageName": "com.alibaba.rum",
    "Endpoint": "xxxxxxxx-default-cn.rum.aliyuncs.com",
    "SlsProject": "proj-xtrace-xxxxxxxxxxxxxxxxxxxxxxx-cn-hangzhou",
    "Tags": [
      {
        "Key": "Label",
        "Value": "Value"
      }
    ],
    "SlsLogstore": "logstore-rum",
    "ServiceDomainConfigs": [
      {
        "Domain": "example.com",
        "Description": "测试",
        "Tracing": true,
        "PropagatorTypes": [
          "sw8"
        ],
        "SamplingRate": 100
      }
    ],
    "CdnDomain": "b59xxxxxxxx-sdk.rum.aliyuncs.com/v2/browser-sdk.js",
    "BonreeSDKConfig": {
      "moduleConfig": {
        "enable": true,
        "defaultConfig": {
          "key": {
            "enable": true
          }
        },
        "versionConfigs": {
          "key": {
            "useCustom": true,
            "customConfig": {
              "key": {
                "enable": true
              }
            },
            "description": "1.1.0版本配置",
            "updateTime": 1721112372055
          }
        }
      },
      "samplingConfig": {
        "samplingType": 1,
        "samplingRate": 500
      }
    },
    "AppGroup": "default",
    "BackendServiceTraceRegion": "cn-hangzhou",
    "AppConfig": {
      "apiRequestOfH5": 300,
      "apiRequestOfOriginal": 500,
      "coldStart": 5000,
      "hotStart": 3000,
      "staticResourceLoad": 300,
      "stutter": 1000,
      "viewLoadOfH5": 1000,
      "viewLoadOfOriginal": 2000
    },
    "WebSDKConfigJson": ""
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2025-02-17	OpenAPI 返回结构发生变更	查看变更详情
2025-01-07	OpenAPI 入参发生变更	查看变更详情
2024-09-29	OpenAPI 返回结构发生变更	查看变更详情
2024-09-19	OpenAPI 返回结构发生变更	查看变更详情
2024-08-16	API 内部配置变更，不影响调用	查看变更详情
2024-08-09	OpenAPI 返回结构发生变更	查看变更详情
2024-07-10	OpenAPI 返回结构发生变更	查看变更详情
2024-07-03	OpenAPI 返回结构发生变更	查看变更详情
2024-06-28	OpenAPI 返回结构发生变更	查看变更详情