瞭解租戶管理API
建議變更
PDF
您可以使用租戶管理REST API（而非租戶管理程式使用者介面）來執行系統管理工作。例如、您可能想要使用API來自動化作業、或更快建立多個實體、例如使用者。
租戶管理API使用Swagger開放原始碼API平台。Swagger提供直覺式使用者介面、可讓開發人員和非開發人員與API互動。Swagger使用者介面提供每個API作業的完整詳細資料和文件。
若要存取租戶管理API的Swagger文件：
-
登入租戶管理程式。
-
從「租戶管理程式」標頭中選取「說明>* API說明文件*」。
API作業
租戶管理API會將可用的API作業組織成下列區段：
-
帳戶-目前租戶帳戶的作業、包括取得儲存使用資訊。
-
驗證：執行使用者工作階段驗證的作業。
租戶管理API支援承載權杖驗證方案。對於租戶登入、您可以在驗證要求的Json實體中提供使用者名稱、密碼和帳戶ID（也就是
POST /api/v3/authorize）。如果使用者已成功驗證、則會傳回安全性權杖。此權杖必須在後續API要求（「授權：承載權杖」）的標頭中提供。請參閱「防範跨網站要求偽造」、以取得改善驗證安全性的資訊。
如果StorageGRID 啟用了單一登入（SSO）功能、您必須執行不同的驗證步驟。請參閱《管理StorageGRID 》中的「若啟用單一登入、則驗證API」。 -
組態-與租戶管理API產品版本相關的作業。您可以列出該版本所支援的產品版本和主要API版本。
-
* Container *：在S3貯體或Swift Container上的作業、如下所示：
傳輸協定 權限允許 S3
-
建立符合法規且不符合法規的儲存庫
-
修改舊版法規遵循設定
-
設定物件上執行作業的一致性控制
-
建立、更新及刪除儲存庫的CORS組態
-
啟用和停用物件的上次存取時間更新
-
管理平台服務的組態設定、包括CloudMirror複寫、通知及搜尋整合（中繼資料通知）
-
刪除空的儲存區
Swift
設定用於容器的一致性層級
-
-
停用功能-檢視可能已停用之功能的作業。
-
端點：管理端點的作業。端點可讓S3儲存區使用外部服務StorageGRID 來進行CloudMirror複寫、通知或搜尋整合。
-
群組：管理本機租戶群組及從外部身分識別來源擷取同盟租戶群組的作業。
-
身分識別來源-作業：設定外部身分識別來源、以及手動同步處理聯盟群組與使用者資訊。
-
地區-作業、以判斷StorageGRID 哪些地區已設定用於該系統。
-
* S3 *：管理租戶使用者S3存取金鑰的作業。
-
* S3-object-lock *-決定如何為StorageGRID 該系統設定全域S3物件鎖定（法規遵循）的作業。
-
使用者-檢視及管理租戶使用者的作業。
營運詳細資料
展開每個API作業時、您可以看到其HTTP動作、端點URL、任何必要或選用參數的清單、要求本文的範例（視需要）、以及可能的回應。
發出API要求
|
您使用API文件網頁執行的任何API作業都是即時作業。請小心不要錯誤地建立、更新或刪除組態資料或其他資料。 |
-
按一下HTTP動作以查看申請詳細資料。
-
判斷要求是否需要其他參數、例如群組或使用者ID。然後取得這些值。您可能需要先發出不同的API要求、才能取得所需的資訊。
-
判斷您是否需要修改範例要求本文。如果是、您可以按一下*模型*來瞭解每個欄位的需求。
-
按一下*試用*。
-
提供任何必要的參數、或視需要修改申請本文。
-
按一下*執行*。
-
檢閱回應代碼以判斷要求是否成功。