GetTraceApp - Application Real-Time Monitoring Service - Alibaba Cloud Documentation Center

Queries the details of an application monitoring task.

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

Request parameters

Parameter	Type	Required	Description	Example
Pid	string	Yes	The process identifier (PID) of the application. For more information about how to obtain the PID, see Obtain the PID of an application.	b590lhguqs@d8deedfa9bf****
RegionId	string	Yes	The region ID.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	D80ADAAC-8C32-5479-BD14-C28CF832****
TraceApp	object	The information about the 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.	arms-k8s-demo
UpdateTime	long	The timestamp generated when the task information was updated.	1635700348000
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.	1576599253000
Pid	string	The process identifier (PID) of the application.	b590lhguqs@d8deedfa9bf****
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 tags of the application.	[ "test", "123123123", "uat" ],
Tags	array<object>	A list of key-value pairs.
Tags	object
Key	string	The tag key.	TestKey
Value	string	The tag value.	TestValue
Source	string	The source of the application.	ACSK8S
ResourceGroupId	string	The ID of the resource group.	rg-acfmxyexli2****
ClusterId	string	Cluster ID, used only in K8s scenarios.	c905d1364c2dd4b6284a3f41790c4****
Language	string	Coding Language.	java

Examples

Sample success responses

JSONformat

{
  "RequestId": "D80ADAAC-8C32-5479-BD14-C28CF832****",
  "TraceApp": {
    "Type": "TRACE",
    "AppName": "arms-k8s-demo",
    "UpdateTime": 1635700348000,
    "Show": true,
    "CreateTime": 1576599253000,
    "Pid": "b590lhguqs@d8deedfa9bf****",
    "AppId": 123,
    "UserId": "113197164949****",
    "RegionId": "cn-hangzhou",
    "Labels": [
      "[       \"test\",       \"123123123\",       \"uat\"     ],"
    ],
    "Tags": [
      {
        "Key": "TestKey",
        "Value": "TestValue"
      }
    ],
    "Source": "ACSK8S",
    "ResourceGroupId": "rg-acfmxyexli2****",
    "ClusterId": "c905d1364c2dd4b6284a3f41790c4****",
    "Language": "java"
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-05-30	The response structure of the API has changed	View Change Details
2023-06-25	The request parameters of the API has changed	View Change Details