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

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 Amazon X-Ray SDK. Downstream services can be other applications, Amazon resources, HTTP web APIs, or SQL databases.

Request Syntax


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

{
   "EndTime": number,
   "GroupARN": "string",
   "GroupName": "string",
   "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 timeframe for which to generate a graph, in Unix time seconds.

Type: Timestamp

Required: Yes

GroupARN

The Amazon Resource Name (ARN) of a group based on which you want to generate a graph.

Type: String

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

Required: No

GroupName

The name of a group based on which you want to generate a graph.

Type: String

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

Required: No

NextToken

Pagination token.

Type: String

Required: No

StartTime

The start of the time frame for which to generate a graph, in Unix time seconds.

Type: Timestamp

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ContainsOldGroupVersions": boolean,
   "EndTime": number,
   "NextToken": "string",
   "Services": [ 
      { 
         "AccountId": "string",
         "DurationHistogram": [ 
            { 
               "Count": number,
               "Value": number
            }
         ],
         "Edges": [ 
            { 
               "Aliases": [ 
                  { 
                     "Name": "string",
                     "Names": [ "string" ],
                     "Type": "string"
                  }
               ],
               "EdgeType": "string",
               "EndTime": number,
               "ReceivedEventAgeHistogram": [ 
                  { 
                     "Count": number,
                     "Value": 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.

ContainsOldGroupVersions

A flag indicating whether the group's filter expression has been consistent, or if the returned service graph may show traces from an older version of the group's filter expression.

Type: Boolean

EndTime

The end of the time frame for which the graph was generated, in Unix time seconds.

Type: Timestamp

NextToken

Pagination token.

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, in Unix time seconds.

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