SearchTraceAppByName - Query Application Monitoring tasks | ARMS API - Application Real-Time Monitoring Service

Queries Application Monitoring tasks by name.

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
TraceAppName	string	No	The name of the application. Note If not specified, all Application Monitoring tasks in the region are queried.	test-app
RegionId	string	No	The region ID.	cn-hangzhou
Tags	array<object>	No	The list of tags.
	object	No
Key	string	No	The tag key.	TestKey
Value	string	No	The tag value.	TestValue

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	F7781D4A-2818-41E7-B7BB-79D809E9****
TraceApps	array<object>	The monitoring task details.
	array<object>
Type	string	The type of the monitoring task. Valid values: `TRACE`: Application Monitoring `RETCODE`: Browser Monitoring	TRACE
AppName	string	The name of the application.	test-app
UpdateTime	integer	The timestamp when the task was updated.	1593486786000
Show	boolean	Whether the application is visible in the ARMS console. Valid values: `true`: yes `false`: no	true
CreateTime	integer	The timestamp when the task was created.	1593486786000
Pid	string	The process identifier (PID) of the application.	a5f9bdeb-2627-4dbe-9247-****
AppId	integer	The application ID.	123
UserId	string	The user ID.	113197164949****
RegionId	string	The region ID.	cn-hangzhou
Labels	array	The aliases of the application.
	string	The alias of the application.	prod
Tags	array<object>	A list of tags.
	object
Key	string	The tag key.	TestKey
Value	string	The tag value.	TestValue
ResourceGroupId	string	The ID of the resource group.	rg-acfmxyexli2****

Examples

Success response

JSON format

{
  "RequestId": "F7781D4A-2818-41E7-B7BB-79D809E9****",
  "TraceApps": [
    {
      "Type": "TRACE",
      "AppName": "test-app",
      "UpdateTime": 1593486786000,
      "Show": true,
      "CreateTime": 1593486786000,
      "Pid": "a5f9bdeb-2627-4dbe-9247-****",
      "AppId": 123,
      "UserId": "113197164949****",
      "RegionId": "cn-hangzhou",
      "Labels": [
        "prod"
      ],
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ],
      "ResourceGroupId": "rg-acfmxyexli2****"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.