文档首页/ 应用性能管理 APM/ API参考(2.0)/ API/ APM/ 更改实例的采集状态
更新时间:2023-08-02 GMT+08:00

更改实例的采集状态

功能介绍

改变指定实例的采集状态:开启和关闭。

URI

POST /v1/apm2/openapi/apm-service/agent-mgr/change-status

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

x-business-id

Long

应用id。

X-Auth-Token

String

从IAM服务获取的用户Token。

表2 请求Body参数

参数

是否必选

参数类型

描述

instance_list

Array of integers

探针实例id列表。

target_status

Integer

期望探针改变后的状态,0或1,0表示启用,1表示停用。

region

String

探针所在的区域。

env_id

Long

探针所属环境的id。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

flag

String

返回结果ok表示成功。

请求示例

将实例ID为1097的采集状态修改为停止。

/v1/apm2/openapi/apm-service/agent-mgr/change-status

{
  "instance_list" : [ 1097 ],
  "target_status" : 1,
  "region" : "xx-xxxx-xxx"
}

响应示例

状态码: 200

OK,请求响应成功。

	
Response body
Download
{
  "flag": "ok"
}

状态码

状态码

描述

200

OK,请求响应成功。

401

Unauthorized,没有权限。

403

Forbidden,禁止访问。

404

Not Found,没有找到要请求的资源。

错误码

请参见错误码