AWS X-Ray
Amazon Web Services X-Ray provides APIs for managing debug traces and retrieving service maps and other data created by processing those traces.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Amazon Web Services X-Ray provides APIs for managing debug traces and retrieving service maps
and other data created by processing those traces.
Endpoints 38
- POSTBatch get traces
/TracesYou cannot find traces through this API if Transaction Search is enabled since trace is not indexed in X-Ray. Retrieves a list of traces specified by ID. Each… - POSTCancel trace retrieval
/CancelTraceRetrievalCancels an ongoing trace retrieval job initiated by StartTraceRetrieval using the provided RetrievalToken . A successful cancellation will return an HTTP 200… - POSTCreate group
/CreateGroupCreates a group resource with a name and a filter expression. - POSTCreate sampling rule
/CreateSamplingRuleCreates a rule to control sampling behavior for instrumented applications. Services retrieve rules with GetSamplingRules , and evaluate each rule in ascending… - POSTDelete group
/DeleteGroupDeletes a group resource. - POSTDelete resource policy
/DeleteResourcePolicyDeletes a resource policy from the target Amazon Web Services account. - POSTDelete sampling rule
/DeleteSamplingRuleDeletes a sampling rule. - POSTGet encryption config
/EncryptionConfigRetrieves the current encryption configuration for X-Ray data. - POSTGet group
/GetGroupRetrieves group resource details. - POSTGet groups
/GroupsRetrieves all active group details. - POSTGet indexing rules
/GetIndexingRulesRetrieves all indexing rules. Indexing rules are used to determine the server-side sampling rate for spans ingested through the CloudWatchLogs destination and… - POSTGet insight
/InsightRetrieves the summary information of an insight. This includes impact to clients and root cause services, the top anomalous services, the category, the state… - POSTGet insight events
/InsightEventsX-Ray reevaluates insights periodically until they're resolved, and records each intermediate state as an event. You can review an insight's events in the… - POSTGet insight impact graph
/InsightImpactGraphRetrieves a service graph structure filtered by the specified insight. The service graph is limited to only structural information. For a complete service… - POSTGet insight summaries
/InsightSummariesRetrieves the summaries of all insights in the specified group matching the provided filter values. - POSTGet retrieved traces graph
/GetRetrievedTracesGraphRetrieves a service graph for traces based on the specified RetrievalToken from the CloudWatch log group generated by Transaction Search. This API does not… - POSTGet sampling rules
/GetSamplingRulesRetrieves all sampling rules. - POSTGet sampling statistic summaries
/SamplingStatisticSummariesRetrieves information about recent sampling results for all sampling rules. - POSTGet sampling targets
/SamplingTargetsRequests a sampling quota for rules that the service is using to sample requests. - POSTGet service graph
/ServiceGraphRetrieves a document that describes services that process incoming requests, and downstream services that they call as a result. Root services process… - POSTGet time series service statistics
/TimeSeriesServiceStatisticsGet an aggregation of service statistics defined by a specific time range. - POSTGet trace graph
/TraceGraphRetrieves a service graph for one or more specific trace IDs. - POSTGet trace segment destination
/GetTraceSegmentDestinationRetrieves the current destination of data sent to PutTraceSegments and OpenTelemetry protocol (OTLP) endpoint. The Transaction Search feature requires a… - POSTGet trace summaries
/TraceSummariesRetrieves IDs and annotations for traces available for a specified time frame using an optional filter. To get the full traces, pass the trace IDs to… - POSTList resource policies
/ListResourcePoliciesReturns the list of resource policies in the target Amazon Web Services account. - POSTList retrieved traces
/ListRetrievedTracesRetrieves a list of traces for a given RetrievalToken from the CloudWatch log group generated by Transaction Search. For information on what each trace… - POSTList tags for resource
/ListTagsForResourceReturns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule. - POSTPut encryption config
/PutEncryptionConfigUpdates the encryption configuration for X-Ray data. - POSTPut resource policy
/PutResourcePolicySets the resource policy to grant one or more Amazon Web Services services and accounts permissions to access X-Ray. Each resource policy will be associated… - POSTPut telemetry records
/TelemetryRecordsUsed by the Amazon Web Services X-Ray daemon to upload telemetry. - POSTPut trace segments
/TraceSegmentsUploads segment documents to Amazon Web Services X-Ray. A segment document can be a completed segment, an in-progress segment, or an array of subsegments.… - POSTStart trace retrieval
/StartTraceRetrievalInitiates a trace retrieval process using the specified time range and for the given trace IDs in the Transaction Search generated CloudWatch log group. For… - POSTTag resource
/TagResourceApplies tags to an existing Amazon Web Services X-Ray group or sampling rule. - POSTUntag resource
/UntagResourceRemoves tags from an Amazon Web Services X-Ray group or sampling rule. You cannot edit or delete system tags (those with an aws: prefix). - POSTUpdate group
/UpdateGroupUpdates a group resource. - POSTUpdate indexing rule
/UpdateIndexingRuleModifies an indexing rule’s configuration. Indexing rules are used for determining the sampling rate for spans indexed from CloudWatch Logs. For more… - POSTUpdate sampling rule
/UpdateSamplingRuleModifies a sampling rule's configuration. - POSTUpdate trace segment destination
/UpdateTraceSegmentDestinationModifies the destination of data sent to PutTraceSegments . The Transaction Search feature requires the CloudWatchLogs destination. For more information, see…
API details
- Base URL
https://xray.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 38 operations on 38 pathsPOST 38
- Description format
- AWS Smithy model, API version
2016-04-12 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the AWS X-Ray in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AWS X-Ray collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Batch get traces” (POST /Traces), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AWS X-Ray?
Amazon Web Services X-Ray provides APIs for managing debug traces and retrieving service maps and other data created by processing those traces. It is listed under Developer tools and has 38 endpoints.
Who publishes the AWS X-Ray?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AWS X-Ray?
Requests go to https://xray.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the AWS X-Ray?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the AWS X-Ray have?
38 operations on 38 paths (38 POST).
Is forking the AWS X-Ray free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.