Queries all existing traces by time, application name, IP address, span name, and tag.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes SearchTracesByPage

The operation that you want to perform. Set the value to SearchTracesByPage.

StartTime Long Yes 1595174400000

The beginning of the time range to query. Unit: milliseconds.

EndTime Long Yes 1595210400000

The end of the time range to query. Unit: milliseconds.

RegionId String Yes cn-hangzhou

The ID of the region.

ServiceName String No arms-k8s-demo-subcomponent

The name of the application.

OperationName String No /demo/queryNotExistDB/11

The name of the traced span.

MinDuration Long No 2

The minimum amount of time consumed by traces. Unit: milliseconds.

Reverse Boolean No false

Specifies whether to sort the query results in chronological order or reverse chronological order. Default value: false.

  • true: sorts the query results in reverse chronological order.
  • false: sorts the query results in chronological order.
ServiceIp String No 172.20.XX.XX

The IP address of the host where the application resides.

PageNumber Integer No 1

The number of the page to return.

PageSize Integer No 5

The number of entries to return on each page. Maximum value: 100.

Pid String No b590lhguqs@9781be0f44dXXXX

The ID of the application.

ExclusionFilters.N.Key String No http.status_code

The key that is used to filter the query results.

ExclusionFilters.N.Value String No 404

The value of the key that is used to filter the query results.

Tags.N.Key String No http.status_code

The key of the tag.

Tags.N.Value String No 200

The value of the tag.

Response parameters

Parameter Type Example Description
RequestId String 4C518054-852F-4023-ABC1-4AF95FF7****

The ID of the request.

PageBean Object

The struct returned.

PageNumber Integer 1

The page number of the returned page.

PageSize Integer 5

The number of entries returned per page.

Total Integer 1601

The total number of returned entries.

TraceInfos Array of TraceInfo

The details of the returned traces.

OperationName String /demo/queryException/12

The name of the traced span.

ServiceIp String 172.20.XX.XX

The IP address of the host where the application resides.

Duration Long 679

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

Timestamp Long 1595174436994

The timestamp.

ServiceName String arms-k8s-demo-subcomponent

The name of the application.

TraceID String ac1400a115951744369947025d****

The ID of the trace.

Examples

Sample requests

http(s)://[Endpoint]/?Action=SearchTracesByPage
&StartTime=1595174400000
&EndTime=1595210400000
&RegionId=cn-hangzhou
&ServiceName=arms-k8s-demo-subcomponent
&OperationName=/demo/queryNotExistDB/11
&MinDuration=2
&Reverse=false
&ServiceIp=172.20.XX.XX
&PageNumber=1
&PageSize=5
&Pid=b590lhguqs@9781be0f44dXXXX
&ExclusionFilters=[{"Key":"http.status_code","Value":"404"}]
&Tags=[{"Key":"http.status_code","Value":"200"}]
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<SearchTracesByPageResponse>
    <RequestId>4C518054-852F-4023-ABC1-4AF95FF7****</RequestId>
    <PageBean>
        <PageNumber>1</PageNumber>
        <PageSize>5</PageSize>
        <Total>1601</Total>
        <TraceInfos>
            <OperationName>/demo/queryException/12</OperationName>
            <ServiceIp>172.20.XX.XX</ServiceIp>
            <Duration>679</Duration>
            <Timestamp>1595174436994</Timestamp>
            <ServiceName>arms-k8s-demo-subcomponent</ServiceName>
            <TraceID>ac1400a115951744369947025d****</TraceID>
        </TraceInfos>
    </PageBean>
</SearchTracesByPageResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "4C518054-852F-4023-ABC1-4AF95FF7****",
  "PageBean" : {
    "PageNumber" : 1,
    "PageSize" : 5,
    "Total" : 1601,
    "TraceInfos" : [ {
      "OperationName" : "/demo/queryException/12",
      "ServiceIp" : "172.20.XX.XX",
      "Duration" : 679,
      "Timestamp" : 1595174436994,
      "ServiceName" : "arms-k8s-demo-subcomponent",
      "TraceID" : "ac1400a115951744369947025d****"
    } ]
  }
}