VMware Aria Automation 8.16 - Chinese - Taiwan

8.18 8.17 8.16 8.14 8.13 all
Português (Brasil) 简体中文 Deutsch Español Français Italiano 日本語 한국어 Nederlands Русский 繁體中文 English

VMware Aria Automation API 程式設計指南

身為 VMware Aria®Automation™ 的使用者或客戶，您可以使用 REST API 服務呼叫，以程式設計方式執行
VMware Aria Automation Assembler
、
VMware Aria Automation Service Broker
 及
VMware Aria Automation Pipelines
功能。

API 服務

VMware Aria Automation
 包含下列 API。API 說明文件隨產品提供。若要從單一登陸頁面存取所有 Swagger 規格，請前往
https://<
your_FQDN
>/automation/api-docs
，其中
your_FQDN
 即為
VMware Aria Automation
 應用裝置的 FQDN。
VMware Aria Automation
主要服務
服務名稱和說明
ABX
ABX
建立或管理動作及其版本。執行動作和流程。
Automation Service Broker
核准
強制執行用於在佈建請求前控制必要核准部署或第 2 天動作的原則
Automation Assembler
藍圖
建立、驗證和佈建藍圖。
API 中的藍圖是產品中的
Automation Assembler
 範本。
Automation Service Broker
目錄
存取
Automation Service Broker
 目錄項目與目錄來源，包括內容共用和目錄項目請求。
CMX
CMX
在
VMware Aria Automation
 使用 Kubernetes 時，部署和管理 Kubernetes 叢集和命名空間。
Automation Assembler
Content Gateway
連線至外部內容來源 (例如原始程式碼管理提供者) 中的基礎結構即代碼內容。
Automation Service Broker
 和
Automation Assembler
自訂表單
在
Automation Service Broker
 和
Automation Assembler
 中定義動態表單呈現和自訂行為。
使用者設定檔
自訂
設定商標資訊。
Automation Service Broker
部署
存取已部署至系統的部署物件和平台或藍圖。
API 中的藍圖是產品中的
Automation Assembler
 範本。
Automation Service Broker
部署度量
部署物件的匯總度量值。
身分識別
身分識別
對
VMware Aria Automation
 使用者進行驗證和管理授權。
Automation Assembler
基礎結構即服務 (IaaS)
執行基礎結構設定工作，包括以反覆方式驗證和佈建資源。
移轉
Migration Assistant
執行評估並存取遷移服務。支援 vRealize Automation 7.6 內容的遷移，以及 NSX-V 到 NSX-T 的遷移。
重新放置
上線
定義用於管理任何雲端中的現有虛擬機器的原則和計劃。
Automation Orchestrator 用戶端
Orchestrator
設計、管理和運行工作流程、操作和策略，以自動執行複雜的 IT 任務。
Automation Orchestrator 用戶端
Orchestrator 閘道
執行工作流程和動作以自動執行複雜的 IT 工作。
Automation Pipelines
管線
建立並執行管線，以將應用程式持續交付至生產環境。
Automation Service Broker
原則
與
Automation Service Broker
 中建立的原則進行互動。
專案
專案
讓具有專案角色的使用者能夠檢視和隔離已佈建的資源。
平台和 RBAC 服務的 Swagger 文件與專案服務有關。
VMware
針對公用 API 的任何中斷變更，為客戶提供 12 個月的生命週期終止通知。任何重大變更都會在
VMware Aria Automation
 文件附帶的發行說明中公佈。

API 版本控制

強烈建議但不必須使用 API 版本控制。API 版本控制可讓您將 API 鎖定為某個值並控制何時升級到新 API 版本。如果不使用 API 版本控制，則預設行為會因 API 而有所不同。
  • 對於 IaaS API，最新版本是
    2021-07-15
    。如果您使用未進行版本控制的 IaaS API，或指派了
    2021-07-15
     以外的其他值，則請求將使用版本 2019-01-15。
    作為最佳實踐，請使用指定的
    apiVersion
     查詢參數
    2021-07-15
     鎖定您的 IaaS API 請求，以確保在版本 2019-01-15 終止之前順利過渡到最新版本。請參閱Using Automation Assembler APIs to Build your Resource Infrastructure。
  • 對於其他 API，您可以為
    apiVersion
     查詢參數指定您選擇的任何日期。如果您未指定該值，則請求將預設使用最新的 API 版本。但是，向後相容性並未保留，如果 API 發生變化，您可能會遇到 API 回應的意外變化。
    作為最佳實踐，請在 API 請求中使用
    apiVersion
     查詢參數，並將 API 鎖定到 Swagger 規格中列出的最新版本。然後，如果發布了新的 API 版本，您可以透過將
    apiVersion
     查詢參數變更為新版本值來控制何時選擇加入該版本。
以下範例顯示如何使用目錄 API 的
apiVersion
 查詢參數。目錄 API 版本為：2020-08-25、2020-01-30 和 2019-01-15。包含額外的
apiVersion
 查詢參數會將呼叫鎖定到截至 2020 年 1 月 30 日至 2020 年 8 月 24 日有效的 API 版本。 
GET https://appliance.domain.com/catalog/api/sources?apiVersion=2020-01-30
當您準備好選擇加入 2020-08-25 版本發佈的功能時，請變更
apiVersion
 查詢參數的值。 
GET https://appliance.domain.com/catalog/api/sources?apiVersion=2020-08-25
將
apiVersion
 查詢參數設定為最新版本可確保您還能獲得 2020-08-25 之後的目錄 API 更新。但是，在發布新版本之前不會發生任何重大變化，並且只有將
apiVersion
 查詢參數的值更改為與新版本相同或更晚的日期時，才會體驗到這些變化。
API 版本不會隨著每次
VMware Aria Automation
 發行而改變，對於所有服務來說都是不一樣的。若要檢查您所使用的服務的 API 版本，請前往
https://<
FQDN
>/automation-ui/api-docs
 並按一下卡片以開啟 Swagger 規格。

開發人員如何使用
VMware Aria Automation
 API

若要進行 API 服務呼叫，您可以使用瀏覽器應用程式或 HTTP 用戶端應用程式來傳送要求並檢閱回應。通常會使用下列開放原始碼應用程式：
要了解如何使用 API，首先需要取得驗證令牌。然後，您可以執行本指南案例中概述的步驟。使用案例均在要求範例中包含
curl
 命令。若要使用命令，請確保已透過
curl
 安裝了
jq
 命令列 JSON 處理器。
jq
 剖析器可確保回應的格式達到最佳可讀性。如需
jq
 安裝的相關資訊，請參閱 https://stedolan.github.io/jq/。

Content feedback and comments