SearchTraces - Managed Service for OpenTelemetry - Alibaba Cloud Documentation Center

Call the SearchTraces operation to query a list of traces. You can filter traces by time, application name, IP address, span name, tag, and other criteria.

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	Start time, in milliseconds (ms).	1714298814000
EndTime	integer	Yes	End time, in milliseconds (ms).	1714385214000
RegionId	string	Yes	Region ID.	cn-beijing
ServiceName	string	No	Microservice name, also known as application name.	service 1
OperationName	string	No	Span name, which is the name of a trace point or instrumentation point.	/api
MinDuration	integer	No	Minimum duration threshold in milliseconds (ms). For example, 200 returns traces longer than 200 ms.	2
AppType	string	No	Application type. Valid values are empty or `XTRACE`. We recommend leaving this parameter empty. Empty: Query traces from both XTRACE and ARMS. `XTRACE`: Query only XTRACE traces.	XTRACE
PageNumber	integer	No	Page number. For example, 5 indicates page 5.	1
PageSize	integer	No	Number of trace records per page.	20
Reverse	boolean	No	Sort order by time. Default value: `false`. Valid values: `true`: Descending order. `false`: Ascending order.	false
ServiceIp	string	No	IP address of the host where the span resides.	192.163.XXX.XXX
Tag	array<object>	No	List of tags.
	object	No	List of tags.
Key	string	No	Tag key.	http.status_cod
Value	string	No	Tag value.	200
StatusCode	string	No

Response elements

Element	Type	Description	Example
	object
RequestId	string	Request ID.	1E2B6A4C-6B83-4062-8B6F-AEEC1F******
PageBean	object	Pagination information for the returned data.
PageSize	integer	Number of records per page.	20
PageNumber	integer	Page number.	1
TotalCount	integer	Total number of records.	500
TraceInfos	object
TraceInfo	array<object>	Returned trace information.
	array<object>	Returned trace information.
OperationName	string	Span name.	/api
ServiceIp	string	IP address or hostname of the host where the span resides.	192.163.XXX.XXX
Duration	integer	Duration, in milliseconds (ms).	500
Timestamp	integer	Time when the span was generated, in milliseconds (ms).	1714306014000
ServiceName	string	Microservice name, also known as application name.	service1
TraceID	string	Trace ID.	1c6881aab841******
TagMap	object	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.