全部产品
Search
文档中心

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

更新时间:Nov 05, 2024

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
arms:ConfigAppnone
  • 全部资源
    *

请求参数

名称类型必填描述示例值
AppIdsstring

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

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

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

  • true:打开 Agent 总开关
  • false:关闭 Agent 总开关
true
RegionIdstring

地域 ID。

cn-hangzhou
Typestring

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

TRACE

返回参数

名称类型描述示例值
object
Datastring

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

  • success
  • failed

Agent 总开关状态:

  • true
  • false
abc@def success\nghi@jkl success\n
RequestIdstring

请求 ID。

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

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息
500InternalError必选参数不能为空
500InternalError创建应用接口异常, 请您检查下输入参数, 并联系工作人员
500InternalError创建应用失败,未识别应用type
500InternalError创建应用失败,未知用户,用户未开通ARMS

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

变更历史

变更时间变更内容概要操作
暂无变更历史