AWS X-Ray - API Reference

1 AWS X-RayAPI ReferenceAPI Version 2016-04-12 AWS X-Ray API ReferenceAWS X-Ray : API ReferenceCopyright 2018 Amazon Web Services, Inc. and/or its affiliates. All rights 's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any mannerthat is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks notowned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored X-Ray API ReferenceTable of ContentsWelcome .. 1 Actions .. 2 BatchGetTraces .. 3 Request Syntax .. 3 URI Request Parameters .. 3 Request Body .. 3 Response Syntax .. 3 Response Elements .. 4 Errors .. 4 See Also.. 4 CreateSamplingRule .. 6 Request Syntax .. 6 URI Request Parameters .. 6 Request Body.

2 6 Response Syntax .. 6 Response Elements .. 7 Errors .. 7 See Also.. 7 DeleteSamplingRule.. 9 Request Syntax .. 9 URI Request Parameters .. 9 Request Body .. 9 Response Syntax .. 9 Response Elements .. 10 Errors .. 10 See Also.. 10 GetEncryptionConfig .. 11 Request Syntax .. 11 URI Request Parameters .. 11 Request Body .. 11 Response Syntax .. 11 Response Elements .. 11 Errors .. 11 See Also.. 12 GetSamplingRules.. 13 Request Syntax .. 13 URI Request Parameters .. 13 Request Body .. 13 Response Syntax .. 13 Response Elements .. 14 Errors .. 14 See Also.. 14 GetSamplingStatisticSummaries.. 15 Request Syntax .. 15 URI Request Parameters .. 15 Request Body .. 15 Response Syntax .. 15 Response Elements .. 15 Errors .. 16 See Also.. 16 GetSamplingTargets .. 17 Request Syntax.

3 17 URI Request Parameters .. 17 Request Body .. 17 API Version 2016-04-12iiiAWS X-Ray API ReferenceResponse Syntax .. 17 Response Elements .. 18 Errors .. 18 See Also.. 18 GetServiceGraph .. 20 Request Syntax .. 20 URI Request Parameters .. 20 Request Body .. 20 Response Syntax .. 20 Response Elements .. 22 Errors .. 22 See Also.. 22 GetTraceGraph .. 24 Request Syntax .. 24 URI Request Parameters .. 24 Request Body .. 24 Response Syntax .. 24 Response Elements .. 26 Errors .. 26 See Also.. 26 GetTraceSummaries .. 27 Request Syntax .. 27 URI Request Parameters .. 27 Request Body .. 27 Response Syntax .. 28 Response Elements .. 29 Errors .. 30 See Also.. 30 PutEncryptionConfig .. 31 Request Syntax .. 31 URI Request Parameters .. 31 Request Body .. 31 Response Syntax .. 31 Response Elements.

4 32 Errors .. 32 See Also.. 32 PutTelemetryRecords .. 33 Request Syntax .. 33 URI Request Parameters .. 33 Request Body .. 33 Response Syntax .. 34 Response Elements .. 34 Errors .. 34 See Also.. 34 PutTraceSegments .. 35 Request Syntax .. 35 URI Request Parameters .. 35 Request Body .. 35 Response Syntax .. 36 Response Elements .. 36 Errors .. 36 See Also.. 36 UpdateSamplingRule.. 38 Request Syntax .. 38 URI Request Parameters .. 38 Request Body .. 38 Response Syntax .. 38 API Version 2016-04-12ivAWS X-Ray API ReferenceResponse Elements .. 39 Errors .. 39 See Also.. 39 Data Types .. 41 Alias.. 42 Contents.. 42 See Also.. 42 AnnotationValue .. 43 Contents.. 43 See Also.. 43 BackendConnectionErrors .. 44 Contents.. 44 See Also.. 44 Edge .. 45 Contents.. 45 See Also.. 45 EdgeStatistics.

5 47 Contents.. 47 See Also.. 47 EncryptionConfig .. 48 Contents.. 48 See Also.. 48 ErrorStatistics .. 49 Contents.. 49 See Also.. 49 FaultStatistics .. 50 Contents.. 50 See Also.. 50 HistogramEntry .. 51 Contents.. 51 See Also.. 51 Http .. 52 Contents.. 52 See Also.. 52 SamplingRule.. 53 Contents.. 53 See Also.. 55 SamplingRuleRecord .. 56 Contents.. 56 See Also.. 56 SamplingRuleUpdate.. 57 Contents.. 57 See Also.. 58 SamplingStatisticsDocument.. 60 Contents.. 60 See Also.. 61 SamplingStatisticSummary .. 62 Contents.. 62 See Also.. 62 SamplingTargetDocument .. 63 Contents.. 63 See Also.. 63 Segment.. 64 Contents.. 64 See Also.. 64 Service .. 65 Contents.. 65 API Version 2016-04-12vAWS X-Ray API ReferenceSee Also.. 66 ServiceId .. 68 Contents.. 68 See Also.. 68 ServiceStatistics.

6 69 Contents.. 69 See Also.. 69 TelemetryRecord .. 70 Contents.. 70 See Also.. 70 Trace .. 71 Contents.. 71 See Also.. 71 TraceSummary .. 72 Contents.. 72 See Also.. 73 TraceUser .. 74 Contents.. 74 See Also.. 74 UnprocessedStatistics .. 75 Contents.. 75 See Also.. 75 UnprocessedTraceSegment .. 76 Contents.. 76 See Also.. 76 ValueWithServiceIds .. 77 Contents.. 77 See Also.. 77 Common Parameters .. 78 Common Errors .. 80 API Version 2016-04-12viAWS X-Ray API ReferenceWelcomeAWS X-Ray provides APIs for managing debug traces and retrieving service maps and other data createdby processing those document was last published on September 5, Version 2016-04-121 AWS X-Ray API ReferenceActionsThe following actions are supported: BatchGetTraces (p. 3) CreateSamplingRule (p. 6) DeleteSamplingRule (p. 9) GetEncryptionConfig (p.)

7 11) GetSamplingRules (p. 13) GetSamplingStatisticSummaries (p. 15) GetSamplingTargets (p. 17) GetServiceGraph (p. 20) GetTraceGraph (p. 24) GetTraceSummaries (p. 27) PutEncryptionConfig (p. 31) PutTelemetryRecords (p. 33) PutTraceSegments (p. 35) UpdateSamplingRule (p. 38)API Version 2016-04-122 AWS X-Ray API ReferenceBatchGetTracesBatchGetTracesRet rieves a list of traces specified by ID. Each trace is a collection of segment documents that originatesfrom a single request. Use GetTraceSummaries to get a list of trace SyntaxPOST /Traces : application/json{ "NextToken": "string", "TraceIds": [ "string" ]}URI Request ParametersThe request does not use any URI BodyThe request accepts the following data in JSON (p. 3)Pagination token. Not : StringRequired: NoTraceIds (p. 3)Specify the trace IDs of requests for which to retrieve : Array of stringsLength Constraints: Minimum length of 1.

8 Maximum length of : YesResponse 200 Content-type: application/json{ "NextToken": "string", "Traces": [ { "Duration": number, "Id": "string", "Segments": [ { "Document": "string", "Id": "string"API Version 2016-04-123 AWS X-Ray API ReferenceResponse Elements } ] } ], "UnprocessedTraceIds": [ "string" ]}Response ElementsIf the action is successful, the service sends back an HTTP 200 following data is returned in JSON format by the (p. 3)Pagination token. Not : StringTraces (p. 3)Full traces for the specified : Array of Trace (p. 71) objectsUnprocessedTraceIds (p. 3)Trace IDs of requests that haven't been : Array of stringsLength Constraints: Minimum length of 1. Maximum length of information about the errors that are common to all actions, see Common Errors (p.)

9 80).InvalidRequestExceptionThe request is missing required parameters or has invalid Status Code: 400 ThrottledExceptionThe request exceeds the maximum number of requests per Status Code: 429 See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following: AWS Command Line Interface AWS SDK for .NET AWS SDK for C++ AWS SDK for Go AWS SDK for JavaAPI Version 2016-04-124 AWS X-Ray API ReferenceSee Also AWS SDK for JavaScript AWS SDK for PHP V3 AWS SDK for Python AWS SDK for Ruby V2 API Version 2016-04-125 AWS X-Ray API ReferenceCreateSamplingRuleCreateSamplin gRuleCreates a rule to control sampling behavior for instrumented applications. Services retrieve rules withGetSamplingRules (p. 13), and evaluate each rule in ascending order of priority for each request. Ifa rule matches, the service records a trace, borrowing it from the reservoir size.

10 After 10 seconds, theservice reports back to X-Ray with GetSamplingTargets (p. 17) to get updated versions of each in-use rule. The updated rule contains a trace quota that the service can use instead of borrowing from SyntaxPOST /CreateSamplingRule : application/json{ "SamplingRule": { "Attributes": { "string" : "string" }, "FixedRate": number, "Host": "string", "HTTPM ethod": "string", "Priority": number, "ReservoirSize": number, "ResourceARN": "string", "RuleARN": "string", "RuleName": "string", "ServiceName": "string", "ServiceType": "string", "URLPath": "string", "Version": number }}URI Request ParametersThe request does not use any URI BodyThe request accepts the following data in JSON (p. 6)The rule : SamplingRule (p. 53) objectRequired: YesResponse 200 Content-type: application/json{API Version 2016-04-126 AWS X-Ray API ReferenceResponse Elements "SamplingRuleRecord": { "CreatedAt": number, "ModifiedAt": number, "SamplingRule": { "Attributes": { "string" : "string" }, "FixedRate": number, "Host": "string", "HTTPM ethod": "string", "Priority": number, "ReservoirSize": number, "ResourceARN": "string", "RuleARN": "string", "RuleName": "string", "ServiceName": "string", "ServiceType": "string", "URLPath": "string", "Version": number } }}Response ElementsIf the action is successful, the service sends back an HTTP 200 following data is returned in JSON format by the (p.)