SearchTraceAppByName - Application Real-Time Monitoring Service

Queries Application Monitoring tasks by application name.

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:SearchTraceAppByName	get	TraceApp acs:arms:{#regionId}:{#AccountId}:traceapp/{#Pid}	none	none

Request parameters

Parameter	Type	Required	Description	Example
TraceAppName	string	Yes	The name of the application. Note If you do not specify this parameter, all application monitoring tasks in the specified 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 parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	F7781D4A-2818-41E7-B7BB-79D809E9****
TraceApps	array<object>	The information about the monitoring task.
TraceApp	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	long	The timestamp generated when the task information was updated.	1593486786000
Show	boolean	Indicates whether the application is displayed in the Application Real-Time Monitoring Service (ARMS) console. Valid values: `true`: yes `false`: no	true
CreateTime	long	The timestamp generated when the task was created.	1593486786000
Pid	string	The process identifier (PID) of the application.	a5f9bdeb-2627-4dbe-9247-****
AppId	long	The application ID.	123
UserId	string	The user ID.	113197164949****
RegionId	string	The region ID.	cn-hangzhou
Labels	array	The aliases of the application.
Labels	string	The alias of the application.	prod
Tags	array<object>	A list of tags.
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

Sample success responses

JSONformat

{
  "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

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

Change history

Change time	Summary of changes	Operation
2023-06-25	The request parameters of the API has changed	View Change Details