文档首页/ 应用性能管理 APM/ API参考(2.0)/ API/ 前端监控/ 更新RUM实例状态 - UpdateRumInstanceStatus
更新时间:2026-08-19 GMT+08:00
分享

更新RUM实例状态 - UpdateRumInstanceStatus

功能介绍

启用或禁用指定的RUM应用实例

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    apm::updateConf

    Write

    -

    -

    apm:apm2Service:update

    -

URI

PUT /v2/rum/apps/update-rum-instance-status/{app_id}

表1 路径参数

参数

是否必选

参数类型

描述

app_id

String

参数解释

RUM应用ID。

约束限制

不涉及。

取值范围

字符串。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

从IAM服务获取的用户Token。获取方式请参见:获取Token

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

enable

Boolean

参数解释

是否启用RUM实例

约束限制

不涉及。

取值范围

  • true:启用RUM实例。
  • false:禁用RUM实例。

默认取值

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

status

String

参数解释

实例状态。

取值范围

不涉及。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码。

取值范围

不涉及。

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

状态码:403

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码。

取值范围

不涉及。

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

状态码:429

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码。

取值范围

不涉及。

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

请求示例

/v2/rum/apps/update-rum-instance-status/2690466d4c9000000000683ed4

{
  "enable" : true
}

响应示例

状态码:200

更新实例状态成功。

{
  "status" : "success"
}

状态码

状态码

描述

200

OK

400

Bad Request

403

Forbidden

429

Too Many Requests

错误码

请参见错误码

相关文档