Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

BatchGetTraces

Note

You cannot find traces through this API if Transaction Search is enabled since trace is not indexed in X-Ray.

Retrieves a list of traces specified by ID. Each trace is a collection of segment documents that originates from a single request. Use GetTraceSummaries to get a list of trace IDs.

Request Syntax


POST /Traces HTTP/1.1
Content-type: application/json

{
   "NextToken": "string",
   "TraceIds": [ "string" ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

NextToken

Pagination token.

Type: String

Required: No

TraceIds

Specify the trace IDs of requests for which to retrieve segments.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 5 items.

Length Constraints: Minimum length of 1. Maximum length of 35.

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Traces": [ 
      { 
         "Duration": number,
         "Id": "string",
         "LimitExceeded": boolean,
         "Segments": [ 
            { 
               "Document": "string",
               "Id": "string"
            }
         ]
      }
   ],
   "UnprocessedTraceIds": [ "string" ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

Pagination token.

Type: String

Traces

Full traces for the specified requests.

Type: Array of Trace objects

UnprocessedTraceIds

Trace IDs of requests that haven't been processed.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 35.

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidRequestException

The request is missing required parameters or has invalid parameters.

HTTP Status Code: 400

ThrottledException

The request exceeds the maximum number of requests per second.

HTTP Status Code: 429