您可以登入Cloud Insights 到「介紹」並瀏覽至「管理> API存取」、以找到最新的API資訊。按一下「* API Documentation （ API文件*）」連結。

API文件是以Swagger為基礎、提供API的簡短說明與使用資訊、並可讓您在環境中試用。根據您的使用者角色和/或Cloud Insights 版本的資訊、可用的API類型可能有所不同。

在使用Cloud Insights 此功能之前、您必須先建立一個或多個* API存取權杖*。存取權杖用於指定的API類型、並可授予讀取和/或寫入權限。您也可以設定每個存取權杖的到期日。指定類型下的所有API都對存取權杖有效。每個權杖的使用者名稱或密碼都無效。

若要建立存取權杖：

您可以停用、啟用及撤銷權杖。停用的權杖可以啟用。

權杖可從客戶的角度授予API一般用途存取權限、並管理其租戶範圍內的API存取權限。客戶管理員可在Cloud Insights 不直接涉及到背後的人員的情況下、授予及撤銷這些權杖。

應用程式會在使用者成功驗證及授權存取後、收到存取權杖、然後在呼叫目標API時、將存取權杖作為認證。傳遞的權杖會通知API、該權杖的承載已獲授權存取API、並執行授權期間所授予範圍所指定的特定動作。

傳遞存取權杖的HTTP標頭為* X-CloudInsights：Apikes*。

例如、使用下列項目來擷取儲存資產：

請參閱「瀏覽器」頁面、以取得您要使用的 API 特定範例。

此產品為類別型、目前包含下列類型：Cloud Insights

其他類型和/或API可能會隨時間提供。您可以在中找到最新的API資訊 "API Swagger文件"。

請注意、使用者可存取的API類型也取決於 "使用者角色" 每Cloud Insights 個功能集（監控、工作負載安全、報告）都有。

本節說明如何橫越Cloud Insights 階層架構的各種物件。

許多API命令都支援*擴充*參數、提供相關物件的物件或URL相關詳細資料。

常用的擴充參數是_expansion。回應包含物件所有可用的特定擴充清單。

例如、當您要求下列項目時：

每個擴充都包含資料、URL或兩者。Expand參數支援多個和巢狀屬性、例如：

為了阻止這種情況、無法擴大對頂層集合的要求。例如、您無法一次要求所有儲存物件的擴充資料。用戶端必須擷取物件清單、然後選擇要展開的特定物件。

效能資料會在多個裝置之間收集、做為個別的範例。每小時（預設值）Cloud Insights 、將效能範例集合在一起並加以總結。

API可讓您存取範例和摘要資料。對於具有效能資料的物件、效能摘要可提供為_expand =效能_。效能歷程記錄時間系列可透過巢狀_expansion =效能.history _取得。

效能資料物件的範例包括：

效能指標有說明和類型、並包含效能摘要的集合。例如、延遲、流量和速率。

「效能摘要」包含說明、單位、樣本開始時間、範例結束時間、以及從單一效能計數器在一段時間範圍內（1小時、24小時、3天等）計算出的彙總值（目前、最小、最大、平均等）集合。

產生的效能資料字典有下列機碼：

每種效能資料物件類型都有一組獨特的效能指標。例如、虛擬機器效能物件支援「磁碟處理量」作為效能指標。每個支援的效能指標都是指標字典中所顯示的特定「效能類別」。支援本文稍後列出的多種效能指標類型。Cloud Insights每個效能指標字典也會有「說明」欄位、此欄位是人類可讀取的效能指標說明、以及一組效能摘要計數器項目。

「效能摘要」計數器是效能計數器的摘要。它會顯示典型的彙總值、例如計數器的最小值、最大值和平均值、以及最新觀察值、彙總資料的時間範圍、計數器的單位類型和資料臨界值。只有臨界值為選用項目、其餘屬性為必填項目。

這些類型的計數器均提供效能摘要：

API可傳回環境中物件的詳細度量、例如：

請參閱 "API Swagger文件" 以取得每種物件類型的度量資訊。

歷史記錄資料會以時間戳記和計數器對應配對的清單形式顯示在效能資料中。

歷史記錄計數器是根據效能指標物件名稱來命名。例如、虛擬機器效能物件支援「磁碟處理量」、因此歷程記錄對應會包含名為「diskThroued.read」、「diskThroued.write」和「diskThroued.Total」的機碼。

以下是磁碟效能資料Json的範例：

具有容量屬性的物件會使用基本資料類型和電容項目來表示。

搜尋API是系統的簡單入口點。API的唯一輸入參數是自由格式字串、而產生的Json則包含分類結果清單。類型與庫存不同、例如儲存設備、主機、資料存放區等。每種類型都會包含符合搜尋條件的物件類型清單。

支援可延伸（廣泛開放）的解決方案、可與協力廠商協調、業務管理、變更控制和票證系統、以及自訂的CMDB整合功能整合。Cloud Insights

Cloud Insight的RESTful API是整合的主要點、可讓使用者輕鬆有效地移動資料、並讓使用者無縫存取資料。

若要暫時停用API權杖、請在API權杖清單頁面上、按一下API的「三個點」功能表、然後選取「Disable」。您可以隨時使用相同的功能表重新啟用權杖、然後選取_Enable_。

若要永久移除API權杖、請從功能表中選取「撤銷」。您無法重新啟用撤銷的權杖、必須建立新的權杖。

API存取權杖有到期日。當API存取權杖過期時、使用者需要產生新的權杖（具有讀取/寫入權限的_Data擷取_類型）、然後重新設定Telegraf、以使用新產生的權杖、而非過期的權杖。以下步驟詳細說明如何執行此作業。