AWS X-Ray Service Graph API

Service map and statistics

OpenAPI Specification

aws-x-ray-service-graph-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: AWS X-Ray Encryption Service Graph API
  description: AWS X-Ray provides APIs for managing trace data, sampling rules, groups, and encryption configuration. X-Ray helps developers analyze and debug distributed applications by collecting trace data as requests travel through application components.
  version: '2016-04-12'
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/xray/
servers:
- url: https://xray.{region}.amazonaws.com
  description: AWS X-Ray regional endpoint
  variables:
    region:
      default: us-east-1
      description: AWS region
security:
- aws_sig_v4: []
tags:
- name: Service Graph
  description: Service map and statistics
paths:
  /ServiceGraph:
    post:
      operationId: GetServiceGraph
      summary: AWS X-Ray Get the Service Graph
      description: Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result.
      tags:
      - Service Graph
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - StartTime
              - EndTime
              properties:
                StartTime:
                  type: string
                  format: date-time
                EndTime:
                  type: string
                  format: date-time
                GroupName:
                  type: string
                GroupARN:
                  type: string
                NextToken:
                  type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetServiceGraphResult'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /TimeSeriesServiceStatistics:
    post:
      operationId: GetTimeSeriesServiceStatistics
      summary: AWS X-Ray Get Time Series Service Statistics
      description: Get an aggregation of service statistics over a time period.
      tags:
      - Service Graph
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - StartTime
              - EndTime
              properties:
                StartTime:
                  type: string
                  format: date-time
                EndTime:
                  type: string
                  format: date-time
                GroupName:
                  type: string
                GroupARN:
                  type: string
                EntitySelectorExpression:
                  type: string
                Period:
                  type: integer
                ForecastStatistics:
                  type: boolean
                NextToken:
                  type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  TimeSeriesServiceStatistics:
                    type: array
                    items:
                      $ref: '#/components/schemas/TimeSeriesServiceStatistics'
                  ContainsOldGroupVersions:
                    type: boolean
                  NextToken:
                    type: string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    HistogramEntry:
      type: object
      properties:
        Value:
          type: number
        Count:
          type: integer
    GetServiceGraphResult:
      type: object
      properties:
        StartTime:
          type: string
          format: date-time
        EndTime:
          type: string
          format: date-time
        Services:
          type: array
          items:
            $ref: '#/components/schemas/Service'
        ContainsOldGroupVersions:
          type: boolean
        NextToken:
          type: string
    ServiceStatistics:
      type: object
      properties:
        OkCount:
          type: integer
          format: int64
        ErrorStatistics:
          type: object
          properties:
            ThrottleCount:
              type: integer
              format: int64
            OtherCount:
              type: integer
              format: int64
            TotalCount:
              type: integer
              format: int64
        FaultStatistics:
          type: object
          properties:
            OtherCount:
              type: integer
              format: int64
            TotalCount:
              type: integer
              format: int64
        TotalCount:
          type: integer
          format: int64
        TotalResponseTime:
          type: number
    Service:
      type: object
      properties:
        ReferenceId:
          type: integer
        Name:
          type: string
        Names:
          type: array
          items:
            type: string
        Root:
          type: boolean
        AccountId:
          type: string
        Type:
          type: string
        State:
          type: string
        StartTime:
          type: string
          format: date-time
        EndTime:
          type: string
          format: date-time
        Edges:
          type: array
          items:
            type: object
            properties:
              ReferenceId:
                type: integer
              StartTime:
                type: string
                format: date-time
              EndTime:
                type: string
                format: date-time
              SummaryStatistics:
                $ref: '#/components/schemas/EdgeStatistics'
              ResponseTimeHistogram:
                type: array
                items:
                  $ref: '#/components/schemas/HistogramEntry'
        SummaryStatistics:
          $ref: '#/components/schemas/ServiceStatistics'
        ResponseTimeHistogram:
          type: array
          items:
            $ref: '#/components/schemas/HistogramEntry'
        DurationHistogram:
          type: array
          items:
            $ref: '#/components/schemas/HistogramEntry'
    TimeSeriesServiceStatistics:
      type: object
      properties:
        Timestamp:
          type: string
          format: date-time
        EdgeSummaryStatistics:
          $ref: '#/components/schemas/EdgeStatistics'
        ServiceSummaryStatistics:
          $ref: '#/components/schemas/ServiceStatistics'
        ServiceForecastStatistics:
          type: object
          properties:
            FaultCountHigh:
              type: integer
              format: int64
            FaultCountLow:
              type: integer
              format: int64
        ResponseTimeHistogram:
          type: array
          items:
            $ref: '#/components/schemas/HistogramEntry'
    EdgeStatistics:
      type: object
      properties:
        OkCount:
          type: integer
          format: int64
        ErrorStatistics:
          type: object
          properties:
            ThrottleCount:
              type: integer
              format: int64
            OtherCount:
              type: integer
              format: int64
            TotalCount:
              type: integer
              format: int64
        FaultStatistics:
          type: object
          properties:
            OtherCount:
              type: integer
              format: int64
            TotalCount:
              type: integer
              format: int64
        TotalCount:
          type: integer
          format: int64
        TotalResponseTime:
          type: number
  securitySchemes:
    aws_sig_v4:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4