文档首页/ 应用性能管理 APM/ API参考(2.0)/ API/ APP监控/ APP状态的更新 - UpdateRumAppInstanceStatus
更新时间:2026-11-20 GMT+08:00
分享

APP状态的更新 - UpdateRumAppInstanceStatus

功能介绍

更新APP监控中指定App应用实例的启用状态。

调用方法

请参见如何调用API。

授权信息

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

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

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    apm::updateConf

    Write

    -

    -

    apm:apm2Service:update

    -

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

app_id

是

String

参数解释:

App应用ID。

约束限制:

不涉及。

取值范围:

字符串。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

enable

是

Boolean

参数解释:

是否启用。

约束限制:

不涉及。

取值范围:

  • true:启用。

  • false:禁用。

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

status

String

参数解释:

操作结果状态,成功时返回“success”。

取值范围:

不涉及。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

不涉及。

error_msg

String

参数解释:

错误信息。

取值范围:

不涉及。

状态码:403

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

不涉及。

error_msg

String

参数解释:

错误信息。

取值范围:

不涉及。

请求示例

/v2/rum-app/apps/update-rum-app-instance-status/app-xxxxxx

{
  "enable" : 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

请求被拒绝访问。

错误码

请参见错误码。

相关文档