Enabling or Disabling Collection for an Instance

This API is used to enable or disable collection for a specified instance.

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

Table 1 Request header parameters
Parameter	Mandatory	Type	Description
x-business-id	Yes	Long	Application ID.
X-Auth-Token	Yes	String	User token obtained from IAM.

Table 2 Request body parameters
Parameter	Mandatory	Type	Description
instance_list	Yes	Array of integers	List of Agent IDs.
target_status	Yes	Integer	Expected Agent status. Options: 0: enabled. 1: disabled.
region	Yes	String	Region where the Agent is located.
env_id	No	Long	ID of the environment to which the Agent belongs.

Status code: 200

Table 3 Response body parameters
Parameter	Type	Description
flag	String	ok: The operation is successful.

Disable data collection for instance 1097.

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

{
  "instance_list" : [ 1097 ],
  "target_status" : 1,
  "region" : ""
}

Status code: 200

OK: The request is successful.

{
  "flag": "ok"
}

Status Code	Description
200	OK: The request is successful.
400	Bad Request: Semantic or parameter error.
401	Unauthorized: No permissions.
403	Forbidden: Access forbidden.
404	Not Found: The requested resource is not found.

Parent topic: APM

Была ли эта статья полезна?