全部产品
Search
文档中心

应用实时监控服务ARMS:ConfigApp - 打开或关闭应用监控总开关

更新时间:Aug 28, 2026

打开或关闭应用监控的Agent总开关,或者查询Agent总开关的状态。

接口说明


调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

AppIds

string

是

应用的 ID 标识串(PID)。多个 PID 以半角逗号(,)分隔。

iioe7jcnuk@582846f37******,atc889zkcf@d8deedfa9bf******

Enable

string

否

打开或关闭一个或多个应用的 Agent 总开关。关闭开关后即停止监控。如果不填写该参数,则表示查询目标应用当前的 Agent 总开关状态。

  • true:打开 Agent 总开关

  • false:关闭 Agent 总开关

true

RegionId

string

是

地域 ID。

cn-hangzhou

Type

string

否

应用类型,目前仅支持设置为 TRACE。

TRACE

返回参数

名称

类型

描述

示例值

object

Data

string

操作是否成功或者目标应用的 Agent 总开关状态。 操作是否成功:

  • success

  • failed

Agent 总开关状态:

  • true

  • false

abc@def success\nghi@jkl success\n

RequestId

string

请求 ID。

16AF921B-8187-489F-9913-43C808B4****

示例

正常返回示例

JSON格式

{
  "Data": "abc@def success\\nghi@jkl success\\n",
  "RequestId": "16AF921B-8187-489F-9913-43C808B4****"
}

错误码

HTTP status code

错误码

错误信息

描述

500 InternalError 必选参数不能为空

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。