本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
AWS Service Catalog API 概觀
使用 Service Catalog API 的優點
AWS Service Catalog API 提供對所有最終使用者動作的程式設計控制，作為使用 的替代方案 AWS 管理主控台。使用 API 時，您可以執行下列動作：
-
撰寫您自己的自訂界面和應用程式
-
取得最終使用者產品佈建操作的精細控制
-
將資源佈建整合到您的協同運作管道
-
使用應用程式的資源存取託管應用程式的中央位置
存取 Service Catalog
若要使用特定語言 APIs 建置應用程式，請使用軟體開發人員的程式庫、範例程式碼、教學課程和其他資源。這些程式庫提供的基本功能可自動化任務，例如密碼編譯簽署要求、重試要求，以及處理錯誤回應，讓您更容易入門。若要開始使用，請開啟適用於 Amazon Web Services 的工具
若您偏好使用命令列介面，可使用下列選項：
- AWS 命令列界面 (CLI)
-
若要開始使用，請參閱《AWS Command Line Interface 使用者指南》。如需 Service Catalog 命令的詳細資訊，請參閱《 AWS CLI 命令參考》中的 servicecatalog。
- AWS 適用於 Windows PowerShell 的工具
-
若要開始使用，請參閱《AWS Tools for PowerShell 使用者指南》。如需有關 Service Catalog 的 cmdlet 的詳細資訊，請開啟 AWS Tools for PowerShell Cmdlet 參考並展開 AWS Service Catalog。
AWS Service Catalog API 邏輯上可分為下列類別。
產品探索
使用這些操作來探索或取得有關產品及其啟動需求的資訊。這些操作不會建立或修改資源。
- SearchProducts
-
列出發起人有權存取的所有產品。
- DescribeProduct
-
取得產品的詳細資訊。
- DescribeProductView
-
功能與 相同
DescribeProduct，但它接受產品檢視的 ID，而不是產品 ID。 - ListLaunchPaths
-
列出使用者存取指定產品的所有方式，稱為產品路徑。使用者必須選取路徑才能佈建產品。
- DescribeProvisioningParameters
-
取得佈建指定產品所需的參數，並提供佈建產品時會發生哪些情況的其他中繼資料。
每個
ProvisioningArtifactParameter都是使用者必須指定的項目，才能成功佈建產品 （例如 EC2 執行個體的大小）。ConstraintSummary物件包含允許值的清單，以及有關ProvisioningArtifactParameter物件的其他中繼資料。
佈建請求
使用這些操作來請求、更新或終止產品的佈建。
- ProvisionProduct
-
請求佈建產品。若要佈建產品，請啟動讓該產品上線以供實際使用所需的資源。例如，佈建由 CloudFormation 範本支援的產品意味著啟動 CloudFormation 堆疊及其所有基礎資源。
- UpdateProvisionedProduct
-
更新佈建產品的組態。例如， 支援的產品 CloudFormation 會更新其基礎 CloudFormation 堆疊。申請者必須擁有指定 ProvisionedProduct 的足夠存取許可。
- TerminateProvisionedProduct
-
請求終止已佈建的產品。例如，對於後端為 的產品 CloudFormation，這會刪除基礎 CloudFormation 堆疊。申請者必須擁有指定佈建產品的足夠存取許可。
佈建產品
使用這些操作來取得佈建產品的相關資訊。這些操作不會建立或修改資源。
- ListRecordHistory
-
列出所有執行的請求，即使是已終止的佈建產品。
- DescribeRecord
-
取得請求的相關資訊。在請求操作之後使用此操作來取得目前
RecordDetail資訊。 - SearchProvisionedProducts
-
取得符合指定條件之佈建產品的相關資訊。
- ScanProvisionedProducts
-
列出未終止的佈建產品。
- DescribeProvisionedProduct
-
取得佈建產品的相關資訊。
- ImportAsProvisionedProduct
-
請求將資源匯入為與 Service Catalog 產品和佈建成品相關聯的 Service Catalog 佈建產品。匯入後，佈建產品支援所有支援的 Service Catalog 控管動作。
- UpdateProvisionedProductProperties
-
請求更新指定佈建產品的屬性。
佈建的產品計劃
使用這些操作來管理您的佈建產品計劃。計劃包含執行計劃時要建立或修改的資源清單。
- CreateProvisionedProductPlan
建立計劃。
- DescribeProvisionedProductPlan
取得計劃資源變更的相關資訊。
- ExecuteProvisionedProductPlan
根據計劃佈建或修改產品。
- ListProvisionedProductPlans
列出佈建產品的計劃。
- DeleteProvisionedProductPlan
刪除計劃。
產品組合
目錄管理員使用這些操作為產品組合管理提供所有必要的操作。
- CreatePortfolio
建立組合。
- DeletePortfolio
刪除產品組合。
- DescribePortfolio
取得產品組合的詳細資訊。
- DescribePortfolioShares
傳回為指定產品組合建立的每個產品組合共用的摘要。
- ListPortfolios
列出目錄中的所有產品組合。
- ListPortfoliosForProduct
列出產品相關聯的所有產品組合。
- UpdatePortfolio
更新產品組合。
- UpdatePortfolioShare
更新產品組合共享。
- CreatePortfolioShare
與 AWS 帳戶共用產品組合。
- DeletePortfolioShare
停止共用產品組合。
- AcceptPortfolioShare
接受共用產品組合的提議。
- RejectPortfolioShare
拒絕共用產品組合的提議。
- ListAcceptedPortfolioShares
列出此帳戶接受共用之所有產品組合的詳細資訊。
- ListPortfolioAccess
列出可存取產品組合的帳戶 IDs。
委託人關聯
目錄管理員使用這些操作可為主體關聯提供所有必要的操作。
- AssociatePrincipalWithPortfolio
將委託人 ARN 與產品組合建立關聯。
- DisassociatePrincipalFromPortfolio
取消委託人 ARN 與產品組合的關聯。
- ListPrincipalsForPortfolio
列出與產品組合相關聯的所有委託人 ARNs。
產品
目錄管理員使用這些操作為產品管理提供所有必要的操作。
- SearchProductsAsAdmin
取得 產品的摘要和狀態資訊。
- DescribeProductAsAdmin
取得產品的相關資訊。
- CreateProduct
建立產品。
- CopyProduct
複製產品。
- DescribeCopyProductStatus
取得複製產品操作的狀態。
- UpdateProduct
更新產品。
- DeleteProduct
刪除產品。
- AssociateProductWithPortfolio
將產品與產品組合建立關聯。
- DisassociateProductFromPortfolio
取消產品與產品組合的關聯。
佈建成品
目錄管理員使用這些操作來管理佈建成品 （也稱為產品版本）。
- DescribeProvisioningArtifact
取得佈建成品的相關資訊。
- CreateProvisioningArtifact
建立產品的佈建成品。
- DeleteProvisioningArtifact
刪除佈建成品。
- ListProvisioningArtifacts
列出與產品相關聯的所有佈建成品。
- UpdateProvisioningArtifact
更新佈建成品。
Constraints
目錄管理員使用這些操作來管理限制條件。
- CreateConstraint
建立限制條件。
- DeleteConstraint
刪除限制條件。
- DescribeConstraint
取得有關限制條件的資訊。
- UpdateConstraint
更新限制條件。
- ListConstraintsForPortfolio
取得產品組合和產品的限制資訊。
服務動作
目錄管理員使用這些操作來管理服務動作。
- AssociateServiceActionWithProvisioningArtifact
將自助式動作與佈建成品建立關聯。
- CreateServiceAction
建立自助式動作。
- DeleteServiceAction
刪除自助式動作。
- DescribeServiceAction
描述自助式動作。
- DescribeServiceActionExecutionParameters
尋找特定佈建產品上特定自助式動作的預設參數，並將結果的映射傳回給使用者。
- ExecuteProvisionedProductServiceAction
針對佈建的產品執行自助式動作。
- UpdateServiceAction
更新自助式動作。
TagOptions
目錄管理員使用這些操作來管理 TagOptions。
- CreateTagOption
建立 TagOption。
- ListTagOptions
列出您的 TagOptions。
- DescribeTagOption
描述 TagOption。
- UpdateTagOption
更新 TagOption。
- AssociateTagOptionWithResource
將 TagOption 與資源建立關聯。
- DisassociateTagOptionFromResource
取消 TagOption 與資源的關聯。
- ListResourcesForTagOption
列出 TagOption 的資源。
- DeleteTagOption
刪除 TagOption。
AppRegistry
做為您應用程式、其資源和您在企業中使用的應用程式中繼資料的儲存庫。
- AssociateAttributeGroup
將屬性群組與應用程式建立關聯，以將應用程式的中繼資料增強為群組的屬性。
- AssociateResource
將資源與應用程式建立關聯。
- CreateApplication
建立新的應用程式，這是相關雲端資源抽象階層中最上層的節點。
- CreateAttributeGroup
建立新的屬性群組作為使用者定義屬性的容器。
- DeleteApplication
刪除由應用程式 ID 或名稱指定的應用程式。
- DeleteAttributeGroup
刪除屬性群組，依其屬性群組 ID 或名稱指定。
- DisassociateAttributeGroup
取消屬性群組與應用程式的關聯，將屬性群組中包含的額外屬性從應用程式的中繼資料中移除。
- DisassociateResource
取消資源與應用程式的關聯。
- GetApplication
擷取其中一個應用程式的中繼資料資訊。
- GetAssociatedResource
取得與應用程式相關聯的資源。
- GetAttributeGroup
依屬性群組的名稱或其 ID 擷取屬性群組。
- ListApplications
列出與指定應用程式相關聯的所有屬性群組。
- ListAssociatedAttributeGroups
列出與指定應用程式相關聯的所有屬性群組。
- ListAssociatedResources
列出與指定應用程式相關聯的所有資源。
- ListAttributeGroups
列出您有權存取的所有屬性群組。
- ListAttributeGroupsForApplication
列出與特定應用程式關聯之所有屬性群組的詳細資訊。
- ListTagsForResource
列出資源上的所有標籤。
- TagResource
將一或多個標籤 （鍵/值對） 指派給指定的資源。
- SyncResource
將資源與 AppRegistry 中目前記錄的資源同步。
- UntagResource
從資源移除標籤。
- UpdateApplication
使用新的屬性更新現有的應用程式。
- UpdateAttributeGroup
使用新詳細資訊更新現有的屬性群組。
範例工作流程
在此案例中，管理員使用 建立資源 AWS Service Catalog ，最終使用者會找到可用的產品並佈建產品。這是範例工作流程；這不是使用 AWS Service Catalog API 的唯一方法。
管理員任務
建立產品組合、產品檢視、產品、產品版本和限制條件。
將 IAM 使用者指派給產品，讓他們能夠存取。
最終使用者任務
-
使用者呼叫沒有引數的 SearchProducts。這會傳回使用者可存取的產品清單，以及可用於範圍結果的「SearchDomain」。
-
使用者會繼續使用其他搜尋篩選條件呼叫 SearchProducts，直到找到所需的產品為止。
-
使用者呼叫 DescribeProductView 來尋找此產品的佈建成品 （也稱為版本） 清單。這會決定使用者實際佈建的內容。
-
使用者呼叫 ListLaunchPaths 來尋找此產品的路徑清單，以及每個路徑的限制。這會決定在佈建產品上套用哪些限制條件集。
-
選擇佈建成品和路徑後，使用者會呼叫 DescribeProvisioningParameters。這會傳回使用者在使用佈建成品和路徑佈建產品之前必須提供的參數清單，以及管理員決定提供的任何其他使用說明。
-
使用者呼叫 ProvisionProduct，指定產品、佈建成品、路徑和輸入參數。輸入參數是索引鍵/值對的清單，其中索引鍵是使用 DescribeProvisioningParameters 取得，而值是使用者提供的 （例如，
{ParameterKey:"dbpassword", ParameterValue:"mycoolpassword"})。這會啟動工作流程來建立指定的 AWS 資源。它也會建立記錄詳細資訊來追蹤佈建請求，以及代表基礎 AWS 資源的佈建產品物件。 -
使用者輪詢 DescribeRecord 以查看記錄詳細資訊的狀態何時從
IN_PROGRESS狀態變更為已完成狀態 (SUCCEEDED或ERROR)。 -
當請求的記錄詳細資訊處於完成狀態時，使用者會再次呼叫 DescribeRecord。輸出會識別建立的資源。
-
使用者呼叫 UpdateProvisionedProduct 來更新現有的基礎資源。根據請求的特定更新，此操作可以在不中斷的情況下更新、有些中斷，或完全取代佈建的產品。
-
最後，使用者呼叫 TerminateProvisionedProduct 來終止佈建的產品。
