All Products
Search
Document Center

Application Real-Time Monitoring Service:UpdateRumApp

Last Updated:Jul 16, 2025

Updates a Real User Monitoring (RUM) application.

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

Request parameters

ParameterTypeRequiredDescriptionExample
PidstringYes

The application ID.

b5xxxxs@d8deedfa9bf****
DescriptionstringNo

The description of the application.

test
IsSubscribebooleanNo

Specifies whether you want to subscribe to the application. Valid values: true and false.

true
RegionIdstringYes

The region ID.

cn-hangzhou
NicknamestringNo

The alias of the application.

Android Test
RestartbooleanNo

Specifies whether to restart the application. Valid values: true and false.

true
StopbooleanNo

Specifies whether to stop the application. Valid values: true and false.

true
AutoRestartbooleanNo

Specifies whether to restart the application the next day. Valid values: true and false.

true
ServiceDomainOperationJsonstringNo

The service domain name of the application. You can create, modify, and delete service domain name configurations.

{\"Op\":\"Update\",\"Domain\":\"example.com\",\"Config\":{\"Description\":\"message\",\"Tracing\":\"true\",\"PropagatorTypes\":[\"sw8\"]}}
BonreeSDKConfigJsonstringNo

The collection configurations of the mobile SDK. You can enable or disable collection configurations based on the app version.

{\"moduleConfig\":{\"enable\":true,\"defaultConfig\":{\"network\":{\"enable\":true},\"h5\":{\"enable\":true},\"routechange\":{\"enable\":true},\"crash\":{\"enable\":true},\"view\":{\"enable\":true},\"coollaunch\":{\"enable\":true},\"hotlaunch\":{\"enable\":true},\"action\":{\"enable\":true},\"lagstuck\":{\"enable\":true},\"lagfps\":{\"enable\":true},\"statechange\":{\"enable\":true},\"anr\":{\"enable\":true},\"customlog\":{\"enable\":true},\"customevent\":{\"enable\":true},\"custommetric\":{\"enable\":true}},\"versionConfigs\":{\"1.1.0\":{\"useCustom\":true,\"customConfig\":{\"network\":{\"enable\":true},\"h5\":{\"enable\":true},\"routechange\":{\"enable\":true},\"crash\":{\"enable\":true},\"view\":{\"enable\":true},\"coollaunch\":{\"enable\":true},\"hotlaunch\":{\"enable\":true},\"action\":{\"enable\":true},\"lagstuck\":{\"enable\":false},\"lagfps\":{\"enable\":false},\"statechange\":{\"enable\":true},\"anr\":{\"enable\":true},\"customlog\":{\"enable\":true},\"customevent\":{\"enable\":true},\"custommetric\":{\"enable\":true}}},\"1.2.0\":{\"useCustom\":false,\"customConfig\":{}}}}}
RealRegionIdstringNo

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

cn-hangzhou
BackendServiceTraceRegionstringNo

The region where the backend application is deployed. This parameter is used in end-to-end tracing scenarios.

{\"moduleConfig\":{\"enable\":true,\"defaultConfig\":{\"network\":{\"enable\":true},\"h5\":{\"enable\":true},\"routechange\":{\"enable\":true},\"crash\":{\"enable\":true},\"view\":{\"enable\":true},\"coollaunch\":{\"enable\":true},\"hotlaunch\":{\"enable\":true},\"action\":{\"enable\":true},\"lagstuck\":{\"enable\":true},\"lagfps\":{\"enable\":true},\"statechange\":{\"enable\":true},\"anr\":{\"enable\":true},\"customlog\":{\"enable\":true},\"customevent\":{\"enable\":true},\"custommetric\":{\"enable\":true}},\"versionConfigs\":{\"1.1.0\":{\"useCustom\":true,\"customConfig\":{\"network\":{\"enable\":true},\"h5\":{\"enable\":true},\"routechange\":{\"enable\":true},\"crash\":{\"enable\":true},\"view\":{\"enable\":true},\"coollaunch\":{\"enable\":true},\"hotlaunch\":{\"enable\":true},\"action\":{\"enable\":true},\"lagstuck\":{\"enable\":false},\"lagfps\":{\"enable\":false},\"statechange\":{\"enable\":true},\"anr\":{\"enable\":true},\"customlog\":{\"enable\":true},\"customevent\":{\"enable\":true},\"custommetric\":{\"enable\":true}}},\"1.2.0\":{\"useCustom\":false,\"customConfig\":{}}}}}
AppConfigstringNo

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}

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

E9C9DA3D-10FE-472E-9EEF-2D0A3E41****
Codestring

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

200
Successstring

Indicates whether the request was successful. Valid values:

  • true
  • false
true
Messagestring

The error message returned if the request failed.

message
HttpStatusCodestring

The HTTP status code.

200
Dataobject

The details of the returned results.

Configstring

The user configurations. This is a reserved parameter.

null
Usageinteger

The usage. Unit: bytes.

10000
Limitinteger

The QPS limit. Unit: bytes.

100000
Limitedboolean

Indicates whether the request is throttled due to the QPS limit. Valid values: true and false.

true

Examples

Sample success responses

JSONformat

{
  "RequestId": "E9C9DA3D-10FE-472E-9EEF-2D0A3E41****",
  "Code": 200,
  "Success": true,
  "Message": "message",
  "HttpStatusCode": 200,
  "Data": {
    "Config": null,
    "Usage": 10000,
    "Limit": 100000,
    "Limited": true
  }
}

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
2024-09-19The request parameters of the API has changedView Change Details
2024-09-02The request parameters of the API has changedView Change Details
2024-07-03The request parameters of the API has changedView Change Details