App监控实例更新 - UpdateRumAppInstance
功能介绍
更新APP监控中指定的App应用实例信息。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
apm::updateConf
Write
-
-
apm:apm2Service:update
-
URI
PUT /v2/rum-app/apps/update-rum-app-instance/{app_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| app_id | 是 | String | 参数解释: App应用ID。 约束限制: 不涉及。 取值范围: 字符串。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 从IAM服务获取的用户Token。获取方式请参见:获取Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| business_id | 是 | Long | 参数解释: 所属业务ID。 约束限制: 不涉及。 取值范围: 大于0的整数。 默认取值: 不涉及。 |
| app_name | 是 | String | 参数解释: App应用名称。 约束限制: 不涉及。 取值范围: 字符串。 默认取值: 不涉及。 |
| app_sdk_configs | 否 | RumAppSdkConfigJsonParam object | 参数解释: App SDK采集配置。 约束限制: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| enable_network | 否 | String | 参数解释: 网络监控开关。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| enable_crash | 否 | String | 参数解释: 崩溃监控开关。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| enable_launch | 否 | String | 参数解释: 启动监控开关。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| enable_anr | 否 | String | 参数解释: ANR监控开关。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| enable_error | 否 | String | 参数解释: 错误监控开关。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| enable_device | 否 | String | 参数解释: 设备监控开关。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| enable_action | 否 | String | 参数解释: 行为监控开关。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| enable_event | 否 | String | 参数解释: 事件监控开关。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| trace_report | 否 | String | 参数解释: 链路上报开关。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 参数解释: 操作结果状态,成功时返回“success”。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息。 取值范围: 不涉及。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息。 取值范围: 不涉及。 |
请求示例
/v2/rum-app/apps/update-rum-app-instance/app-xxxxxx
{
"app_name" : "appDemo",
"business_id" : 1,
"app_sdk_configs" : {
"enable_network" : "true",
"enable_crash" : "true",
"enable_launch" : "true",
"enable_anr" : "true",
"enable_error" : "true",
"enable_device" : "true",
"enable_action" : "true",
"enable_event" : "true",
"trace_report" : "true"
}
} 响应示例
状态码:200
{
"status" : "success"
} 状态码:400
{
"error_code" : "apm2.00000005",
"error_msg" : "invalid parameter"
} 状态码:403
{
"error_code" : "apm2.00000004",
"error_msg" : "has no privilege"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 更新App实例成功。 |
| 400 | 非法请求,建议根据error_msg检查修改该请求。 |
| 403 | 请求被拒绝访问。 |
错误码
请参见错误码。