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" : "xx-xxxx-xx"
}

Status code: 200

OK: The request is successful.

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

Status Code	Description
200	OK: The request is successful.
401	Unauthorized: No permissions.
403	Forbidden: Access forbidden.
404	Not Found: The requested resource is not found.

Parent topic: APM

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.