edit-icon download-icon

DeployApplicationRequest

Last Updated: Dec 06, 2018

Function

Deploy the application

Request URL

/pop/v5/changeorder/co_deploy_app

Request method

POST

Request parameters

Parameter Type Required? Description
appId String Yes Application ID, which can be obtained by the ListApplicationRequest API
packageVersion String Yes The application version must be unique and contains no more than 64 characters. We recommend that you add a timestamp to the version.
desc String No Deployment description
deployType String Yes Deployment type, which can be set to “url” or “image”. The value “image” is only for docker applications.
warUrl String No Storage address of the uploaded WAR package (OSS is recommended for storage). This parameter is required when deployType is set to url.
imageUrl String No Image address. This parameter is required when deployType is set to “image”.
groupId String Yes Deployment group ID (which can be obtained by the ListDeployGroupRequest API). Set this parameter to “all” if all groups are selected.
batch Integer No The default value is 1. A maximum of five batches are supported.
batchWaitTime Integer No Wait time. The default value is 0, which indicates no waiting. The maximum value is 5 minutes.
appEnv String No Application environment variable, which must be in the format of
[{"name":"x","value":"y"},{"name":"x2","value":"y2"}]
The key must be name or value.

NOTE: If groupId is set to “all”, it indicates all groups and “batch” is unavailable. The backend conducts batch deployment based on the number of application groups. If there is only one group, the backend deploys the application in one batch.If an application needs to be deployed on one group, enter the group ID.

Response parameters

Parameter Type Description
Code Integer Code
Message String Message
ChangeOrderId String Call the GetChangeOrderInfoRequest API to display the deployment progress.
Thank you! We've received your feedback.