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

The SearchTraces operation queries a list of traces. You can filter traces by time, application name, IP address, span name, and tags.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

xtrace:SearchTrace

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
StartTime	integer	Yes	The start time. The value is a timestamp in milliseconds (ms).	1714298814000
EndTime	integer	Yes	The end time. The value is a timestamp in milliseconds (ms).	1714385214000
RegionId	string	Yes	The region ID.	cn-beijing
ServiceName	string	No	The name of the microservice, also known as the application name.	service 1
OperationName	string	No	The span name. This is the name of a trace point or an instrumentation point.	/api
MinDuration	integer	No	The minimum duration of a trace. Unit: milliseconds (ms). For example, a value of 200 returns traces that last longer than 200 ms.	2
AppType	string	No	The application type. Valid values are empty or `XTRACE`. Empty (Recommended): Queries traces from both XTRACE and Application Real-Time Monitoring Service (ARMS). `XTRACE`: Queries only traces from XTRACE.	XTRACE
PageNumber	integer	No	The page number. For example, a value of 5 specifies the fifth page.	1
PageSize	integer	No	The number of entries to return on each page.	20
Reverse	boolean	No	Specifies whether to sort the results in chronological or reverse chronological order. The default value is `false`. Valid values: `true`: reverse chronological order. `false`: chronological order.	false
ServiceIp	string	No	The IP address of the host where the span resides.	192.163.XXX.XXX
Tag	array<object>	No	A list of tags.
	object	No	A list of tags.
Key	string	No	The tag key.	http.status_cod
Value	string	No	The tag value.	200
StatusCode	string	No

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	1E2B6A4C-6B83-4062-8B6F-AEEC1F******
PageBean	object	The pagination information for the returned data.
PageSize	integer	The number of entries returned per page.	20
PageNumber	integer	The page number.	1
TotalCount	integer	The total number of entries.	500
TraceInfos	object
TraceInfo	array<object>	The information about the returned traces.
	array<object>	The information about the returned traces.
OperationName	string	The span name.	/api
ServiceIp	string	The IP address or hostname of the host where the span resides.	192.163.XXX.XXX
Duration	integer	The duration. Unit: milliseconds (ms).	500
Timestamp	integer	The time when the span was generated. Unit: milliseconds (ms).	1714306014000
ServiceName	string	The name of the microservice, also known as the application name.	service1
TraceID	string	The trace ID.	1c6881aab841******
TagMap	object	The tag information.	{"env":"dev"}
StatusCode	integer

Examples

Success response

JSON format

{
  "RequestId": "1E2B6A4C-6B83-4062-8B6F-AEEC1F******",
  "PageBean": {
    "PageSize": 20,
    "PageNumber": 1,
    "TotalCount": 500,
    "TraceInfos": {
      "TraceInfo": [
        {
          "OperationName": "/api",
          "ServiceIp": "192.163.XXX.XXX",
          "Duration": 500,
          "Timestamp": 1714306014000,
          "ServiceName": "service1",
          "TraceID": "1c6881aab841******",
          "TagMap": {
            "env": "dev"
          },
          "StatusCode": 0
        }
      ]
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.