All Products
Search
Document Center

Application Real-Time Monitoring Service:ConfigApp

Last Updated:Feb 01, 2024

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
arms:ConfigAppWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
AppIdsstringYes

The process identifier (PID) of the application. Separate multiple PIDs with commas (,).

iioe7jcnuk@582846f37******,atc889zkcf@d8deedfa9bf******
EnablestringNo

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
RegionIdstringYes

The region ID.

cn-hangzhou
TypestringNo

The type of the application. Set the value to TRACE.

TRACE

Response parameters

ParameterTypeDescriptionExample
object
Datastring

The result of turning on or off the main switch of the ARMS agent or the main switch status of the ARMS agent. Indicates whether the request was successful. Valid values: success failed The main switch status of the ARMS agent. Valid values: true false

abc@def success\nghi@jkl success\n
RequestIdstring

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 codeError codeError messageDescription
500InternalErrorInternal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.
500InternalError-
500InternalError-
500InternalError-

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

Change history

Change timeSummary of changesOperation
No change history