

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

# Usar a API do X-Ray
<a name="xray-api"></a>

Se o SDK do X-Ray não for compatível com sua linguagem de programação, você poderá usar as APIs do X-Ray diretamente ou o AWS Command Line Interface (AWS CLI) para chamar os comandos da API do X-Ray. Use as orientações a seguir para escolher como interagir com a API:
+ Use a AWS CLI para obter uma sintaxe mais simples usando comandos pré-formatados ou com opções dentro de sua solicitação.
+ Use a API do X-Ray diretamente para obter o máximo de flexibilidade e personalização das solicitações que você fizer ao X-Ray.

Se você usar a [API do X-Ray](https://docs.aws.amazon.com/xray/latest/api/Welcome.html) diretamente em vez da AWS CLI, será necessário parametrizar sua solicitação no formato de dados correto e talvez configurar a autenticação e o tratamento de erros.

O diagrama a seguir mostra orientações para escolher como interagir com a API do X-Ray:

![O X-Ray exibe informações detalhadas sobre as solicitações da aplicação.](http://docs.aws.amazon.com/pt_br/xray/latest/devguide/images/api-vs-cli.png)


Use a API do X-Ray para enviar dados de rastreamento diretamente para o X-Ray. A API do X-Ray é compatível com todas as funções disponíveis no SDK do X-Ray, incluindo as seguintes ações comuns:
+ [PutTraceSegments](https://docs.aws.amazon.com/xray/latest/api/API_PutTraceSegments.html): faz upload de documentos do segmento para o X-Ray. 
+ [BatchGetTraces](https://docs.aws.amazon.com/xray/latest/api/API_BatchGetTraces.html): recupera uma lista de rastreamentos em uma lista de IDs de rastreamento. Cada rastreamento recuperado é uma coleção de documentos de segmento de uma única solicitação.
+ [GetTraceSummaries](https://docs.aws.amazon.com/xray/latest/api/API_GetTraceSummaries.html): recupera IDs e anotações de rastreamentos. Você pode especificar uma `FilterExpression` para recuperar um subconjunto de resumos de rastreamento.
+ [GetTraceGraph](https://docs.aws.amazon.com/xray/latest/api/API_GetTraceGraph.html): recupera um gráfico de serviço para um ID de rastreamento específico.
+ [GetServiceGraph](https://docs.aws.amazon.com/xray/latest/api/API_GetServiceGraph.html): recupera um documento formatado em JSON que descreve serviços que processam solicitações de entrada e chamam solicitações subsequentes.

Você também pode usar o AWS Command Line Interface (AWS CLI) dentro do código da aplicação para interagir programaticamente com o X-Ray. A AWS CLI é compatível com todas as funções disponíveis no SDK do X-Ray, incluindo aquelas para outros Serviços da AWS. As funções a seguir são versões das operações de API listadas anteriormente com um formato mais simples:
+ [put-trace-segments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/xray/put-trace-segments.html): faz upload de documentos do segmento para o X-Ray.
+ [batch-get-traces](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/xray/batch-get-traces.html): recupera uma lista de rastreamentos em uma lista de IDs de rastreamento. Cada rastreamento recuperado é uma coleção de documentos de segmento de uma única solicitação.
+ [get-trace-summaries](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/xray/get-trace-summaries.html): recupera IDs e anotações de rastreamentos. Você pode especificar uma `FilterExpression` para recuperar um subconjunto de resumos de rastreamento.
+ [get-trace-graph](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/xray/get-trace-graph.html): recupera um gráfico de serviço para um ID de rastreamento específico.
+ [get-service-graph](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/xray/get-service-graph.html): recupera um documento formatado em `JSON` que descreve serviços que processam solicitações de entrada e chamam solicitações subsequentes.

Para começar, você deve instalar a [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html) para o seu sistema operacional. A AWS oferece suporte aos sistemas operacionais Linux, macOS e Windows. Para obter mais informações sobre a lista de comandos do X-Ray, consulte o [Guia de referência de comandos de AWS CLI para o X-Ray](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/xray/index.html).

**Topics**
+ [Utilizar a API do AWS X-Ray com a AWS CLI](xray-api-tutorial.md)
+ [Enviando dados de rastreamento para AWS X-Ray](xray-api-sendingdata.md)
+ [Obter dados do AWS X-Ray](xray-api-gettingdata.md)
+ [Definindo configurações de amostragem, grupos e criptografia com a API AWS X-Ray](xray-api-configuration.md)
+ [Usar regras de amostragem com a API do X-Ray](xray-api-sampling.md)
+ [AWS X-RayDocumentos de segmento do](xray-api-segmentdocuments.md)