All Products
Search
Document Center

Application Real-Time Monitoring Service:SearchTraceAppByName

Last Updated:May 09, 2024

Queries Application Monitoring tasks by application name.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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

Request parameters

ParameterTypeRequiredDescriptionExample
TraceAppNamestringYes

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
RegionIdstringNo

The region ID.

cn-hangzhou
Tagsobject []No

The list of tags.

KeystringNo

The tag key.

TestKey
ValuestringNo

The tag value.

TestValue

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

F7781D4A-2818-41E7-B7BB-79D809E9****
TraceAppsobject []

The information about the monitoring task.

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 timestamp generated when the task information was updated.

1593486786000
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 timestamp generated when the task was created.

1593486786000
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 aliases of the application.

string

The alias of the application.

prod
Tagsobject []

A list of tags.

Keystring

The tag key.

TestKey
Valuestring

The tag value.

TestValue
ResourceGroupIdstring

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 timeSummary of changesOperation
2023-06-25The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: Tags