All Products
Search
Document Center

Application Real-Time Monitoring Service:CreateRumApp

Last Updated:Jul 16, 2025

Create a Real User Monitoring (RUM) application.

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:CreateRumAppcreate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
AppNamestringYes

The application name.

test-app
SiteTypestringYes

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

web
SourcestringNo

The source. This is a reserved parameter.

arms
AppGroupstringNo

The name of the application group.

default
DescriptionstringNo

The description of the application.

Monitoring description
ResourceGroupIdstringNo

The ID of the resource group.

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

The list of tags. You can specify a maximum of 20 tags.

objectNo

The list of tags. You can specify a maximum of 20 tags.

KeystringNo

The tag key.

app
ValuestringNo

The tag value.

ecs
PackageNamestringNo

The name of the Android application package. This parameter is required if you create an Android application.

com.xxxx.xxxxxx
RegionIdstringYes

The region ID.

cn-hangzhou
NickNamestringNo

The nickname of the application.

test-app
RealRegionIdstringNo

The region where the application resides. You can leave this parameter empty or set it to China East 2 Finance.

cn-shanghai-finance-1
LanguagestringNo

The language used by the client.

java

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

1A474FF8-7861-4D00-81B5-5BC3DA4E****
Codeinteger

The HTTP status code. 2XX indicates that the request was successful. 3XX indicates that the request was redirected. 4XX indicates that a request error occurred. 5XX indicates that a server error occurred.

200
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
Messagestring

The error message.

success
HttpStatusCodeinteger

The HTTP status code.

200
Dataobject

The application ID and domain names. This parameter is returned if the application is created. Multiple domain names are separated with commas (,).

Pidstring

The process ID (PID) of the application.

avccccxxxx@24cxxxxbf384dc6
Endpointstring

The endpoint that is used to report application data.

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

The domain name of the SDK.

bxxxxxxx-sdk.rum.aliyuncs.com/v2/browser-sdk.js
ResourceGroupIdstring

The ID of the resource group.

rg-acfmxyexli2****

Examples

Sample success responses

JSONformat

{
  "RequestId": "1A474FF8-7861-4D00-81B5-5BC3DA4E****",
  "Code": 200,
  "Success": true,
  "Message": "success",
  "HttpStatusCode": 200,
  "Data": {
    "Pid": "avccccxxxx@24cxxxxbf384dc6",
    "Endpoint": "xxxxxxxx-default-cn.rum.aliyuncs.com",
    "CdnDomain": "bxxxxxxx-sdk.rum.aliyuncs.com/v2/browser-sdk.js"
  },
  "ResourceGroupId": "rg-acfmxyexli2****"
}

Error codes

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

Change history

Change timeSummary of changesOperation
2025-02-17The request parameters of the API has changedView Change Details
2025-01-07The request parameters of the API has changedView Change Details
2024-09-02The request parameters of the API has changedView Change Details
2024-07-12The request parameters of the API has changedView Change Details
2024-06-28The response structure of the API has changedView Change Details