ConfigApp - Application Real-Time Monitoring Service - Alibaba Cloud Documentation Center

Turns on or off the main switch of an ARMS agent, or queries the status of the main switch.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
arms:ConfigApp	none	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
AppIds	string	Yes	The process identifier (PID) of the application. Separate multiple PIDs with commas (,).	iioe7jcnuk@582846f37****,atc889zkcf@d8deedfa9bf****
Enable	string	No	Specifies whether to turn on or off the main switch of the ARMS agent. The monitoring stops after the switch is turned off. If you do not specify this parameter, the main switch status of the ARMS agent is queried. `true`: turns on the switch `false`: turns off the switch	true
RegionId	string	Yes	The region ID.	cn-hangzhou
Type	string	No	The type of the application. Set the value to TRACE.	TRACE

Response parameters

Parameter	Type	Description	Example
	object
Data	string	The result of turning on or off the main switch of the agent or the main switch status of the agent. Indicates whether the request was successful. Valid values: success failed The main switch status of the agent. Valid values: true false	abc@def success\nghi@jkl success\n
RequestId	string	The request ID.	16AF921B-8187-489F-9913-43C808B4****

Examples

Sample success responses

JSONformat

{
  "Data": "abc@def success\\nghi@jkl success\\n",
  "RequestId": "16AF921B-8187-489F-9913-43C808B4****"
}

Error codes

HTTP status code	Error code	Description
500	InternalError	Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.
500	InternalError	-
500	InternalError	-
500	InternalError	-

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history