SearchTraces - Application Real-Time Monitoring Service - Alibaba Cloud Documentation Center

Queries 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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
StartTime	long	Yes	The timestamp of the start time of the time range to query. The timestamp is accurate to milliseconds.	1575561600000
EndTime	long	Yes	The timestamp of the end time of the time range to query. The timestamp is accurate to milliseconds.	1575622455686
RegionId	string	Yes	The ID of the region.	cn-beijing
ServiceName	string	No	The name of the application.	service 1
OperationName	string	No	The name of the span.	/api
MinDuration	long	No	The time more than which is used to call the trace. Unit: milliseconds. For example, a value of 100 specifies to return the traces that more than 100 milliseconds are used to call.	1000
AppType	string	No	The type of the application. You can set the value to XTRACE or leave this parameter unspecified.	XTRACE
PageNumber	integer	No	The number of the page to return. For example, a value of 5 indicates page 5.	1
PageSize	integer	No	The number of entries to return on each page.	100
Reverse	boolean	No	Specifies whether to sort the query results in chronological order or reverse chronological order. Default value: false. Valid values: true: reverse chronological order false: chronological order	false
ServiceIp	string	No	The IP address that corresponds to the span.	10.0.0.0
Tag	array<object>	No	The list of the tags.
	object	No	Tag.
Key	string	No	The key of the tag.	http.status_cod
Value	string	No	The value of the tag.	200

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	1E2B6A4C-6B83-4062-8B6F-AEEC1F******
PageBean	object	The information about the returned page.
PageSize	integer	The number of entries returned per page.	100
PageNumber	integer	The page number of the returned page.	1
TotalCount	long	The total number of entries returned.	1000
TraceInfos	array<object>	The information about the trace.
	object
OperationName	string	The name of the span.	/api
ServiceIp	string	The IP address of the server where the span resides.	192.163.XXX.XXX
Duration	long	The time used to call the trace. Unit: milliseconds.	100
Timestamp	long	The time when the span was generated. Unit: microseconds.	1575561600000000
ServiceName	string	The name of the application.	service1
TraceID	string	The ID of the trace.	1c6881aab84191a4
TagMap	object	The map of tags.	{"env":"dev"}

Examples

Sample success responses

JSONformat

{
  "RequestId": "1E2B6A4C-6B83-4062-8B6F-AEEC1F******",
  "PageBean": {
    "PageSize": 100,
    "PageNumber": 1,
    "TotalCount": 1000,
    "TraceInfos": {
      "TraceInfo": [
        {
          "OperationName": "/api",
          "ServiceIp": "192.163.XXX.XXX",
          "Duration": 100,
          "Timestamp": 1575561600000000,
          "ServiceName": "service1",
          "TraceID": "1c6881aab84191a4",
          "TagMap": {
            "env": "dev"
          }
        }
      ]
    }
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history