All Products
Search
Document Center

Application Real-Time Monitoring Service:GetRumAppInfo

Last Updated:Jul 16, 2025

Obtains the information about a single application in Browser Monitoring.

Operation description

Real User Monitoring (RUM) is available only in the China (Hangzhou), Singapore, and US (Silicon Valley) regions. Select the correct endpoint.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
arms:GetRumAppInfoget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PidstringYes

The process ID (PID) of the application.

atc889zkcf@d8deedfa9bf****
AppGroupstringNo

The group to which the application belongs.

default
RegionIdstringYes

The region ID.

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

A5EC8221-08F2-4C95-9AF1-49FD998C****
Codeinteger

The HTTP status code. The status code 200 indicates that the request was successful.

200
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
Messagestring

The error message.

StartTime is mandatory for this action.
HttpStatusCodestring

The HTTP status code.

200
Dataobject

The application details.

CreateTimestring

The time when the application was created. The value is a timestamp. Unit: milliseconds.

1683353594000
Namestring

The application name.

tomcat-demo-test
Pidstring

The application ID.

avccccefy0@24cccccbf384dc6
Typestring

The type of the application. Valid value: RUM.

RUM
NickNamestring

The alias of the application.

nickname
RegionIdstring

The region ID.

cn-hangzhou
AppTypestring

The application type. Valid values: web, miniapp, ios, and android.

web
Statusstring

The status of the application. Valid values: created, running, and stopped.

running
ResourceGroupIdstring

The ID of the resource group.

rg-aek2vezare****
IsSubscriptionstring

Indicates whether the application is subscribed. Valid values: true and false.

true
Descriptionstring

The description of the application.

Portal home page.
PackageNamestring

The name of the application package.

com.alibaba.rum
Endpointstring

The endpoint that is used to report application data.

xxxxxxxx-default-cn.rum.aliyuncs.com
SlsProjectstring

The name of the Simple Log Service project that stores application data.

proj-xtrace-xxxxxxxxxxxxxxxxxxxxxxx-cn-hangzhou
Tagsarray<object>

The tags.

tagsobject
Keystring

The tag key.

Label
Valuestring

The tag value.

Value
SlsLogstorestring

The name of the Simple Log Service Logstore that stores application data.

logstore-rum
ServiceDomainConfigsarray<object>

The list of service domain configurations. Only mobile applications are supported.

serviceDomainConfigsobject

A service domain configuration of the queried list.

Domainstring

The domain name or IP address.

example.com
Descriptionstring

The description.

Test
Tracingboolean

Indicates whether the tracing analysis feature is enabled. To enable the tracing analysis feature, you must activate Managed Service for OpenTelemetry. Valid values:

  • true: enables the tracing analysis feature. If you enable the tracing analysis feature, related headers are inserted into requests for the domain name.
  • false: disables the tracing analysis feature.
true
PropagatorTypesarray

The trace propagation protocols. This parameter is required if the tracing analysis feature is enabled.

propagatorTypesstring

The trace propagation protocol. Valid values: sw6 and sw8. sw6 indicates SkyWalking V2 and sw8 indicates SkyWalking V3.

sw8
SamplingRateinteger

The sampling rate of a trace. Valid values: (0, 100].

100
CdnDomainstring

The domain name of the SDK.

b59xxxxxxxx-sdk.rum.aliyuncs.com/v2/browser-sdk.js
BonreeSDKConfigobject

The collection configurations.

moduleConfigobject

The module configuration.

enableboolean

Indicates whether the configuration is enabled.

true
defaultConfigobject

The default configuration of the application.

object

The module configuration.

enableboolean

Indicates whether the configuration is enabled.

true
versionConfigsobject

The version configurations of the application.

object

The version configuration.

useCustomboolean

Indicates whether the custom configuration is used.

true
customConfigobject

The custom configuration.

object

The module configuration.

enableboolean

Indicates whether the configuration is enabled.

true
descriptionstring

The description of the version configuration.

test
updateTimelong

The time when the version configuration was updated.

1721112372055
samplingConfigobject

Sampling configuration.

samplingTypeinteger

Sampling type, currently only session random sampling is supported, that is, fixed transmission: 1.

1
samplingRateinteger

Sampling rate: between (0, 1000], a thousandth.

500
AppGroupstring

The group to which the application belongs.

default
BackendServiceTraceRegionstring

The region where the backend is deployed.

cn-hangzhou
AppConfigstring

The application configurations in the JSON format. This parameter is deprecated.

{"apiRequestOfH5":300,"apiRequestOfOriginal":500,"coldStart":5000,"hotStart":3000,"staticResourceLoad":300,"stutter":1000,"viewLoadOfH5":1000,"viewLoadOfOriginal":2000}

Examples

Sample success responses

JSONformat

{
  "RequestId": "A5EC8221-08F2-4C95-9AF1-49FD998C****",
  "Code": 200,
  "Success": true,
  "Message": "StartTime is mandatory for this action.",
  "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": "Portal home page.",
    "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": "Test\n",
        "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": "test",
            "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
    }
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2025-02-17The response structure of the API has changedView Change Details
2025-01-07The request parameters of the API has changedView Change Details
2024-09-29The response structure of the API has changedView Change Details
2024-09-19The response structure of the API has changedView Change Details
2024-08-16The internal configuration of the API is changed, but the call is not affectedView Change Details
2024-08-09The response structure of the API has changedView Change Details
2024-07-10The response structure of the API has changedView Change Details
2024-07-03The response structure of the API has changedView Change Details
2024-06-28The response structure of the API has changedView Change Details