All Products
Search
Document Center

Application Real-Time Monitoring Service:ListTraceApps

Last Updated:Nov 05, 2024

Queries all Application Monitoring tasks in a specified region.

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.

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:ListTraceAppsnone
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

cn-hangzhou
ResourceGroupIdstringNo

The resource group ID.

rg-acfmxyexli2****
Tagsarray<object>No

The tags.

objectNo
KeystringNo

The tag key.

TestKey
ValuestringNo

The tag value.

TestValue
RegionstringNo

The region ID.

cn-shenzhen
AppTypestringNo

The type of the application that is associated with the alert rule. Valid values:

  • TRACE: Application Monitoring
  • EBPF: Application Monitoring eBPF Edition
TRACE

Response parameters

ParameterTypeDescriptionExample
object
Codeinteger

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
Messagestring

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.
RequestIdstring

The request ID.

40B10E04-81E8-4643-970D-F1B38F2E****
Successboolean

Indicates whether the call was successful. Valid values:

  • true: The call was successful.
  • false: The call failed.
true
TraceAppsarray<object>

The list of Application Monitoring tasks.

TraceAppobject

The returned struct.

Typestring

The type of the monitoring task. Valid values:

  • TRACE: Application Monitoring
  • RETCODE: Browser Monitoring
TRACE
AppNamestring

The name of the application.

test-app
UpdateTimelong

The time when the monitoring task was updated. The value is a timestamp. Unit: milliseconds.

1529667762000
Showboolean

Indicates whether the application is displayed in the Application Real-Time Monitoring Service (ARMS) console. Valid values:

  • true: yes
  • false: no
true
CreateTimelong

The time when the monitoring task was created. The value is a timestamp. Unit: milliseconds.

1529667762000
Pidstring

The process identifier (PID) of the application.

a5f9bdeb-2627-4dbe-9247-****
AppIdlong

The application ID.

123
UserIdstring

The user ID.

113197164949****
RegionIdstring

The region ID.

cn-hangzhou
Labelsarray

The labels of the application.

Labelsstring

The value of the application label.

prod
Tagsarray<object>

The tags.

Tagsobject
Keystring

The tag key.

TestKey
Valuestring

The tag value.

TestValue
ResourceGroupIdstring

The resource group ID.

Resource group
Sourcestring

The application source.

ACK
WorkloadNamestring

The name of the workload.

nginx-deployment
WorkloadKindstring

The type of the workload.

Deployment
Namespacestring

The namespace.

default
ClusterIdstring

The cluster ID.

cc7a37ee31aea4ed1a059eff8034b****
Languagestring

The language.

PHP

Examples

Sample success responses

JSONformat

{
  "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": "Resource group\n",
      "Source": "ACK",
      "WorkloadName": "nginx-deployment ",
      "WorkloadKind": "Deployment",
      "Namespace": "default",
      "ClusterId": "cc7a37ee31aea4ed1a059eff8034b****",
      "Language": "PHP"
    }
  ]
}

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-

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

Change history

Change timeSummary of changesOperation
2023-10-13The Error code has changed. The response structure of the API has changedView Change Details
2023-09-11The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedView Change Details
2023-08-09The Error code has changed. The request parameters of the API has changedView Change Details