# Alibaba Cloud Cloud Architect Design Tools API

> Alibaba Cloud Cloud Architect Design Tools API on Apizie: 38 endpoints (Fails back the disaster recovery set to the primary zone, Switches the disaster recovery set to a supported zone, Transfers a CADT application or template from one resource group to another, Creates a new application based on an official or private template in Cloud Architect Design Tools (CADT).…, …) 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-bpstudio/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

Alibaba Cloud OpenAPI for Cloud Architect Design Tools (bpstudio, version 2021-09-31). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Fails back the disaster recovery set to the primary zone
`POST https://zieapi.vercel.app/v1/cloud:aliyun-bpstudio/app-fail-back` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://bpstudio.ap-southeast-1.aliyuncs.com |
| ApplicationId | string | no | The application ID |

### Switches the disaster recovery set to a supported zone
`POST https://zieapi.vercel.app/v1/cloud:aliyun-bpstudio/app-fail-over` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://bpstudio.ap-southeast-1.aliyuncs.com |
| ApplicationId | string | no | The application ID |
| FailZone | string | no | The target zone for the disaster recovery switchover |

### Transfers a CADT application or template from one resource group to another
`POST https://zieapi.vercel.app/v1/cloud:aliyun-bpstudio/change-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://bpstudio.ap-southeast-1.aliyuncs.com |
| ResourceId | string | yes | The ID of the CADT application or template |
| NewResourceGroupId | string | yes | The ID of the new resource group |
| ResourceType | string | yes | The type of the resource whose resource group is to be changed. Valid values: APPLICATION (CADT application) and TEMPLATE (CADT template) |

### Creates a new application based on an official or private template in Cloud Architect Design Tools (CADT).…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-bpstudio/create-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://bpstudio.ap-southeast-1.aliyuncs.com |
| TemplateId | string | yes | The template ID |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can generate the value from your client and make sure that the… |
| Name | string | yes | The name of the application. The application name must be unique and cannot be the same as the name of another application. You can call… |
| AreaId | string | no | The region ID. The region ID must be the same as the region where the template is published. Otherwise, the template falls back to the… |
| ResourceGroupId | string | no | The ID of the resource group to which the application belongs. This parameter affects the resource groups of all resources in the created… |
| CreateAsync | string | no | Specifies whether to create the application asynchronously. Asynchronous creation: The application ID is immediately returned, but the… |
| Instances | string | no | The list of instances to be replaced. Creation in an existing VPC is supported (JSON-encoded) |
| Configuration | string | no | The configuration parameters of the application. For example, enableMonitor specifies whether automatic creation of CloudMonitor is… |
| Variables | string | no | The variables for the template. For templates with parameters, this field is used to pass the relevant parameter values. If this field is… |
| ProcessVariables | string | no | The list of variable values for the process (JSON-encoded) |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://bpstudio.ap-southeast-1.aliyuncs.com |
| ProcessId | string | yes | The task ID |
| TaskName | string | yes | The task name |
| AppId | string | yes | The application ID. You can call the ListApplication operation to obtain the application ID. For more information, see ListApplication |
| Variables | string | no | The list of variable values for the flow (JSON-encoded) |

### Deletes an application
`POST https://zieapi.vercel.app/v1/cloud:aliyun-bpstudio/delete-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://bpstudio.ap-southeast-1.aliyuncs.com |
| ApplicationId | string | yes | The application ID |
| ResourceGroupId | string | no | The resource group ID |

### Creates a resource after successful billing
`POST https://zieapi.vercel.app/v1/cloud:aliyun-bpstudio/deploy-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://bpstudio.ap-southeast-1.aliyuncs.com |
| ApplicationId | string | yes | The application ID |
| ResourceGroupId | string | no | The resource group ID |
| ClientToken | string | no | The idempotency token |

### Asynchronously executes product operations
`POST https://zieapi.vercel.app/v1/cloud:aliyun-bpstudio/execute-operation-async` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://bpstudio.ap-southeast-1.aliyuncs.com |
| ApplicationId | string | no | The ID of the Cloud Architect Design Tools (CADT) application |
| ServiceType | string | yes | The resource type. Set this parameter to ecs to modify ECS-related parameters |
| Operation | string | yes | The type of the current operation used to modify a product. Some operation types are universal, while others are dedicated. The following… |
| Attributes | string | no | The parameters related to the operation. Specify the corresponding parameters based on the value of the Operation parameter. The… |
| ResourceGroupId | string | no | The ID of the resource group used for permission verification |
| ClientToken | string | no | The idempotency token |

### Maintains the resources of an application synchronously
`POST https://zieapi.vercel.app/v1/cloud:aliyun-bpstudio/execute-operation-sync` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://bpstudio.ap-southeast-1.aliyuncs.com |
| ApplicationId | string | no | The Cloud Architect Design Tools application ID |
| ServiceType | string | yes | The resource type. For example, to perform operations on DDS resources, enter dds |
| Operation | string | yes | The operation type |
| Attributes | string | no | The operation parameters. Enter the corresponding parameters based on the Operation value (JSON-encoded) |
| ResourceGroupId | string | no | The resource group ID used for resource group permission verification |
| ClientToken | string | no | The idempotence token |

### Creates a task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-bpstudio/execute-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://bpstudio.ap-southeast-1.aliyuncs.com |
| TaskId | integer | no | The task ID |

### Retrieves the basic information, validation results, billing results, and deployment results of a specified…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-bpstudio/get-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://bpstudio.ap-southeast-1.aliyuncs.com |
| ApplicationId | string | yes | The application ID |
| ResourceGroupId | string | no | The resource group ID |

### Retrieves the values of all input template variables for an application
`POST https://zieapi.vercel.app/v1/cloud:aliyun-bpstudio/get-application-variables` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://bpstudio.ap-southeast-1.aliyuncs.com |
| AppId | string | no | The ID of the application. You can call the ListApplication operation to obtain the ID |

### Retrieves a list of variables that need to be reconfigured
`POST https://zieapi.vercel.app/v1/cloud:aliyun-bpstudio/get-application-variables4-fail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://bpstudio.ap-southeast-1.aliyuncs.com |
| AppId | string | no | The application ID. To obtain the application ID, call the ListApplication operation. For more information, see ListApplication |

### Retrieves the result of an asynchronous operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-bpstudio/get-execute-operation-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://bpstudio.ap-southeast-1.aliyuncs.com |
| OperationId | string | yes | The operation ID. The ID is valid for 1 hour. If the validity period expires, the result cannot be queried and the Data property is not… |
| ResourceGroupId | string | no | The ID of the resource group. This ID is used to verify permissions related to the resource group |

### Retrieves the status of a specified disaster recovery task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-bpstudio/get-fo-task-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://bpstudio.ap-southeast-1.aliyuncs.com |
| TaskId | integer | no | The ID of the disaster recovery switchover task |

### Retrieves the optional values for template variables
`POST https://zieapi.vercel.app/v1/cloud:aliyun-bpstudio/get-linkage-attributes-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://bpstudio.ap-southeast-1.aliyuncs.com |
| TemplateId | string | yes | The template ID |
| AreaId | string | no | The region ID |
| Instances | string | no | The list of instances to be replaced (JSON-encoded) |
| Variables | string | no | The values for the parameters in the template. If you do not specify this parameter, the default values are used (JSON-encoded) |
| TargetVariable | string | yes | The template variable to query |
| NextToken | string | no | The token to retrieve the next page of results |
| MaxResults | integer | no | The number of entries to return on each page |

### Retrieves the input parameters for a specific operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-bpstudio/get-operation-params` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://bpstudio.ap-southeast-1.aliyuncs.com |
| ServiceType | string | yes | The service type |
| Operation | string | yes | The operation name |

### Queries the zones to which a disaster recovery service can fail over
`POST https://zieapi.vercel.app/v1/cloud:aliyun-bpstudio/get-potential-fail-zones` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://bpstudio.ap-southeast-1.aliyuncs.com |
| IsPlanId | string | no | Specifies whether the ObjectId parameter specifies a disaster recovery set ID |
| ObjectId | string | no | If you set IsPlanId to false, specify the ID of a disaster recovery application. If you set IsPlanId to true, specify the ID of a disaster… |

### Retrieves the upgrade or downgrade records for an application
`POST https://zieapi.vercel.app/v1/cloud:aliyun-bpstudio/get-resource4-modify-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://bpstudio.ap-southeast-1.aliyuncs.com |
| ApplicationId | string | yes | The application ID |
| NextToken | integer | no | The page number to return |
| MaxResults | integer | no | The number of entries per page |

### Retrieves the result of a price inquiry
`POST https://zieapi.vercel.app/v1/cloud:aliyun-bpstudio/get-result4-query-instance-price4-modify` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://bpstudio.ap-southeast-1.aliyuncs.com |
| TaskId | string | yes | The ID of the price inquiry task for the instance configuration change. The ID is valid for one hour. If the task times out, you cannot… |
| ApplicationId | string | no | The application ID |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://bpstudio.ap-southeast-1.aliyuncs.com |
| TaskId | string | no | The ID of the task |

### Retrieves information about template images and architecture diagrams
`POST https://zieapi.vercel.app/v1/cloud:aliyun-bpstudio/get-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://bpstudio.ap-southeast-1.aliyuncs.com |
| TemplateId | string | yes | The template ID |
| Region | string | no | The region of the template |
| ResourceGroupId | string | no | The resource group ID |

### Prepares for an application switchover and initializes the switchover task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-bpstudio/init-app-fail-over` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://bpstudio.ap-southeast-1.aliyuncs.com |
| ApplicationId | string | no | The application ID |

### This operation returns a list of all applications that belong to the current user. You can use the optional…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-bpstudio/list-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://bpstudio.ap-southeast-1.aliyuncs.com |
| NextToken | integer | yes | The page number for the returned results. The value must be an integer from 1 to 10000 |
| MaxResults | integer | yes | The number of entries to return on each page. The value must be an integer from 1 to 50 |
| Keyword | string | no | The keyword to search for in application names |
| OrderType | integer | no | The sorting order. Valid values:1: Sort by update time. 2: Sort by creation time. |
| Status | string | no | The status of the application |
| ResourceGroupId | string | no | The ID of the resource group |
| ResourceId | string | no | The ID of the resource |
| TemplateId | string | no | The ID of the template |
| ShowHide | string | no | Specifies whether to show hidden applications. Default value: \`true\`.- \`true\`: Shows hidden applications.- \`false\`: Does not show… |

### This operation queries all disaster recovery service plans in the current account
`POST https://zieapi.vercel.app/v1/cloud:aliyun-bpstudio/list-fo-created-apps` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://bpstudio.ap-southeast-1.aliyuncs.com |

### Lists the operations that a service supports
`POST https://zieapi.vercel.app/v1/cloud:aliyun-bpstudio/list-operations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://bpstudio.ap-southeast-1.aliyuncs.com |
| ServiceType | string | yes | The service type |

### Lists the supported services
`POST https://zieapi.vercel.app/v1/cloud:aliyun-bpstudio/list-services` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://bpstudio.ap-southeast-1.aliyuncs.com |

### Queries the tags of an application or a template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-bpstudio/list-tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://bpstudio.ap-southeast-1.aliyuncs.com |
| ClientToken | string | no | An idempotence token |
| RegionId | string | yes | The region ID |
| NextToken | string | no | The token that is used to start the next query |
| ResourceType | string | yes | The resource type |
| ResourceId | string | yes | The resource IDs. You can specify up to 50 resource IDs (JSON-encoded) |
| Tag | string | no | The tags. You can specify up to 20 tags (JSON-encoded) |

### Retrieves a list of templates, including template names, architecture diagram URLs, and URLs of serialized…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-bpstudio/list-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://bpstudio.ap-southeast-1.aliyuncs.com |
| NextToken | integer | yes | The page number |
| MaxResults | integer | yes | The page size |
| OrderType | integer | no | The sort field. Valid values: 1: Sort by update time. 2: Sort by creation time. 3: Sort by system recommendation. 4: Sort by usage count.… |
| Keyword | string | no | The keyword used to search for template names |
| Type | string | yes | The template type. A value of public indicates a public template, and a value of private indicates a private template |
| TagList | integer | no | The tags of the template |
| ResourceGroupId | string | no | The ID of the resource group |
| Tag | string | no | The list of tags (JSON-encoded) |

### Modifies the configuration of an application
`POST https://zieapi.vercel.app/v1/cloud:aliyun-bpstudio/modify-application-spec` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://bpstudio.ap-southeast-1.aliyuncs.com |
| ApplicationId | string | yes | The application ID |
| InstanceSpec | string | no | The specifications for the configuration change (JSON-encoded) |

### Queries the price for an upgrade or downgrade
`POST https://zieapi.vercel.app/v1/cloud:aliyun-bpstudio/query-instance-price4-modify` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://bpstudio.ap-southeast-1.aliyuncs.com |
| ApplicationId | string | yes | The application ID |
| InstanceId | string | yes | The ID of the resource to upgrade or downgrade |
| Configuration | string | no | The list of target configurations (JSON-encoded) |

### Queries a list of specifications for an upgrade or downgrade
`POST https://zieapi.vercel.app/v1/cloud:aliyun-bpstudio/query-instance-spec4-modify` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://bpstudio.ap-southeast-1.aliyuncs.com |
| ApplicationId | string | yes | The ID of the Cloud Architect Design Tools application |
| InstanceId | string | yes | The ID of the resource to be upgraded or downgraded |
| MethodName | string | no | The API operation name of the corresponding product. To query the specifications of an ECS instance, enter… |
| Parameters | string | no | The constraints on the specifications (JSON-encoded) |

### You can retrieve a list of template variables that need to be reconfigured. After you reassign values to…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-bpstudio/re-config-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://bpstudio.ap-southeast-1.aliyuncs.com |
| AppId | string | no | The ID of the application. Call the ListApplication operation to obtain the application ID |
| Variables | string | no | The properties to update |

### Releases the resources of an application
`POST https://zieapi.vercel.app/v1/cloud:aliyun-bpstudio/release-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://bpstudio.ap-southeast-1.aliyuncs.com |
| ApplicationId | string | yes | The ID of the application |
| ResourceGroupId | string | no | The ID of the resource |
| ClientToken | string | no | The idempotency token |

### Validates the input for resources in an application. This is an asynchronous operation. You can call…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-bpstudio/validate-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://bpstudio.ap-southeast-1.aliyuncs.com |
| ApplicationId | string | yes | The application ID |
| ResourceGroupId | string | no | The resource group ID |
| ClientToken | string | no | The idempotence token |

### Obtains a price quote for the resources in an application. Call GetApplication to retrieve the price quote
`POST https://zieapi.vercel.app/v1/cloud:aliyun-bpstudio/valuate-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://bpstudio.ap-southeast-1.aliyuncs.com |
| ApplicationId | string | yes | The application ID |
| ResourceGroupId | string | no | The resource group ID |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request |

### Queries the price of a template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-bpstudio/valuate-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://bpstudio.ap-southeast-1.aliyuncs.com |
| TemplateId | string | yes | The template ID |
| ClientToken | string | yes | The idempotency token |
| AreaId | string | no | The region ID |
| Instances | string | no | The list of instances to be replaced (JSON-encoded) |
| ResourceGroupId | string | no | The ID of the resource group to which the application belongs |
| Variables | string | no | For templates with parameters, this field is used to pass the relevant parameter values. If this field is not specified, the default… |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://bpstudio.ap-southeast-1.aliyuncs.com |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-bpstudio/app-fail-back" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Cloud Architect Design Tools API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-bpstudio/app-fail-back with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

### Can AI agents use the Alibaba Cloud Cloud Architect Design Tools 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-bpstudio.

### What is the status of the Alibaba Cloud Cloud Architect Design Tools API?
Needs your own provider key (bring your own key)