# Alibaba Cloud Service Catalog API

> Alibaba Cloud Service Catalog API on Apizie: 56 endpoints (Approves a plan, Grants authorization for a product portfolio to Resource Access Management (RAM) users or RAM roles within…, Adds a product to a product portfolio, Associates a tag option with a resource, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-servicecatalog`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/servicecatalog
- Page: https://zieapi.vercel.app/api/cloud/aliyun-servicecatalog
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-servicecatalog/openapi.json

Alibaba Cloud OpenAPI for Service Catalog (servicecatalog, version 2021-09-01). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Approves a plan
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/approve-provisioned-product-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| PlanId | string | yes | The plan ID |
| ApprovalAction | string | yes | The approval action. Valid values: Approve: Approve. Reject: Reject |
| Comment | string | no | The approval comment |

### Grants authorization for a product portfolio to Resource Access Management (RAM) users or RAM roles within…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/associate-principal-with-portfolio` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| PortfolioId | string | yes | The product portfolio ID |
| PrincipalType | string | yes | The RAM entity type. Valid values: RamUser: Resource Access Management (RAM) user. RamRole: RAM role |
| PrincipalId | string | no | The RAM entity ID. For the method to obtain the ID of a Resource Access Management (RAM) user, see… |
| PrincipalPattern | string | no | The RAM entity name rule. This parameter takes effect only when PrincipalType is set to RamPattern. To configure a name rule for RAM… |

### Adds a product to a product portfolio
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/associate-product-with-portfolio` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| ProductId | string | yes | The product ID |
| PortfolioId | string | yes | The product portfolio ID |

### Associates a tag option with a resource
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/associate-tag-option-with-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| ResourceId | string | yes | The ID of the resource to which the tag option is associated |
| TagOptionId | string | yes | The ID of the tag option |

### Cancels a plan
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/cancel-provisioned-product-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| PlanId | string | yes | The plan ID |

### Copies a product
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/copy-product` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| SourceProductArn | string | yes | The ARN of the source product. The ARN of the product to be copied can be from a product under the current account or from a product… |
| TargetProductName | string | no | The name of the target product |

### Creates a constraint
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/create-constraint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| ConstraintType | string | yes | The constraint type. Valid values: Launch: launch constraint |
| Config | string | yes | The constraint configuration. Format: { "LocalRoleName": " " } |
| Description | string | no | The description of the constraint. The value must be 1 to 128 characters in length |
| PortfolioId | string | yes | The ID of the product portfolio to which the constraint belongs |
| ProductId | string | yes | The ID of the product to which the constraint applies |

### Creates a product portfolio
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/create-portfolio` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| PortfolioName | string | yes | The name of the product portfolio. The name must be 1 to 128 characters in length |
| Description | string | no | The description of the product portfolio. The description must be 1 to 128 characters in length |
| ProviderName | string | yes | The provider of the product portfolio. The name must be 1 to 128 characters in length |

### Creates a product
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/create-product` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| ProductName | string | yes | The name of the product. The name must be 1 to 128 characters in length |
| ProductType | string | yes | The type of the product. Valid value: Ros: Resource Orchestration Service (ROS) |
| Description | string | no | The description of the product. The description must be 1 to 128 characters in length |
| ProviderName | string | yes | The provider of the product. The name must be 1 to 128 characters in length |
| ProductVersionParameters | string | no | The product edition information (JSON-encoded) |
| TemplateType | string | no | The product templatetype. Valid values: RosTerraformTemplate: a Terraform template supported by Resource Orchestration Service (ROS).… |

### Creates an edition
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/create-product-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| ProductVersionName | string | yes | The edition name. The name must be 1 to 128 characters in length |
| TemplateType | string | yes | The product templatetype. Valid values: RosTerraformTemplate: Terraform templates supported by Resource Orchestration Service (ROS).… |
| TemplateUrl | string | yes | The URL of the template. For more information about how to obtain the template URL, see [CreateTemplate](~~CreateTemplate~~) |
| Description | string | no | The edition description. The description must be 1 to 128 characters in length |
| Guidance | string | no | The recommendation information. Valid values: Default: None. This is the default value. Recommended: Stable version. Latest: Latest… |
| Active | string | no | Specifies whether to enable the product version. Valid values: true: Enabled. This is the default value. false: Disabled |
| ProductId | string | yes | The ID of the product to which the edition belongs |

### Creates a plan
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/create-provisioned-product-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| PlanName | string | yes | The plan name. The length is 1 to 128 characters |
| PlanType | string | yes | The plan type. Valid value: Ros, which indicates Resource Orchestration Service (ROS) |
| ProvisionedProductName | string | yes | The instance name. The length is 1 to 128 characters |
| PortfolioId | string | no | The product portfolio ID. If a default launch option exists, you do not need to specify PortfolioId. If no default launch option exists,… |
| ProductId | string | yes | The product ID |
| ProductVersionId | string | yes | The edition ID |
| Parameters | string | no | The template parameters entered by the user. Maximum value of N: 200. Parameters is optional. If you specify Parameters, you must specify… |
| StackRegionId | string | yes | The region ID of the Resource Orchestration Service (ROS) stack. For more information about how to obtain the list of regions supported by… |
| Tags | string | no | The custom tags entered by the user. Maximum value of N: 20. Tags is optional. If you specify Tags, you must specify both Tags.N.Key and… |
| OperationType | string | no | The plan operation type. Valid values: LaunchProduct (default): Launches a product. UpdateProvisionedProduct: Updates an instance.… |
| Description | string | no | The plan description. The length is 1 to 128 characters |

### Creates a tag option
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/create-tag-option` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| Key | string | yes | The key of the tag option entered by the user. The key can be up to 128 characters in length. It cannot start with `aliyun` or `acs:`, and… |
| Value | string | yes | The value of the tag option entered by the user. The value can be up to 128 characters in length. It cannot start with `acs:`, and cannot… |

### Creates a template. Service Catalog saves the uploaded template and returns the template URL
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/create-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| TemplateBody | string | yes | The template content. For more information about the template syntax, see https://help.aliyun.com/document_detail/184397.html |
| TemplateType | string | yes | The product templatetype. Valid values: RosTerraformTemplate: Terraform templates supported by Resource Orchestration Service (ROS).… |
| TerraformVariables | string | no | The Terraform template variable settings, represented in a structured format. Service Catalog applies the variable settings to the… |

### Deletes a constraint
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/delete-constraint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| ConstraintId | string | yes | The constraint ID |

### Deletes a product portfolio
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/delete-portfolio` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| PortfolioId | string | yes | The ID of the product portfolio |

### Deletes a product
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/delete-product` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| ProductId | string | yes | The ID of the product |

### Deletes a product edition
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/delete-product-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| ProductVersionId | string | yes | The product edition ID |

### Deletes a plan
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/delete-provisioned-product-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| PlanId | string | yes | The plan ID |

### Deletes a tag option
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/delete-tag-option` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| TagOptionId | string | yes | The ID of the tag option |

### Disassociates a tag option from a resource
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/dis-associate-tag-option-from-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| ResourceId | string | yes | The ID of the resource with which the tag option is associated |
| TagOptionId | string | yes | The ID of the tag option |

### Deletes a product portfolio authorization
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/disassociate-principal-from-portfolio` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| PortfolioId | string | yes | The product portfolio ID |
| PrincipalType | string | yes | The RAM entity type. Valid values: RamUser: Resource Access Management (RAM) user. RamRole: RAM role |
| PrincipalId | string | no | The RAM entity ID. For the method to obtain the ID of a Resource Access Management (RAM) user, see… |
| PrincipalPattern | string | no | The RAM entity name rule. This parameter takes effect when PrincipalType is set to RamPattern. To configure a name rule for RAM users, use… |

### Removes a product from a product portfolio
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/disassociate-product-from-portfolio` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| ProductId | string | yes | The product ID |
| PortfolioId | string | yes | The product portfolio ID |

### Runs a plan
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/execute-provisioned-product-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| PlanId | string | yes | The ID of the plan |

### Queries the information about a constraint
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/get-constraint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| ConstraintId | string | yes | The ID of the constraint |

### Queries the information about a product portfolio
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/get-portfolio` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| PortfolioId | string | yes | The ID of the product portfolio |

### Queries the information about a product as the administrator
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/get-product-as-admin` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| ProductId | string | yes | The ID of the product |

### Queries the information about a product as a user
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/get-product-as-end-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| ProductId | string | yes | The ID of the product |

### Queries a product version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/get-product-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| ProductVersionId | string | yes | The ID of the product version |

### Queries the information about a product instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/get-provisioned-product` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| ProvisionedProductId | string | yes | The ID of the product instance |

### Queries a provisioned product plan
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/get-provisioned-product-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| PlanId | string | yes | The ID of the plan |

### Queries the details of a tag option
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/get-tag-option` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| TagOptionId | string | yes | The ID of the tag option |

### Queries the information about a task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/get-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| TaskId | string | yes | The ID of the task |

### Queries the details of a template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/get-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| ProductId | string | yes | The ID of the product |
| ProductVersionId | string | yes | The ID of the product version |

### Launches a product
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/launch-product` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| ProvisionedProductName | string | yes | The name of the product instance. The value must be 1 to 128 characters in length |
| PortfolioId | string | no | The ID of the product portfolio. If the PortfolioId parameter is not required, you do not need to specify the PortfolioId parameter. If… |
| ProductId | string | yes | The ID of the product |
| ProductVersionId | string | yes | The ID of the product version |
| Parameters | string | no | The input parameters of the template. You can specify up to 200 parameters. This parameter is optional. If you specify the Parameters… |
| StackRegionId | string | yes | The ID of the region to which the Resource Orchestration Service (ROS) stack belongs. For more information about how to obtain the regions… |
| Tags | string | no | The custom tags that are specified by the end user. Maximum value of N: 20. The Tags parameter is optional. If you specify the Tags… |

### Queries launch options
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/list-launch-options` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| ProductId | string | yes | The ID of the product |

### Queries a list of portfolios
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/list-portfolios` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| ProductId | string | no | The product ID |
| Filters | string | no | The filters (JSON-encoded) |
| SortBy | string | no | The field to sort by. Set the value to `CreateTime` to sort the results by creation time |
| SortOrder | string | no | The ordering. Valid values: `Asc`: in ascending order. `Desc`: in descending order |
| PageNumber | integer | no | The page number. The page number starts from 1. Default value: 1 |
| PageSize | integer | no | The number of entries to return on each page. Valid values: 1 to 100. Default value: 10 |
| Scope | string | no | The query scope. Valid values: Local (default): queries the portfolios created in the current account. Import: queries the portfolios… |

### Lists the Resource Access Management (RAM) users and RAM roles that are granted permissions on a product…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/list-principals` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| PortfolioId | string | yes | The ID of the product portfolio |

### Queries the versions of a product
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/list-product-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| ProductId | string | yes | The ID of the product |

### Queries products as an administrator
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/list-products-as-admin` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| PortfolioId | string | no | The ID of the product portfolio |
| Filters | string | no | The filter conditions (JSON-encoded) |
| SortBy | string | no | The field that is used to sort the queried data. Set the value to CreateTime, which specifies the time when the product was created |
| SortOrder | string | no | The order in which you want to sort the queried data. Valid values: Asc: the ascending order Desc: the descending order |
| PageNumber | integer | no | The number of the page to return. Pages start from page 1. Default value: 1 |
| PageSize | integer | no | The number of entries to return on each page. Valid values: 1 to 100. Default value: 10 |
| Scope | string | no | The query scope. Valid values: Local: the products that are created by using the current account. This is the default value. Import: the… |

### Queries products as a user
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/list-products-as-end-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| Filters | string | no | The filter conditions (JSON-encoded) |
| SortBy | string | no | The field that is used to sort data. The default value is CreateTime, which specifies the time when the product was created |
| SortOrder | string | no | The method that is used to sort the returned entries. Valid values: Asc: sorts the entries in ascending order. Desc (default): sorts the… |
| PageNumber | integer | no | The number of the page to return. Pages start from page 1. Default value: 1 |
| PageSize | integer | no | The number of entries to return on each page. Valid values: 1 to 100. Default value: 10 |

### Queries a list of plan reviewers
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/list-provisioned-product-plan-approvers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| AccessLevelFilter | string | no | The access filter. Valid values: User (default): queries the plans that are created by the current requester. Account: queries the plans… |
| Filters | string | no | An array that consists of filter conditions (JSON-encoded) |
| ApprovalFilter | string | no | The access filter of the review dimension. Valid values: AccountRequests: queries all reviewed plans that belong to the current Alibaba… |

### Queries a list of plans. You can query plans from the end user dimension or from the review dimension
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/list-provisioned-product-plans` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| Filters | string | no | An array that consists of filter conditions (JSON-encoded) |
| SortBy | string | no | The information based on which you want to sort the query results. Set the value to CreateTime, which specifies the creation time of plans |
| SortOrder | string | no | The order in which you want to sort the query results. Valid values: Asc: the ascending order Desc (default): the descending order |
| PageNumber | integer | no | The number of the page to return. Pages start from page 1. Default value: 1 |
| PageSize | integer | no | The number of entries to return on each page. Valid values: 1 to 100. Minimum value: 1. Default value: 10 |
| AccessLevelFilter | string | no | The access filter. Valid values: User (default): queries the plans that are created by the current requester. Account: queries the plans… |
| ApprovalFilter | string | no | The access filter of the review dimension. Valid values: ReceivedRequests: queries plans that are pending for review. ApprovalHistory:… |
| ProvisionedProductId | string | no | The ID of the product instance |

### Queries product instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/list-provisioned-products` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| Filters | string | no | The filter conditions (JSON-encoded) |
| SortBy | string | no | The field that is used to sort the queried data. Set the value to CreateTime, which specifies the time when the product instance was created |
| SortOrder | string | no | The sorting method. Valid values: Asc: the ascending order. Desc (default): the descending order |
| PageNumber | integer | no | The number of the page to return. Pages start from page 1. Default value: 1 |
| PageSize | integer | no | The number of entries to return on each page. Valid values: 1 to 100. Default value: 10 |
| AccessLevelFilter | string | no | The access filter. Valid values: User: queries the product instances that are created by the current requester. This is the default value.… |

### Queries regions
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/list-regions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |

### Queries the resources that are associated with a tag option
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/list-resources-for-tag-option` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| TagOptionId | string | yes | The ID of the tag option |
| ResourceType | string | yes | The type of resource that is associated with the tag option. Valid values: product: product Portfolio: product portfolio |
| PageNumber | integer | no | The number of the page to return. Pages start from page 1. Default value: 1 |
| PageSize | integer | no | The number of entries to return on each page. Valid values: 1 to 100 Minimum value: 1. Default value: 10 |

### Lists tag options
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/list-tag-options` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| PageNumber | integer | no | Page number. Start value: 1. Default value: 1 |
| PageSize | integer | no | Number of data rows displayed per page during paging. Value range: 1 to 100. Start value: 1. Default value: 10 |
| Filters | string | no | Filter condition (JSON-encoded) |
| SortBy | string | no | Sorting field. Set to CreateTime to indicate the tag option creation time |
| SortOrder | string | no | Sorting order. Values: Asc: Ascending order. Desc (default): Descending order |
| NextToken | string | no | The token that is used to retrieve the next page of results. You do not need to specify this parameter for the first request |
| MaxResults | integer | no | The maximum number of results to return |

### Queries a list of tasks
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/list-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| SortBy | string | no | The field to sort by. Set the value to `CreateTime`, which specifies the time when the task was created |
| SortOrder | string | no | The sorting order. Valid values: Asc: in ascending order. Desc: in descending order |
| PageNumber | integer | no | The page number. The value must be a positive integer. Default value: 1 |
| PageSize | integer | no | The number of entries per page. Valid values: 1 to 100. Default value: 10 |
| ProvisionedProductId | string | yes | The instance ID |

### Terminates a product instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/terminate-provisioned-product` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| ProvisionedProductId | string | yes | The ID of the product instance |

### Updates the information about a constraint
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/update-constraint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| ConstraintId | string | yes | The ID of the constraint |
| Config | string | yes | The configurations of the constraint. Format: { "LocalRoleName": "\ " } |
| Description | string | no | The description of the constraint. The value must be 1 to 128 characters in length |

### Updates a portfolio
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/update-portfolio` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| PortfolioId | string | yes | The portfolio ID |
| PortfolioName | string | yes | The portfolio name. It must be 1 to 128 characters in length |
| Description | string | no | The portfolio description. It must be 1 to 128 characters in length |
| ProviderName | string | yes | The portfolio provider. The value must be 1 to 128 characters in length |

### Updates a product
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/update-product` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| ProductName | string | yes | The product name. The name must be 1 to 128 characters in length |
| ProductId | string | yes | The product ID |
| Description | string | no | The product description. The description must be 1 to 128 characters in length |
| ProviderName | string | yes | The product provider. The name must be 1 to 128 characters in length |

### Updates the information about a product version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/update-product-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| ProductVersionId | string | yes | The ID of the product version |
| ProductVersionName | string | yes | The name of the product version. The value must be 1 to 128 characters in length |
| Description | string | no | The description of the product version. The value must be 1 to 128 characters in length |
| Guidance | string | no | The recommendation information. Valid values: Default: No recommendation information is provided. This is the default value. Recommended:… |
| Active | string | no | Specifies whether to enable the product version. Valid values: true: enables the product version. This is the default value. false:… |

### Updates the information about a product instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/update-provisioned-product` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| PortfolioId | string | no | The ID of the product portfolio. The PortfolioId parameter is not required if the default launch option exists. The PortfolioId parameter… |
| ProductId | string | yes | The ID of the product |
| ProductVersionId | string | yes | The ID of the product version. If the values of the ProductVersionId and Parameters parameters are not changed, the information about the… |
| Parameters | string | no | The input parameters of the template. You can specify up to 200 parameters. This parameter is optional. If you specify the Parameters… |
| ProvisionedProductId | string | yes | The ID of the product instance |
| Tags | string | no | The input custom tags. Maximum value of N: 20. The Tags parameter is optional. If you need to specify the Tags parameter, you must specify… |

### Updates a plan
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/update-provisioned-product-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| PlanId | string | yes | The ID of the plan |
| PortfolioId | string | no | The ID of the product portfolio. If the default launch option exists, you do not need to specify PortfolioId. If the default launch option… |
| ProductId | string | yes | The ID of the product |
| ProductVersionId | string | yes | The ID of the product version |
| Description | string | no | The description of the plan |
| Parameters | string | no | An array that consists of the parameters in the template. Maximum value of N: 200. If you specify Parameters, you must specify… |
| Tags | string | no | An array that consists of custom tags. Maximum value of N: 20. If you specify Tags, you must specify Tags.N.Key and Tags.N.Value. The tag… |

### Updates the tag option
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/update-tag-option` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |
| TagOptionId | string | yes | The ID of the tag option |
| Value | string | no | The value of the tag option. The value can be up to 128 characters in length. It cannot start with `acs:` and cannot contain `http://` or… |
| Active | string | no | Specifies whether to enable the tag option. Valid values: true (default) false |

### version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicecatalog.cn-hangzhou.aliyuncs.com |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/approve-provisioned-product-plan" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Service Catalog API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-servicecatalog/approve-provisioned-product-plan with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Service Catalog API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Service Catalog itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Service Catalog API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-servicecatalog.

### What is the status of the Alibaba Cloud Service Catalog API?
Needs your own provider key (bring your own key)