All Products
Search
Document Center

Application Real-Time Monitoring Service:GetMultipleTrace

Last Updated:Nov 05, 2024

Queries the details of one or more traces.

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

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

cn-hangzhou
TraceIDsarrayYes

The trace IDs.

stringYes

The trace ID. You can specify one to nine trace IDs. You can log on to the Application Real-Time Monitoring Service (ARMS) console and obtain the trace ID on the Trace Query page.

ac1400a115951745017447033d****
StartTimelongNo

The start time of the trace. The value is a timestamp. Unit: milliseconds.

1657692507000
EndTimelongNo

The time when the trace ends. The value is a timestamp. Unit: milliseconds.

1663999380000

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

2983BEF7-4A0D-47A2-94A2-8E9C5E63****
MultiCallChainInfosarray<object>

The details of traces.

MultiCallChainInfoobject
TraceIDstring

The trace ID.

ac1400a115951745017447033d****
Spansarray<object>

The details of the trace.

Spanobject
SpanIdstring

The span ID.

1234
OperationNamestring

The name of the traced span.

/demo/queryNotExistDB/11
ResultCodestring

The status code returned.

1
Timestamplong

The timestamp.

1595174501747
RpcTypeinteger

The type of the remote procedure call (RPC) mode.

  • 0: HTTP entry
  • 25: HTTP call
  • 1: High-speed Service Framework (HSF) call
  • 2: HSF provision
  • 40: on-premises API call
  • 60: MySQL call
  • 62: Oracle call
  • 63: PostgreSQL call
  • 70: Redis call
  • 4: Taobao Distributed Data Layer (TDDL) call
  • 5: Tair call
  • 13: MetaQ message sending
  • 252: MetaQ message receiving
  • 3: notification sending
  • 254: notification receiving
  • 7: Apache Dubbo call
  • 8: Apache Dubbo provision
  • 19: SOFARPC call
  • 18: SOFARPC provision
  • 11: Distributed Service Framework (DSF) call
  • 12: DSF provision
  • -1: unknown call
0
ServiceIpstring

The IP address of the host where the application resides.

172.20.XX.XX
HaveStackboolean

Indicates whether a method stack was provided.

  • true: A method stack was provided.
  • false: No method stack was provided.
true
ParentSpanIdstring

The ID of the parent span.

18
Durationlong

The amount of time consumed by the trace. Unit: milliseconds.

11
RpcIdstring

RPC ID

0.1
ServiceNamestring

The name of the application.

arms-k8s-demo-subcomponent
TraceIDstring

The trace ID.

ac1400a115951745017447033d****
TagEntryListarray<object>

The tags of the trace.

TagEntryobject
Keystring

The key of the tag.

http.status.code
Valuestring

The value of the tag.

200
LogEventListarray<object>

The log events in the trace.

LogEventobject
Timestamplong

The time when the log was generated. The value is a timestamp.

1595174501747
TagEntryListarray<object>

The tags of the trace.

TagEntryobject
Keystring

The key of the tag.

http.status.code
Valuestring

The value of the tag.

200

Examples

Sample success responses

JSONformat

{
  "RequestId": "2983BEF7-4A0D-47A2-94A2-8E9C5E63****",
  "MultiCallChainInfos": [
    {
      "TraceID": "ac1400a115951745017447033d****",
      "Spans": [
        {
          "SpanId": "1234",
          "OperationName": "/demo/queryNotExistDB/11",
          "ResultCode": "1",
          "Timestamp": 1595174501747,
          "RpcType": 0,
          "ServiceIp": "172.20.XX.XX",
          "HaveStack": true,
          "ParentSpanId": "18",
          "Duration": 11,
          "RpcId": "0.1",
          "ServiceName": "arms-k8s-demo-subcomponent",
          "TraceID": "ac1400a115951745017447033d****",
          "TagEntryList": [
            {
              "Key": "http.status.code",
              "Value": "200"
            }
          ],
          "LogEventList": [
            {
              "Timestamp": 1595174501747,
              "TagEntryList": [
                {
                  "Key": "http.status.code",
                  "Value": "200"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-08-16The internal configuration of the API is changed, but the call is not affectedView Change Details
2023-12-21The internal configuration of the API is changed, but the call is not affectedView Change Details