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

GetServiceGraph

Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result. Root services process incoming requests and make calls to downstream services. Root services are applications that use the AWS X-Ray SDK. Downstream services can be other applications, AWS resources, HTTP web APIs, or SQL databases.

Request Syntax

Copy
POST /ServiceGraph HTTP/1.1 Content-type: application/json { "EndTime": number, "NextToken": "string", "StartTime": number }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

EndTime

The end of the time frame for which to generate a graph.

Type: Timestamp

Required: Yes

NextToken

Pagination token. Not used.

Type: String

Required: No

StartTime

The start of the time frame for which to generate a graph.

Type: Timestamp

Required: Yes

Response Syntax

Copy
HTTP/1.1 200 Content-type: application/json { "EndTime": number, "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" } ], "StartTime": number }

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.

EndTime

The end of the time frame for which the graph was generated.

Type: Timestamp

NextToken

Pagination token. Not used.

Type: String

Services

The services that have processed a traced request during the specified time frame.

Type: Array of Service objects

StartTime

The start of the time frame for which the graph was generated.

Type: Timestamp

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: