API標準及多語言預置SDK
本產品（ROS/2019-09-10）的OpenAPI採用RPC簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK，開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜，需花費 5個工作日左右。因此建議加入我們的服務DingTalk群（147535001692），在專家指導下進行簽名對接。
在使用API前，您需要準備好身份帳號及存取金鑰（AccessKey），才能有效通過用戶端工具（SDK、CLI等）訪問API。細節請參見擷取AccessKey。
自訂簽名情境
若您的業務情境有特殊需求，需通過自簽名方式對接 API，建議優先諮詢我們的支援人員團隊（服務DingTalk群：147535001692），擷取專業指導以確保高效接入。
帳號與安全準備
阿里雲帳號具備對所有資源的完全系統管理權限。一旦 AccessKey 泄露，所有相關資源都將面臨未經授權訪問的風險。為確保安全，建議建立一個僅具備 API 存取權限的RAM使用者並配置其 AccessKey，同時基於最小許可權原則 (PoLP) 配置 RAM 策略。僅在明確需要阿里雲帳號許可權的特定情境下，才使用阿里雲帳號。
AI 任務相關介面
|
API |
標題 |
API概述 |
| CreateStack | 建立資源棧 | 使用Resource Orchestration Service模板建立資源棧，完成一組資源的建立。 |
| UpdateStack | 更新資源棧 | 更新已建立資源棧的資源資訊。 |
| PreviewStack | 預覽指定模板將要建立或更新的資源棧資訊 | 預覽指定模板將要建立或更新的資源棧資訊，驗證模板資源的準確性。 |
資源堆疊相關介面
|
API |
標題 |
API概述 |
| CreateTemplateScratch | 建立資源情境 | 建立資源情境。 |
資源相關介面
|
API |
標題 |
API概述 |
| CreateTemplate | 建立自訂模板 | 建立自訂的模板。 |
| ListTemplates | 查詢範本列表 | 查詢私人與共用的模板列表。 |
| GetTemplateParameterConstraints | 擷取模版參數約束 | 查詢範本參數的取值。 |
| ValidateTemplate | 驗證將要建立資源棧的模板 | 通過指定模板地址或模板內容驗證將要建立資源棧的模板。 |
資源場景相關介面
|
API |
標題 |
API概述 |
| CreateChangeSet | 建立更改集 | 為資源棧建立更改集，您可以在執行更改之前查看對應更改內容。 |
| GetChangeSet | 查詢更改集資訊 | 查詢指定更改集資訊，可以選擇是否擷取對應模板詳情。 |
| ListChangeSets | 查詢變更集列表 | 查詢已建立的變更集列表詳情。 |
範本相關介面
|
API |
標題 |
API概述 |
| CreateStackGroup | 建立資源棧組 | 使用Resource Orchestration Service模板建立資源棧組，通過資源棧組，可以在多個阿里雲帳號中跨地區建立資源棧。 |
| UpdateStackGroup | 更新資源棧組 | 更新已建立的資源棧組。 |
| ListStackGroups | 查詢資源棧組列表 | 在一個阿里雲地區下查詢資源棧組列表詳情。 |
| GetStackGroup | 查詢指定資源棧組的資訊 | 在一個阿里雲地區下根據資源棧組名稱查詢資源棧組詳情。 |
| CreateStackInstances | 在指定帳號和地區下建立資源棧執行個體 | 為一個或多個帳號在指定地區下建立資源棧執行個體。 |
資源堆疊策略相關介面
|
API |
標題 |
API概述 |
| TagResources | 為指定的資源建立並綁定標籤 | 指定一個或多個資源建立並綁定標籤。 |
| ListTagKeys | 查詢標籤鍵 | 在一個阿里雲地區下查詢資源棧或模板的標籤鍵。 |
變更集相關介面
|
API |
標題 |
API概述 |
| SetResourceType | 修改資源類型 | 修改資源類型或資源類型某個版本的相關描述。 |
| DeregisterResourceType | 登出資源類型 | 刪除資源類型，或刪除已有資源類型的某個版本。 |
| ListResourceTypes | 查詢支援的資源類型列表 | 查詢支援的資源類型列表。 |
| GetResourceTypeTemplate | 查詢資源類型的資源模板 | 根據資源類型產生一個樣本模板。 |
| GetResourceType | 查詢資源類型的詳細資訊 | 透過指定資源類型查詢詳細資訊。 |
| ListResourceTypeVersions | 查詢資源類型版本列表 | 查詢資源類型版本列表，包括使用者自己建立的和 ROS 提供的資源類型。 |
資源堆疊組相關介面
|
API |
標題 |
API概述 |
| GetServiceProvisions | 查詢服務開通狀態 | 查詢服務開通狀態和服務角色資訊。 |
| GetFeatureDetails | 擷取特定功能的詳情 | 查詢ROS支援的特定功能詳情。 |
偏差檢測相關介面
|
API |
標題 |
API概述 |
| CancelStackOperation | 取消資源棧操作 | 取消資源棧操作。 |
| CancelUpdateStack | 取消更新資源棧 | 當您的資源棧正處於更新中或建立中且操作尚未完成，您可以調用該介面取消更新資源棧操作。 |
| ContinueCreateStack | 重新建立資源棧 | 資源棧建立失敗後，繼續建立資源棧。 |
| CreateAITask | 建立AI任務 | 建立AI任務以執行特定的自動化工作流程，如產生、修複模板或部署資源棧。 |
| CreateDiagnostic | 建立診斷 | 建立診斷任務進行一鍵診斷。 |
| DeleteChangeSet | 刪除更改集 | 為已建立更改集的資源棧刪除更改集。 |
| DeleteDiagnostic | 刪除診斷 | 刪除診斷記錄。 |
| DeleteStack | 刪除資源棧 | 刪除指定資源棧，可以選擇是否保留資源。 |
| DeleteStackGroup | 刪除資源棧組 | 刪除已建立的資源棧組。 |
| DeleteStackInstances | 刪除特定帳號和地區下的資源棧執行個體 | 為一個或多個帳號在指定地區下刪除資源棧執行個體，可以選擇是否保留資源。 |
| DeleteTemplate | 刪除模板 | 刪除指定模板，如果已將模板共用給其他阿里雲帳號，需要不共用後才能刪除。 |
| DeleteTemplateScratch | 刪除資源情境 | 刪除資源情境。 |
| DescribeRegions | 查詢地區列表 | 查詢可選地區列表。 |
| DetectStackDrift | 對資源棧進行偏差檢測 | 對資源棧進行偏差檢測，可以限定具體資源，以便確定資源棧是否已偏離其預期的模板配置。 |
| DetectStackGroupDrift | 對資源棧組進行偏差檢測 | 對資源棧組進行偏差檢測，以便確定資源棧組是否已偏離其預期的模板配置。 |
| DetectStackResourceDrift | 對資源進行偏差檢測 | 對資源進行偏差檢測，以便確定資源是否已偏離其預期的模板配置。 |
| EnableServiceAccess | 啟用服務介面 | 開啟可信服務訪問 |
| EnableServices | 批量開通服務 | 批量開通服務 |
| ExecuteChangeSet | 執行更改集 | 對資源棧執行更改集，資源變更即可生效。 |
| GenerateTemplateByScratch | 為資源情境產生模板 | 為資源情境產生模板。 |
| GenerateTemplatePolicy | 產生範本所需的策略資訊 | 透過指定範本產生範本所需的策略資訊。 |
| GetAITask | 查詢AI任務詳情 | 指定AI任務ID，擷取AI任務的詳細資料。 |
| GetDiagnostic | 查詢診斷詳情 | 指定診斷報告ID，擷取診斷的詳細資料。 |
| GetServiceAccess | 查詢可信服務狀態 | 查詢可信服務。 |
| GetStack | 查詢資源堆疊資訊 | 查詢資源堆疊資訊。 |
| GetStackDriftDetectionStatus | 查詢偏差檢測的狀態 | 在一個阿里雲地區下根據偏差檢測ID查詢偏差檢查狀態。 |
| GetStackGroupOperation | 查詢資源棧組操作的資訊 | 在一個阿里雲地區下查詢指定資源棧組的操作詳情。 |
| GetStackInstance | 查詢資源棧執行個體資訊 | 查詢指定資源棧組關聯的資源棧執行個體詳情。 |
| GetStackPolicy | 擷取資源棧策略 | 在一個阿里雲地區下查詢指定資源棧策略詳情。 |
| GetStackResource | 查詢某個資源棧的資源 | 查詢某個資源棧的資源。 |
| GetTemplate | 查詢範本詳情 | 指定資源棧、資源棧組、更改集、自訂模板其中任意資訊擷取模板詳情。 |
| GetTemplateEstimateCost | 查詢範本中建立資源的預估價格 | 通過指定模板和模板參數查詢建立資源棧的預估價格。 |
| GetTemplateScratch | 取得資源場景詳情 | 取得資源場景詳情。 |
| GetTemplateSummary | 擷取新模板或者現有模板的資訊 | 通過指定模板、資源棧、資源棧組、更改集其中任意資訊查詢範本資源詳情。 |
| ImportStacksToStackGroup | 將資源棧匯入至資源棧組 | 將多個不同帳號下的資源棧匯入至資源棧組。 |
| ListAITaskEvents | 查詢AI任務的事件 | 查詢AI任務的事件。 |
| ListAITasks | 查詢AI工作清單 | 查詢AI工作清單。 |
| ListDiagnostics | 查詢診斷列表 | 查詢診斷列表。 |
| ListResourceTypeRegistrations | 查詢資源註冊記錄 | 查詢資源註冊記錄列表。 |
| ListStackEvents | 查詢資源堆疊及堆疊內資源的事件 | 查詢資源堆疊及堆疊內資源的事件。 |
| ListStackGroupOperationResults | 查詢資源棧組操作結果清單 | 在一個阿里雲地區下查詢指定資源棧組操作的結果清單詳情。 |
| ListStackGroupOperations | 查詢資源棧組巨集指令清單 | 在一個阿里雲地區下查詢資源棧組巨集指令清單詳情。 |
| ListStackInstances | 查詢指定資源棧組關聯的資源棧執行個體列表 | 在一個阿里雲地區下查詢指定資源棧組關聯的資源棧執行個體列表詳情。 |
| ListStackOperationRisks | 檢測資源棧操作可能涉及的風險及原因 | 檢測進行資源棧操作可能涉及的風險，並返迴風險原因或缺失項。 |
| ListStackResourceDrifts | 查詢資源棧的資源偏差詳情 | 在一個阿里雲地區下查詢資源棧的資源偏差詳情。 |
| ListStackResources | 查詢資源棧的資源列表 | 查詢指定資源棧的資源列表。 |
| ListStacks | 查詢資源棧列表 | 查詢資源棧列表。 |
| ListSummaries | 查詢ROS資源總覽 | 查詢總覽。 |
| ListTagResources | 查詢資源已經綁定的標籤 | 在一個阿里雲地區下查詢範本或資源棧中一個或多個資源已經綁定的標籤。 |
| ListTagValues | 查詢指定標籤鍵對應的標籤值 | 在一個阿里雲地區下查詢範本或資源棧中指定標籤鍵對應的標籤值。 |
| ListTemplateScratches | 查詢資源場景列表 | 查詢資源場景列表。 |
| ListTemplateVersions | 查詢範本的版本列表 | 通過查詢指定模板擷取模板的版本列表詳情。 |
| MoveResourceGroup | 修改資源所屬的資源群組 | 修改資源所屬的資源群組。 |
| RegisterResourceType | 註冊資源類型 | 建立新的資源類型，或為已有資源類型增加一個新版本。 |
| SetDeletionProtection | 修改資源棧的刪除保護屬性 | 修改資源棧的刪除保護屬性。 |
| SetStackPolicy | 設定資源棧策略 | 為指定資源棧配置資源策略。 |
| SetTemplatePermission | 共用模板或不共用模板 | 為指定模板設定共用或不共用。 |
| SignalResource | 發送訊號 | 您可以調用本介面對指定資源棧的資源發送訊號，與ALIYUN::ROS::WaitCondition配合使用以控制資源棧的執行流程。 |
| StopStackGroupOperation | 停止資源棧組操作 | 停止資源棧組進行中的操作。 |
| UntagResources | 解除綁定並刪除標籤 | 為指定的一個或多個資源統一解除綁定並刪除標籤。 |
| UpdateStackInstances | 在特定帳號和地區下更新資源棧執行個體 | 為一個或多個帳號在指定地區下更新資源棧執行個體。 |
| UpdateStackTemplateByResources | 修正資源棧模板 | 通過執行偏差檢測，消除資源棧的偏差。 |
| UpdateTemplate | 更新模板 | 通過指定模板地址或模板詳情更新模板。 |
| UpdateTemplateScratch | 更新資源情境 | 更新資源情境。 |