更改实例的采集状态
功能介绍
改变指定实例的采集状态:开启和关闭。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v1/apm2/openapi/apm-service/agent-mgr/change-status
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
x-business-id |
是 |
Long |
应用id。 |
|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
instance_list |
是 |
Array of integers |
探针实例id列表。 |
|
target_status |
是 |
Integer |
期望探针改变后的状态,0或1。0表示启用,1表示停用。 |
|
region |
是 |
String |
探针所在的区域。 |
|
env_id |
否 |
Long |
探针所属环境的id。 |
响应参数
状态码: 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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,请求响应成功。
{
"flag": "ok"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK,请求响应成功。 |
|
400 |
Bad Request,语义或参数有误。 |
|
401 |
Unauthorized,没有权限。 |
|
403 |
Forbidden,禁止访问。 |
|
404 |
Not Found,没有找到要请求的资源。 |
错误码
请参见错误码。