All Products
Search
Document Center

Application Real-Time Monitoring Service:ListServices

Last Updated:Aug 08, 2024

Queries applications.

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

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region.

cn-beijing
AppTypestringNo

The type of the application. You can leave this parameter empty or set this parameter to XTRACE. We recommend that you leave this parameter empty.

  • If you leave this parameter empty, applications monitored by Managed Service for OpenTelemetry or Application Real-Time Monitoring Service (ARMS) can be queried.
  • If you set this parameter to XTRACE, only applications monitored by Managed Service for OpenTelemetry can be queried.
XTRACE

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the region.

1E2B6A4C-6B83-4062-8B6F-AEEC1FC47DED
Servicesarray<object>

The applications.

object

The applications.

ServiceNamestring

The name of the application.

a3
Pidstring

The ID of the application.

XXXqn3ly@741623b4e915df8
RegionIdstring

The ID of the region.

cn-beijing

Examples

Sample success responses

JSONformat

{
  "RequestId": "1E2B6A4C-6B83-4062-8B6F-AEEC1FC47DED",
  "Services": {
    "Service": [
      {
        "ServiceName": "a3",
        "Pid": "XXXqn3ly@741623b4e915df8",
        "RegionId": "cn-beijing"
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history