Use ListTraceApps to query application monitoring tasks - Application Real-Time Monitoring Service - Alibaba Cloud - Application Real-Time Monitoring Service

Queries all Application Monitoring tasks in a specified region.

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
RegionId	string	Yes	The region ID.	cn-hangzhou
ResourceGroupId	string	No	The resource group ID.	rg-acfmxyexli2****
Tags	array<object>	No	The tags.
	object	No
Key	string	No	The tag key.	TestKey
Value	string	No	The tag value.	TestValue
Region	string	No	The region ID.	cn-shenzhen
AppType	string	No	The type of the application that is associated with the alert rule. Valid values: TRACE: Application Monitoring EBPF: Application Monitoring eBPF Edition	TRACE

Response elements

Element	Type	Description	Example
	object
Code	integer	The HTTP status code returned for the request. Valid values: `2XX`: The request is successful. `3XX`: A redirection message is returned. `4XX`: The request is invalid. `5XX`: A server error occurs.	200
Message	string	The error message returned if the request parameters are invalid.	Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.
RequestId	string	The request ID.	40B10E04-81E8-4643-970D-F1B38F2E****
Success	boolean	Indicates whether the call was successful. Valid values: `true`: The call was successful. `false`: The call failed.	true
TraceApps	array<object>	The list of Application Monitoring tasks.
	array<object>	The returned struct.
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 time when the monitoring task was updated. The value is a timestamp. Unit: milliseconds.	1529667762000
Show	boolean	Indicates whether the application is visible in the ARMS console. Valid values: `true`: yes `false`: no	true
CreateTime	integer	The time when the monitoring task was created. The value is a timestamp. Unit: milliseconds.	1529667762000
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 labels of the application.
	string	The value of the application label.	prod
Tags	array<object>	The tags.
	object
Key	string	The tag key.	TestKey
Value	string	The tag value.	TestValue
ResourceGroupId	string	The resource group ID.	rg-acfmxyexli2****
Source	string	The application source.	ACK
WorkloadName	string	The name of the workload.	nginx-deployment
WorkloadKind	string	The type of the workload.	Deployment
Namespace	string	The namespace.	default
ClusterId	string	The cluster ID.	cc7a37ee31aea4ed1a059eff8034b****
Language	string	The language.	PHP

Examples

Success response

JSON format

{
  "Code": 200,
  "Message": "Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.",
  "RequestId": "40B10E04-81E8-4643-970D-F1B38F2E****",
  "Success": true,
  "TraceApps": [
    {
      "Type": "TRACE",
      "AppName": "test-app",
      "UpdateTime": 1529667762000,
      "Show": true,
      "CreateTime": 1529667762000,
      "Pid": "a5f9bdeb-2627-4dbe-9247-****",
      "AppId": 123,
      "UserId": "113197164949****",
      "RegionId": "cn-hangzhou",
      "Labels": [
        "prod"
      ],
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ],
      "ResourceGroupId": "rg-acfmxyexli2****",
      "Source": "ACK",
      "WorkloadName": "nginx-deployment ",
      "WorkloadKind": "Deployment",
      "Namespace": "default",
      "ClusterId": "cc7a37ee31aea4ed1a059eff8034b****",
      "Language": "PHP"
    }
  ]
}

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.