Managed Runtime API

使用 Managed Runtime API，即可控制部署至 Commerce Cloud 的 Managed Runtime 上的應用程式。您可建立與 Runtime Admin 網路應用程式具有相同功能的自訂工具，但還能獲得更多管理功能及設定選項。

這份指南假設您已經十分熟悉 Managed Runtime 及相關概念，例如：專案、環境、套件和部署等。如需進一步瞭解，請參閱 Managed Runtime 概觀。

若要提出 API 要求，您必須在 HTTP 要求 Authorization 標頭中包含 API 金鑰和此值 Bearer $API_KEY。

若要尋找您的 API 金鑰，請登入 Runtime Admin 工具，並前往 Account Settings (帳戶設定) 頁面。

我們將根據一些範例要求進行簡短的教學，為您示範如何使用 API，範例要求的格式為 curl 命令。

在執行命令前，請以實際值取代預留位置。預留位置的格式為：$PLACEHOLDER

在大部分要求中，您必須以實際專案 ID 取代 $PROJECT_ID。若要查詢您的專案 ID，請登入 Runtime Admin 工具，並前往專案的設定頁面。

專案 ID 最長可為 20 個字元，且必須是全域唯一。

我們對 Managed Runtime API 的第一個要求列出了屬於某專案的所有環境 (在 API 中稱之為「目標」)：

現在，讓我們建立一個名為 staging 的環境，好讓我們在將變更部署到 production 之前，使用它來驗證變更：

若要使用新的環境，您必須部署套件至該環境。

讓我們檢查一下我們建立的 staging 環境的詳細資料：

最後，來修改 staging 的 Proxy 設定：

變更設定會重新部署已部署的套件，使設定更新生效。

若您在使用 API 時遇到問題，請嘗試這些疑難排解步驟。

• 新增 --fail 引數至您的 curl 命令。
• 檢查您的 API 金鑰。
• 檢查您的專案 ID。

API 端點在瀏覽器中也能使用。登入 Runtime Admin 工具，並在您的瀏覽器中直接開啟正在使用的端點。

若要使用 Managed Runtime API 來支援持續整合和部署，請建立 Account Manager 使用者來達成自動化：

• 使用共用的電子郵件地址，像是 Google Group，在 Account Manager 中建立一個使用者帳戶。請將相關的憑證和 MFA 密碼儲存在 LastPass 之類的密碼管理程式中。
• 授予使用者 Managed Runtime User 角色。
• 在 Runtime Admin 中，將所需的權限指派給使用者。使用者的 Managed Runtime API 金鑰僅能存取使用者權限所允許的內容。請將權限具體設為 CI/CD 需要與其互動的專案。
• 為使用者建立 API 金鑰，並將它儲存在持續整合系統中。

若要讓 Managed Runtime API 金鑰保持有效，您必須讓相關的 Account Manager 帳戶保持有效，方法是依照您組織 Account Manager 設定的要求，更新其密碼。如果使用者被停用，請重設密碼來重新啟用使用者，以便重新啟用 API 金鑰。

Managed Runtime API 對於每單位時間所允許的要求數量設有速率限制。速率限制會套用至每位使用者，協助確保所有使用者都能公平存取。

如果您的要求超出了速率限制，API 會傳回 HTTP 429 Too Many Requests 錯誤，以及 Retry-After HTTP 標頭，指出您需要等待多少秒數之後才能重試。

速率限制無法調整。

下表顯示不同 API 系列的速率限制。

現在您已經熟悉 API 的功能，甚至能做出某些範本要求了！

如要進一步瞭解 API，請參考 API 規格。

API 的 Open API Schema 可在 https://cloud.mobify.com/api/schema.json 取得。