All Products
Search
Document Center

Application Real-Time Monitoring Service:ConfigApp

Last Updated:Aug 28, 2026

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

Operation description


Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

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: 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 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:

  • success

  • failed

When you query the main switch status, valid values:

  • true

  • false

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.