SearchTracesByPage - Query traces with pagination | ARMS API - Application Real-Time Monitoring Service

Queries traces by page based on time range, application name, IP address, span name, or tag.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
StartTime	integer	Yes	Start of the query time range, in milliseconds.	1595174400000
EndTime	integer	Yes	End of the query time range, in milliseconds.	1595210400000
RegionId	string	Yes	Region ID.	cn-hangzhou
ServiceName	string	No	Application name.	arms-k8s-demo-subcomponent
OperationName	string	No	Span name.	/demo/queryNotExistDB/11
MinDuration	integer	No	Minimum trace duration, in milliseconds.	2
Reverse	boolean	No	Whether to sort results in reverse chronological order. Default: `false`. `true`: reverse chronological order. `false`: chronological order.	false
ServiceIp	string	No	IP address of the application host.	172.20.XX.XX
PageNumber	integer	No	Page number to return.	1
PageSize	integer	No	Entries per page. Maximum: 100.	5
Pid	string	No	Application ID.	b590lhguqs@9781be0f44dXXXX
ExclusionFilters	array<object>	No	Filter conditions.
	object	No
Key	string	No	Filter key.	http.status_code
Value	string	No	Filter value.	404
Tags	array<object>	No	Tag filters.
	object	No
Key	string	No	Tag key. System preset fields: traceId: trace ID. serverApp: server application name. clientApp: client application name. service: interface name. rpc: call type. msOfSpan: duration exceeds a specific value. clientIp: client IP address. serverIp: server IP address. isError: whether the call is abnormal.	http.status_code
Value	string	No	Tag value.	200
IsError	boolean	No	Whether to exclude abnormal call traces. `true`: exclude abnormal call traces. `false` (default): include all traces.	false

Response elements

Element	Type	Description	Example
	object
RequestId	string	Request ID.	4C518054-852F-4023-ABC1-4AF95FF7****
PageBean	object	Paginated response data.
PageNumber	integer	Page number.	1
PageSize	integer	Entries per page.	5
Total	integer	Total entries.	1601
TraceInfos	array<object>	Trace details.
	object
OperationName	string	Span name.	/demo/queryException/12
ServiceIp	string	IP address of the application host.	172.20.XX.XX
Duration	integer	Trace duration, in milliseconds.	679
Timestamp	integer	Timestamp.	1595174436994
ServiceName	string	Application name.	arms-k8s-demo-subcomponent
TraceID	string	Trace ID.	ac1400a115951744369947025d****
SpanID	string	Span ID.	be3d6dcf5750e***

Examples

Success response

JSON format

{
  "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****",
        "SpanID": "be3d6dcf5750e***"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.