Use the CreateApp API to create an application - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Creates an app with the centralized role.

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

ebs:CreateApp

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AppName	string	Yes	The name of the app.	App1
AppTags	array<object>	Yes	The user-defined tags. You can specify multiple tags.	default
	object	No
TagKey	string	No	The tag key.	controlledBy
TagValue	string	No	The tag value of the dedicated cluster.	ear
SubscribeStatus	string	Yes	The subscription status of the app usage report. Valid values: UnSubscribe Subscribe	Subscribe
SubscribePeriod	string	Yes	The send interval of the app usage report. Valid values: Weekly Biweekly Monthly Default value: Weekly.	Weekly
Description	string	No	The description of the app.	test
ReportSendEnabled	boolean	No	Specifies whether to send the report to email and internal messages.	false
RegionId	string	No	The region ID. You can call DescribeRegions to query the most recent region list.	cn-hangzhou
Owner	string	No	The Alibaba Cloud UID of the baseline owner.	1/0
ClientToken	string	No	A string generated by the server that serves as a request identifier for the client.	123e4567-e89b-12d3-a456-42665544****

Response elements

Element	Type	Description	Example
	object	LensResponse
RequestId	string	The request ID.	E604ABBF-FD0F-5080-BE2B-BCF674A9E941
Code	string	The status code. A value of 200 indicates success.	OK
UserCode	string	The status code.	OK
Message	string	The additional information. If the request is successful, "success" is returned. If the request fails, a specific error code is returned.	successful
Success	boolean	Indicates whether the app was created successfully. Valid values: true: The app was created successfully. false: The app failed to be created.	True
HttpStatusCode	integer	The error code description.	200
DynamicCode	string	The dynamic error code.	200
DynamicMessage	string	The dynamic message. This parameter is not in use. Ignore this parameter.	-
AccessDeniedDetail	string	The detailed reason why access was denied.	None
AppId	string	The app ID.	app-bd5e3533
AppName	string	The app name.	TestApp_g5t

Examples

Success response

JSON format

{
  "RequestId": "E604ABBF-FD0F-5080-BE2B-BCF674A9E941",
  "Code": "OK",
  "UserCode": "OK",
  "Message": "successful",
  "Success": true,
  "HttpStatusCode": 200,
  "DynamicCode": "200",
  "DynamicMessage": "-",
  "AccessDeniedDetail": "None",
  "AppId": "app-bd5e3533",
  "AppName": "TestApp_g5t"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The parameter %s is invalid.	The specified parameter value is invalid.
400	InvalidParameter.Conflict	The specified parameter %s and %s are not blank at the same time.
400	InvalidParameter.Format	Specified parameter format is not valid.	english description
400	MissingParameter	The input parameter %s that is mandatory for processing this request is not supplied.	The parameter must be specified.
400	App.NumberExceed	The number of apps exceeded.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	An internal error has occurred.
403	Forbidden	User is not authorized to operate.	You are not authorized to manage the resource. Check the account permissions or contact the Alibaba Cloud account.
403	Forbidden.Action	User is not authorized to operate this action.	You are not authorized to perform this operation. Check the account permissions or contact the Alibaba Cloud account.
403	InvalidAccountStatus.NotEnoughBalance	Your account does not have enough balance.
403	LastTokenProcessing	The last token request is processing.	The value of clientToken is used in another request that is being processed. Try again later.
403	NoPermission.SLR	The RAM user does not have the permission to create service linked role: AliyunServiceLinkedRoleForEBS.	You are not authorized to create service-linked roles.
403	OperationDenied	The operation is not allowed.	The operation is not supported.
404	InvalidApi.NotFound	Specified api is not found, please check your url and method.
404	NoSuchResource	The specified resource does not exist.	The specified resource does not exist.
504	RequestTimeout	The request is timeout, please try again later.	The request has timed out. Try again later.
429	BLOCK.LimitedRequest	Request was denied due to user flow control.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.