API standards and multilingual preset SDKs
The OpenAPI of this product (servicecatalog/2021-09-01) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Service discovery
|
API |
Title |
Description |
| GetProductAsEndUser | GetProductAsEndUser | Queries the information about a product as a user. |
| ListProductsAsEndUser | ListProductsAsEndUser | Queries products as a user. |
Service requests
|
API |
Title |
Description |
| ListLaunchOptions | ListLaunchOptions | Queries launch options. |
| LaunchProduct | LaunchProduct | Launches a product. |
| TerminateProvisionedProduct | TerminateProvisionedProduct | Terminates a product instance. |
| UpdateProvisionedProduct | UpdateProvisionedProduct | Updates the information about a product instance. |
Plans
|
API |
Title |
Description |
| CreateProvisionedProductPlan | CreateProvisionedProductPlan | Creates a plan. |
| GetProvisionedProductPlan | GetProvisionedProductPlan | Queries a provisioned product plan. |
| ListProvisionedProductPlans | ListProvisionedProductPlans | Queries a list of plans. You can query plans from the end user dimension or from the review dimension. |
| CancelProvisionedProductPlan | CancelProvisionedProductPlan | Cancels a plan. |
| UpdateProvisionedProductPlan | UpdateProvisionedProductPlan | Updates a plan. |
| ApproveProvisionedProductPlan | ApproveProvisionedProductPlan | Reviews a plan. |
| ListProvisionedProductPlanApprovers | ListProvisionedProductPlanApprovers | Queries a list of plan reviewers. |
| ExecuteProvisionedProductPlan | ExecuteProvisionedProductPlan | Runs a plan. |
| DeleteProvisionedProductPlan | DeleteProvisionedProductPlan | Deletes a plan. |
Instances
|
API |
Title |
Description |
| GetProvisionedProduct | GetProvisionedProduct | Queries the information about a product instance. |
| ListProvisionedProducts | ListProvisionedProducts | Queries product instances. |
Products
|
API |
Title |
Description |
| CopyProduct | CopyProduct | Replicates a product. |
| GetProductAsAdmin | GetProductAsAdmin | Queries the information about a product as the administrator. |
| ListProductsAsAdmin | ListProductsAsAdmin | Queries products as an administrator. |
Product versions
|
API |
Title |
Description |
| CreateProductVersion | CreateProductVersion | Creates a product version. |
| DeleteProductVersion | DeleteProductVersion | Deletes a product version. |
| UpdateProductVersion | UpdateProductVersion | Updates the information about a product version. |
| GetProductVersion | GetProductVersion | Queries a product version. |
| ListProductVersions | ListProductVersions | Queries the versions of a product. |
Templates
|
API |
Title |
Description |
| CreatePortfolio | CreatePortfolio | Creates a product portfolio. |
| AssociateProductWithPortfolio | AssociateProductWithPortfolio | Adds a product to a product portfolio. |
| DeletePortfolio | DeletePortfolio | Deletes a product portfolio. |
| DisassociateProductFromPortfolio | DisassociateProductFromPortfolio | Removes a product from the product portfolio. |
| UpdatePortfolio | UpdatePortfolio | Updates a portfolio. |
| GetPortfolio | GetPortfolio | Queries the information about a product portfolio. |
| ListPortfolios | ListPortfolios | Queries a list of portfolios. |
Product portfolios
|
API |
Title |
Description |
| CreateConstraint | CreateConstraint | Creates a constraint. |
| DeleteConstraint | DeleteConstraint | Deletes a constraint. |
| UpdateConstraint | UpdateConstraint | Updates the information about a constraint. |
| GetConstraint | GetConstraint | Queries the information about a constraint. |
Constraints
|
API |
Title |
Description |
| AssociatePrincipalWithPortfolio | AssociatePrincipalWithPortfolio | Associates a Resource Access Management (RAM) user or a RAM role with a product portfolio. |
| DisassociatePrincipalFromPortfolio | DisassociatePrincipalFromPortfolio | Removes authorization for a principal to access a product portfolio. |
| ListPrincipals | ListPrincipals | Lists the Resource Access Management (RAM) users and RAM roles that are granted permissions on a product portfolio. |
Authorization
|
API |
Title |
Description |
| GetTagOption | GetTagOption | Queries the details of a tag option. |
| DisAssociateTagOptionFromResource | DisAssociateTagOptionFromResource | Disassociates a tag option from a resource. |
| ListResourcesForTagOption | ListResourcesForTagOption | Queries the resources that are associated with a tag option. |
| UpdateTagOption | UpdateTagOption | Updates the tag option. |
| ListTagOptions | ListTagOptions | Lists tag options. |
| DeleteTagOption | DeleteTagOption | Deletes a tag option. |
| CreateTagOption | CreateTagOption | Creates a tag option. |
| AssociateTagOptionWithResource | AssociateTagOptionWithResource | Associates the tag option with a resource. |
Regions
|
API |
Title |
Description |
| CreateProduct | CreateProduct | Creates a product. |
| CreateTemplate | CreateTemplate | Creates a template. Service Catalog saves the template based on the parameters that you specify and returns the URL of the template. |
| DeleteProduct | DeleteProduct | Deletes a product. |
| GetTask | GetTask | Queries the information about a task. |
| GetTemplate | GetTemplate | Queries the details of a template. |
| ListRegions | ListRegions | Queries regions. |
| ListTasks | ListTasks | Queries a list of tasks. |
| UpdateProduct | UpdateProduct | Updates a product. |