Automate App Deployment with CreateApplication API - CADT - Alibaba Cloud - Cloud Architect Design Tools

This operation creates an application in CADT from an official or a private template. Before calling this operation, ensure that you understand the billing methods and pricing for the associated Alibaba Cloud products.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

bpstudio:CreateApplication

create

*Template

acs:bpstudio::{#accountId}:template/{#TemplateId}

None

Request parameters

Parameter	Type	Required	Description	Example
TemplateId	string	Yes	The template ID.	0KSHPM6SJU03TNZP
ClientToken	string	No	A client token to ensure the idempotence of the request. This token must be client-generated, unique across requests, and contain only ASCII characters.	1600765710019
Name	string	Yes	The name of the application. The name must be unique. You can call the ListApplication operation to query the list of applications. The name can contain letters, Chinese characters, digits, underscores (`_`), and hyphens (`-`). It must be 2 to 128 characters long, start with a letter or a Chinese character, and not start with `http://` or `https://`.	cadt-application
AreaId	string	No	The ID of the region. This must be the same as the region where the template was published. Otherwise, the system reverts to the default version of the template.	cn-hangzhou
ResourceGroupId	string	No	The ID of the resource group. Important This parameter specifies the resource group for all resources in the application. Ensure that the resources you import belong to this resource group.	rg-acfmyjt3c5om3hi
CreateAsync	boolean	No	Specifies whether to create the application asynchronously. Asynchronous creation: The application ID is returned immediately, but the application's state is `Creating`. Before performing subsequent operations, you must wait for the state to change to `Modified`. Synchronous creation: The application ID is returned only after the application is created. Note: If an application template is large or has a large number of template variables, synchronous creation may time out. In this case, create the application asynchronously. Valid values: true : The application is created asynchronously. false : The application is created synchronously.	false
Instances	array<object>	No	The instances to import. You can use this parameter to create an application in an existing Virtual Private Cloud (VPC).
	object	No
NodeType	string	No	The node type.	vpc
NodeName	string	No	The node name.	vpc
Id	string	No	The instance ID.	vpc-bp1q56trhtaq40vlq5ojm
Configuration	object	No	The configuration parameters for the application. For example, `enableMonitor` determines whether to automatically create a monitoring task in Cloud Monitor, `enableReport` determines whether to generate reports, and setting `enableCompliance` to 1 enables compliance checks.	{"enableMonitor":"0", "enableReport":"1"}
	string	No	The value of the configuration parameter.	${var1}
Variables	object	No	The values of the template variables. If you omit this parameter, the variables' default values are used.	{"variable1":"1"}
	any	No	The value of the template variable.
ProcessVariables	object	No	The key-value pairs for the process variables.
	any	No

Response elements

Element	Type	Description	Example
	object
Message	string	The response message.	Success
RequestId	string	The request ID.	A07FFDF2-78FA-1B48-9E38-88E833A93187
Data	string	The application ID.	002XWH7MXB8MJRU0
Code	string	The response code.	200

Examples

Success response

JSON format

{
  "Message": "Success",
  "RequestId": "A07FFDF2-78FA-1B48-9E38-88E833A93187",
  "Data": "002XWH7MXB8MJRU0",
  "Code": "200"
}

Error codes

HTTP status code	Error code	Error message	Description
200	Success	The transaction is successful.
400	ParameterEmpty	You must specify the request parameter.	You must specify request parameters.
400	bp.java.8004	No permissions.
400	bp.java.appNameNotNull	Application name cannot be repeated.
400	bp.java.nopower	No permissions.
400	bp.java.nopowerContact	You do not have permission to use this function. Please contact the main account or permission administrator to authorize the relevant permissions.
400	bp.java.tempNameNotNull	Application name cannot be repeated.
400	bp.java.userNotExist	The user does not exist. The current user does not authenticate AliCloud with his real name.
500	bp.java.notDelete	This template has been shared with other users and cannot be deleted.
500	bp.java.serviceError	The server is abnormal. Please try again later.
404	EntityNotExist.ResourceGroup	The resource group does not exist.
404	EntityNotExist.ResourceId	The resource does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.