All Products
Search
Document Center

Application Real-Time Monitoring Service:GetRumApps

Last Updated:Jul 16, 2025

Queries a list of Real User Monitoring (RUM) applications.

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:GetRumAppslist
*Rum
acs:arms:{#regionId}:{#accountId}:rum/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
AppIdstringNo

The application ID.

b590lhguqs@28f515462******
AppGroupstringNo

The group to which the application belongs.

default
AppNamestringNo

The name of the application. You can specify only one application name in each request.

test-app
AppTypestringNo

The application type. Currently, supported application types include: web, mini program, Android, iOS, Windows, macOS, and HarmonyOS.

web
ResourceGroupIdstringNo

The ID of the resource group.

rg-acfmxyexli2****
Tagsarray<object>No

The tags.

objectNo

The tags.

KeystringNo

The tag key.

TestKey
ValuestringNo

The tag value.

TestValue
RegionIdstringYes

The region ID.

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

70675725-8F11-4817-8106-CFE0AD71****
Codeinteger

The response 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 returned if the request failed.

Internal error, please contact customer service.
HttpStatusCodeinteger

The HTTP status code.

200
AppListarray<object>

The queried applications.

AppListobject

The application details.

CreateTimeany

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

1685686960872
Namestring

The application name.

home page
Pidstring

The application ID.

xxxxx@cc08bdxxxx20b15
Typestring

The type of the application. Valid value: RUM.

RUM
NickNamestring

The alias of the application.

Williamtag
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-acfmzaq3ypaqkdy
Tagsarray<object>

The tags.

tagsobject
Keystring

The tag key. The tag key can be up to 128 characters in length. It cannot start with aliyun or acs: and cannot contain http:// or https://.

tag1
Valuestring

The tag value.

ok
IsSubscriptionboolean

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

true
Descriptionstring

The description of the application.

TEST
PackageNamestring

The package name of the Android application.

com.zy.yxws
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-xxxxxxxba6ef5466b5debf9e2f951-cn-hangzhou
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

The service domain configurations.

Domainstring

The domain name or IP address.

example.com
Descriptionstring

The description.

Test
Tracingstring

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

Examples

Sample success responses

JSONformat

{
  "RequestId": "70675725-8F11-4817-8106-CFE0AD71****",
  "Code": 200,
  "Success": true,
  "Message": "Internal error, please contact customer service.",
  "HttpStatusCode": 200,
  "AppList": [
    {
      "CreateTime": 1685686960872,
      "Name": "home page",
      "Pid": "xxxxx@cc08bdxxxx20b15",
      "Type": "RUM",
      "NickName": "Williamtag",
      "RegionId": "cn-hangzhou",
      "AppType": "web",
      "Status": "running",
      "ResourceGroupId": "rg-acfmzaq3ypaqkdy",
      "Tags": [
        {
          "Key": "tag1",
          "Value": "ok"
        }
      ],
      "IsSubscription": true,
      "Description": "TEST",
      "PackageName": "com.zy.yxws",
      "Endpoint": "xxxxxxxx-default-cn.rum.aliyuncs.com",
      "SlsProject": "proj-xtrace-xxxxxxxba6ef5466b5debf9e2f951-cn-hangzhou",
      "SlsLogstore": "logstore-rum",
      "ServiceDomainConfigs": [
        {
          "Domain": "example.com",
          "Description": "Test\n",
          "Tracing": true,
          "PropagatorTypes": [
            "sw8"
          ]
        }
      ]
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
2025-02-13The request parameters of the API has changedView Change Details
2025-01-07The request parameters of the API has changedView Change Details
2024-07-12The internal configuration of the API is changed, but the call is not affectedView Change Details