Turns on or off the main switch of an ARMS agent, or queries the main switch status.
Operation description
Try it now
Test
RAM authorization
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 |
Turns on or off the main switch of the ARMS agent. 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 |
| RegionId |
string |
Yes |
The region ID. |
cn-hangzhou |
| Type |
string |
No |
The type of the application. Set the value to TRACE. |
TRACE |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| Data |
string |
The result of turning on or off the main switch, or the current main switch status. When you turn on or off the switch, valid values:
When you query the main switch status, valid values:
|
abc@def success\nghi@jkl success\n |
| RequestId |
string |
The request ID. |
16AF921B-8187-489F-9913-43C808B4**** |
Examples
Success response
JSON format
{
"Data": "abc@def success\\nghi@jkl success\\n",
"RequestId": "16AF921B-8187-489F-9913-43C808B4****"
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 500 | InternalError | 必选参数不能为空 |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.