打开或关闭应用监控的Agent总开关,或者查询Agent总开关的状态。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
arms:ConfigApp | none |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
AppIds | string | 是 | 应用的 ID 标识串(PID)。多个 PID 以半角逗号(,)分隔。 | iioe7jcnuk@582846f37******,atc889zkcf@d8deedfa9bf****** |
Enable | string | 否 | 打开或关闭一个或多个应用的 Agent 总开关。关闭开关后即停止监控。如果不填写该参数,则表示查询目标应用当前的 Agent 总开关状态。
| true |
RegionId | string | 是 | 地域 ID。 | cn-hangzhou |
Type | string | 否 | 应用类型,目前仅支持设置为 TRACE。 | TRACE |
返回参数
示例
正常返回示例
JSON
格式
{
"Data": "abc@def success\\nghi@jkl success\\n",
"RequestId": "16AF921B-8187-489F-9913-43C808B4****"
}
错误码
HTTP status code | 错误码 | 错误信息 |
---|---|---|
500 | InternalError | 必选参数不能为空 |
500 | InternalError | 创建应用接口异常, 请您检查下输入参数, 并联系工作人员 |
500 | InternalError | 创建应用失败,未识别应用type |
500 | InternalError | 创建应用失败,未知用户,用户未开通ARMS |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史