本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# 使用 X-Ray API
<a name="xray-api"></a>

如果 X-Ray SDK 不支援您的程式設計語言，您可以直接使用 X-Ray APIs或 AWS Command Line Interface (AWS CLI) 來呼叫 X-Ray API 命令。使用下列指引來選擇您與 API 的互動方式：
+ 使用 使用預先格式化的命令或 請求中的選項 AWS CLI ，來使用更簡單的語法。
+ 直接使用 X-Ray API，以針對您對 X-Ray 提出的請求，獲得最大的彈性和自訂。

如果您直接使用 [X-Ray API](https://docs.aws.amazon.com/xray/latest/api/Welcome.html) 而非 AWS CLI，則必須以正確的資料格式來參數化請求，也可能必須設定身分驗證和錯誤處理。

下圖顯示選擇如何與 X-Ray API 互動的指引：

![X-Ray 會顯示應用程式請求的詳細資訊。](http://docs.aws.amazon.com/zh_tw/xray/latest/devguide/images/api-vs-cli.png)


使用 X-Ray API 將追蹤資料直接傳送到 X-Ray。X-Ray API 支援 X-Ray SDK 中提供的所有函數，包括下列常見動作：
+ [PutTraceSegments](https://docs.aws.amazon.com/xray/latest/api/API_PutTraceSegments.html) – 將區段文件上傳至 X-Ray。
+ [BatchGetTraces](https://docs.aws.amazon.com/xray/latest/api/API_BatchGetTraces.html) – 擷取追蹤 IDs 清單中的追蹤清單。每個擷取的追蹤都是來自單一請求的區段文件集合。
+ [GetTraceSummaries](https://docs.aws.amazon.com/xray/latest/api/API_GetTraceSummaries.html) – 擷取追蹤IDs 和註釋。您可以指定 `FilterExpression`來擷取追蹤摘要的子集。
+ [GetTraceGraph](https://docs.aws.amazon.com/xray/latest/api/API_GetTraceGraph.html) – 擷取特定追蹤 ID 的服務圖表。
+ [GetServiceGraph](https://docs.aws.amazon.com/xray/latest/api/API_GetServiceGraph.html) – 擷取JSON格式化文件，描述處理傳入請求和呼叫下游請求的服務。

您也可以使用應用程式程式碼中的 AWS Command Line Interface (AWS CLI)，以程式設計方式與 X-Ray 互動。 AWS CLI 支援 X-Ray SDK 中提供的所有函數，包括其他函數 AWS 服務。下列函數是先前以更簡單格式列出的 API 操作版本：
+ [put-trace-segments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/xray/put-trace-segments.html) – 將區段文件上傳至 X-Ray。
+ [batch-get-traces](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/xray/batch-get-traces.html) – 擷取追蹤 IDs 清單中的追蹤清單。每個擷取的追蹤都是來自單一請求的區段文件集合。
+ [get-trace-summaries](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/xray/get-trace-summaries.html) – 擷取追蹤IDs 和註釋。您可以指定 `FilterExpression`來擷取追蹤摘要的子集。
+ [get-trace-graph](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/xray/get-trace-graph.html) – 擷取特定追蹤 ID 的服務圖表。
+ [get-service-graph](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/xray/get-service-graph.html) – 擷取`JSON`格式化文件，描述處理傳入請求和呼叫下游請求的服務。

若要開始使用，您必須[AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html)為作業系統安裝 。 AWS 支援 Linux、 macOS和 Windows 作業系統。如需 X-Ray 命令清單的詳細資訊，請參閱適用於 [AWS CLI X-Ray 的命令參考指南](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/xray/index.html)。

**Topics**
+ [搭配 CLI AWS 使用 AWS X-Ray API](xray-api-tutorial.md)
+ [將追蹤資料傳送至 AWS X-Ray](xray-api-sendingdata.md)
+ [從 取得資料 AWS X-Ray](xray-api-gettingdata.md)
+ [使用 AWS X-Ray API 設定取樣、群組和加密設定](xray-api-configuration.md)
+ [透過 X-Ray API 使用取樣規則](xray-api-sampling.md)
+ [AWS X-Ray 區段文件](xray-api-segmentdocuments.md)