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
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| arms:UpdateRumApp | update | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Pid | string | Yes | The application ID. | b5xxxxs@d8deedfa9bf**** |
| Description | string | No | The description of the application. | test |
| IsSubscribe | boolean | No | Specifies whether you want to subscribe to the application. Valid values: true and false. | true |
| RegionId | string | Yes | The region ID. | cn-hangzhou |
| Nickname | string | No | The alias of the application. | Android Test |
| Restart | boolean | No | Specifies whether to restart the application. Valid values: true and false. | true |
| Stop | boolean | No | Specifies whether to stop the application. Valid values: true and false. | true |
| AutoRestart | boolean | No | Specifies whether to restart the application the next day. Valid values: true and false. | true |
| ServiceDomainOperationJson | string | No | 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\"]}} |
| BonreeSDKConfigJson | string | No | 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\":{}}}}} |
| RealRegionId | string | No | The region where the application resides. You can leave this parameter empty or set it to China East 2 Finance. | cn-hangzhou |
| BackendServiceTraceRegion | string | No | 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\":{}}}}} |
| AppConfig | string | No | 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
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 time | Summary of changes | Operation |
|---|---|---|
| 2025-02-17 | The request parameters of the API has changed | View Change Details |
| 2024-09-19 | The request parameters of the API has changed | View Change Details |
| 2024-09-02 | The request parameters of the API has changed | View Change Details |
| 2024-07-03 | The request parameters of the API has changed | View Change Details |
