API標準及多語言預置SDK
本產品（servicecatalog/2021-09-01）的OpenAPI採用RPC簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK，開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜，需花費 5個工作日左右。因此建議加入我們的服務DingTalk群（147535001692），在專家指導下進行簽名對接。
在使用API前，您需要準備好身份帳號及存取金鑰（AccessKey），才能有效通過用戶端工具（SDK、CLI等）訪問API。細節請參見擷取AccessKey。
自訂簽名情境
若您的業務情境有特殊需求，需通過自簽名方式對接 API，建議優先諮詢我們的支援人員團隊（服務DingTalk群：147535001692），擷取專業指導以確保高效接入。
帳號與安全準備
阿里雲帳號具備對所有資源的完全系統管理權限。一旦 AccessKey 泄露，所有相關資源都將面臨未經授權訪問的風險。為確保安全，建議建立一個僅具備 API 存取權限的RAM使用者並配置其 AccessKey，同時基於最小許可權原則 (PoLP) 配置 RAM 策略。僅在明確需要阿里雲帳號許可權的特定情境下，才使用阿里雲帳號。
服務發現
|
API |
標題 |
API概述 |
| GetProductAsEndUser | 終端使用者查詢產品資訊 | 終端使用者調用GetProductAsEndUser介面查詢產品資訊。 |
| ListProductsAsEndUser | 終端使用者查詢產品列表 | 終端使用者調用ListProductsAsEndUser介面查詢產品列表。 |
服務請求
|
API |
標題 |
API概述 |
| ListLaunchOptions | 查詢啟動選項列表 | 查詢啟動選項列表。 |
| LaunchProduct | 啟動產品 | 啟動產品。 |
| TerminateProvisionedProduct | 終止執行個體 | 終止執行個體。 |
| UpdateProvisionedProduct | 更新執行個體 | 更新執行個體。 |
計畫
|
API |
標題 |
API概述 |
| CreateProvisionedProductPlan | 建立計劃 | 建立計劃。 |
| GetProvisionedProductPlan | 查詢計劃資訊 | 查詢計劃資訊。 |
| ListProvisionedProductPlans | 查詢計劃列表 | 查詢計劃列表。可分使用者維度和審批維度進行查詢。 |
| CancelProvisionedProductPlan | 取消計劃 | 取消計劃。 |
| UpdateProvisionedProductPlan | 更新計劃 | 更新計劃。 |
| ApproveProvisionedProductPlan | 審批計劃 | 審批人審批計劃。 |
| ListProvisionedProductPlanApprovers | 查詢計劃審批人列表 | 查詢計劃審批人列表。 |
| ExecuteProvisionedProductPlan | 執行計畫 | 執行計畫。 |
| DeleteProvisionedProductPlan | 刪除計劃 | 刪除計劃。 |
執行個體
|
API |
標題 |
API概述 |
| GetProvisionedProduct | 查詢執行個體資訊 | 查詢執行個體資訊。 |
| ListProvisionedProducts | 查詢執行個體列表 | 查詢執行個體列表。 |
產品
|
API |
標題 |
API概述 |
| CopyProduct | 複製產品 | 複製產品。 |
| GetProductAsAdmin | 管理員查詢產品資訊 | 管理員調用GetProductAsAdmin介面查詢產品資訊。 |
| ListProductsAsAdmin | 管理員查詢產品列表 | 管理員調用ListProductsAsAdmin介面查詢產品列表。 |
產品版本
|
API |
標題 |
API概述 |
| CreateProductVersion | 建立產品版本 | 建立產品版本。 |
| DeleteProductVersion | 刪除產品版本 | 刪除產品版本。 |
| UpdateProductVersion | 更新產品版本 | 更新產品版本。 |
| GetProductVersion | 查詢產品版本資訊 | 查詢產品版本資訊。 |
| ListProductVersions | 查詢產品版本列表 | 查詢產品版本列表。 |
範本
|
API |
標題 |
API概述 |
| CreatePortfolio | 建立產品組合 | 建立產品組合。 |
| AssociateProductWithPortfolio | 將產品加入產品組合 | 將產品加入產品組合。 |
| DeletePortfolio | 刪除產品組合 | 刪除產品組合。 |
| DisassociateProductFromPortfolio | 從產品組合中移除產品 | 從產品組合中移除產品。 |
| UpdatePortfolio | 更新產品組合 | 更新產品組合。 |
| GetPortfolio | 查詢產品組合資訊 | 查詢產品組合資訊。 |
| ListPortfolios | 查詢產品組合列表 | 查詢產品組合列表。 |
產品組合
|
API |
標題 |
API概述 |
| CreateConstraint | 建立約束 | 建立約束。 |
| DeleteConstraint | 刪除約束 | 刪除約束。 |
| UpdateConstraint | 更新約束 | 更新約束。 |
| GetConstraint | 查詢約束資訊 | 查詢約束資訊。 |
約束
|
API |
標題 |
API概述 |
| AssociatePrincipalWithPortfolio | 建立產品組合授權 | 將產品組合授權給帳號內的RAM使用者或者RAM角色。 |
| DisassociatePrincipalFromPortfolio | 刪除產品組合授權 | 刪除產品組合授權。 |
| ListPrincipals | 查詢產品組合已授權的使用者和角色列表 | 查詢產品組合已授權的RAM使用者和RAM角色列表。 |
授權
|
API |
標題 |
API概述 |
| GetTagOption | 查詢標籤選項資訊 | 查詢標籤選項詳情。 |
| DisAssociateTagOptionFromResource | 取消標籤選項與資源的關聯 | 取消標籤選項與資源的關聯。 |
| ListResourcesForTagOption | 查詢標籤選項關聯的資源清單 | 查詢標籤選項關聯的資源清單。 |
| UpdateTagOption | 更新標籤選項 | 更新標籤選項。 |
| ListTagOptions | 查詢標籤選項列表 | 查詢標籤選項列表。 |
| DeleteTagOption | 刪除標籤選項 | 刪除標籤選項。 |
| CreateTagOption | 建立標籤選項 | 建立標籤選項。 |
| AssociateTagOptionWithResource | 將標籤選項關聯到資源 | 將標籤選項關聯到資源。 |
地域
|
API |
標題 |
API概述 |
| CreateProduct | 建立產品 | 建立產品。 |
| CreateTemplate | 建立模板 | 建立模板。服務類別目錄會儲存使用者上傳的模板，並返回模板的URL地址。 |
| DeleteProduct | 刪除產品 | 刪除產品。 |
| GetTask | 查詢任務資訊 | 查詢任務資訊。 |
| GetTemplate | 查詢範本詳情 | 查詢範本詳情。 |
| ListRegions | 查詢地區列表 | 查詢地區列表。 |
| ListTasks | 查詢工作清單 | 查詢工作清單。 |
| UpdateProduct | 更新產品 | 更新產品。 |