AWS X-Ray
API Reference (API Version 2016-04-12)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

GetTraceGraph

Retrieves a service graph for one or more specific trace IDs.

Request Syntax

POST /TraceGraph 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

Trace IDs of requests for which to generate a service graph.

Type: Array of strings

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

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "Services": [ { "AccountId": "string", "DurationHistogram": [ { "Count": number, "Value": number } ], "Edges": [ { "Aliases": [ { "Name": "string", "Names": [ "string" ], "Type": "string" } ], "EndTime": number, "ReferenceId": number, "ResponseTimeHistogram": [ { "Count": number, "Value": number } ], "StartTime": number, "SummaryStatistics": { "ErrorStatistics": { "OtherCount": number, "ThrottleCount": number, "TotalCount": number }, "FaultStatistics": { "OtherCount": number, "TotalCount": number }, "OkCount": number, "TotalCount": number, "TotalResponseTime": number } } ], "EndTime": number, "Name": "string", "Names": [ "string" ], "ReferenceId": number, "ResponseTimeHistogram": [ { "Count": number, "Value": number } ], "Root": boolean, "StartTime": number, "State": "string", "SummaryStatistics": { "ErrorStatistics": { "OtherCount": number, "ThrottleCount": number, "TotalCount": number }, "FaultStatistics": { "OtherCount": number, "TotalCount": number }, "OkCount": number, "TotalCount": number, "TotalResponseTime": number }, "Type": "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

Services

The services that have processed one of the specified requests.

Type: Array of Service objects

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: