Serverless App Engine:DeployApplication

The ID of the application to deploy.

The JDK version on which the deployment package depends. Valid values:

• Open JDK 8

• Open JDK 7

• Dragonwell 11

• Dragonwell 8

• openjdk-8u191-jdk-alpine3.9

• openjdk-7u201-jdk-alpine3.9

This parameter is not supported when Package Type is set to Image.

The Tomcat version on which the deployment package depends. Valid values:

• apache-tomcat-7.0.91

• apache-tomcat-8.5.42

This parameter is not supported when Package Type is set to Image.

The version number of the deployment package. This parameter is required when Package Type is set to FatJar, War, or PythonZip.

The URL of the deployment package. This parameter is required when Package Type is set to FatJar, War, or PythonZip.

The image URL. This parameter is required when Package Type is set to Image.

The image startup command. The command must be an executable object in the container. Example:

command:
      - echo
      - abc
      - >
      - file0

Based on the preceding example, Command="echo", CommandArgs=["abc", ">", "file0"].

The arguments of the image startup command. These are the arguments required by the startup command specified in Command. Format:

["a","b"]

In the preceding example, CommandArgs=["abc", ">", "file0"], where ["abc", ">", "file0"] must be converted to a String type, and the internal format is a JSON array. If this parameter is not required, leave it empty.

The container environment variable parameters. You can customize environment variables or reference ConfigMap items. To reference a ConfigMap item, create a ConfigMap instance first. For more information, see CreateConfigMap. Valid values:

• Custom configuration

  • name: the name of the environment variable.

  • value: the value of the environment variable. This takes priority over valueFrom.

• Reference a ConfigMap item (valueFrom)

  • name: the name of the environment variable. To reference all keys, enter sae-sys-configmap-all-<ConfigMap name>, such as sae-sys-configmap-all-test1.

  • valueFrom: the environment variable reference. Set the value to configMapRef.

  • configMapId: the ConfigMap ID.

  • key: the key. Do not set this field if you want to reference all keys.

• Reference a secret (valueFrom)

  • name: the name of the environment variable. To reference all keys, enter sae-sys-secret-all-<secret name>, such as sae-sys-secret-all-test1.

  • valueFrom: the environment variable reference. Set the value to secretRef.

  • secretId: the secret ID.

  • key: the key. Do not set this field if you want to reference all keys.

The custom host mapping in the container. Valid values:

• hostName: the domain name or hostname.

• ip: the IP address.

The startup options for a JAR package-based application. The default startup command is $JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs.

The startup arguments for a JAR package-based application. The default startup command is $JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs.

The container health check. Containers that fail the health check are shutdown and recovered. The following methods are supported:

• exec: for example, {"exec":{"command":\["sh","-c","cat/home/admin/start.sh"]},"initialDelaySeconds":30,"periodSeconds":30,"timeoutSeconds":2}

• httpGet: for example, {"httpGet":{"path":"/","port":18091,"scheme":"HTTP","isContainKeyWord":true,"keyWord":"SAE"},"initialDelaySeconds":11,"periodSeconds":10,"timeoutSeconds":1}

• tcpSocket: for example, {"tcpSocket":{"port":18091},"initialDelaySeconds":11,"periodSeconds":10,"timeoutSeconds":1}

Settings:

• exec.command: sets the health check command.

• httpGet.path: the access path.

• httpGet.scheme: HTTP or HTTPS.

• httpGet.isContainKeyWord: true indicates that the keyword is included, false indicates that the keyword is not included, and the absence of this field indicates that the advanced feature is not used.

• httpGet.keyWord: the custom keyword. The isContainKeyWord field must be present when this parameter is used.

• tcpSocket.port: the port for TCP connection detection.

• initialDelaySeconds: sets the initial delay for the health check. Default value: 10. Unit: seconds.

• periodSeconds: sets the health check epoch. Default value: 30. Unit: seconds.

• timeoutSeconds: sets the health check timeout period. Default value: 1. Unit: seconds. If this parameter is set to 0 or is not set, the default timeout period is 1 second.

The application startup status check. Containers that fail multiple health checks are shut down and restarted. Containers that do not pass the health check do not receive SLB traffic. The exec, httpGet, and tcpSocket methods are supported. For specific examples, see the Liveness parameter.

The minimum number of available instances. Valid values:

• If this parameter is set to 0, service is interrupted during the upgrade.

• If this parameter is set to -1, the system-recommended value is used, which is 25% of the current number of instances. If the current number of instances is 5, 5 × 25% = 1.25, which is rounded up to 2.

The minimum percentage of available instances. Valid values:

• -1: the initialization value, which indicates that the percentage is not used.

• 0~100: the unit is percentage, rounded up. For example, if this parameter is set to 50% and the current number of instances is 5, the minimum number of available instances is 3.

The interval between deployment batches. Unit: seconds.

The version of the application runtime environment in the HSF framework, such as the Ali-Tomcat container.

The deployment policy. When the minimum number of available instances is 1, the value of the UpdateStrategy field is "". When the minimum number of available instances is greater than 1, examples are as follows:

• Grayscale 1 instance + 2 subsequent batches + automatic batching + 1-minute batch interval: {"type":"GrayBatchUpdate","batchUpdate":{"batch":2,"releaseType":"auto","batchWaitTime":1},"grayUpdate":{"gray":1}}

• Grayscale 1 instance + 2 subsequent batches + manual batching: {"type":"GrayBatchUpdate","batchUpdate":{"batch":2,"releaseType":"manual"},"grayUpdate":{"gray":1}}

• 2 batches + automatic batching + 0-minute batch interval: {"type":"BatchUpdate","batchUpdate":{"batch":2,"releaseType":"auto","batchWaitTime":0}}

Settings:

• type: the publish policy type. Valid values: GrayBatchUpdate (grayscale publish) and BatchUpdate (batch publish).

• batchUpdate: the batch publish policy.

  • batch: the number of publish batches.

  • releaseType: the processing method between batches. Valid values: auto (automatic) and manual (manual).

  • batchWaitTime: the interval between batches. Unit: minutes.

• grayUpdate: the number of grayscale instances. This parameter is required when type is set to GrayBatchUpdate.

The configuration for log collection to Simple Log Service.

• Use SLS resources automatically created by Serverless App Engine: [{"logDir":"","logType":"stdout"},{"logDir":"/tmp/a.log"}].

• Use custom SLS resources: [{"projectName":"test-sls","logType":"stdout","logDir":"","logstoreName":"sae","logtailName":""},{"projectName":"test","logDir":"/tmp/a.log","logstoreName":"sae","logtailName":""}].

Settings:

• projectName: the name of the project in Simple Log Service.

• logDir: the log path.

• logType: the log type. stdout indicates container standard output logs, and only one entry can be set. If this parameter is not set, file logs are collected.

• logstoreName: the name of the Logstore in Simple Log Service.

• logtailName: the name of the Logtail in Simple Log Service. If this parameter is not specified, a new Logtail is created by automatic creation.

If the SLS collection configuration has not changed during multiple deployments, you do not need to set this parameter (that is, the SlsConfigs field does not need to be included in the request). If you no longer need the SLS collection feature, set the value of this field to an empty string (that is, set the value of the SlsConfigs field to "" in the request).

The time zone. Default value: Asia/Shanghai.

We do not recommend that you configure this field. Configure NasConfigs instead. The ID of the NAS file system. If the configuration has not changed during deployment, you do not need to set this parameter (that is, the NasId field does not need to be included in the request). To clear the NAS configuration, set the value of this field to an empty string (that is, set the value of the NasId field to "" in the request).

We do not recommend that you configure this field. Configure NasConfigs instead. The mount point of the NAS file system in the VPC of the application. If the configuration has not changed during deployment, you do not need to set this parameter (that is, the MountHost field does not need to be included in the request). To clear the NAS configuration, set the value of this field to an empty string (that is, set the value of the MountHost field to "" in the request).

We do not recommend that you configure this field. Configure NasConfigs instead. The NAS mount description. If the configuration has not changed during deployment, you do not need to set this parameter (that is, the MountDesc field does not need to be included in the request). To clear the NAS configuration, set the value of this field to an empty string (that is, set the value of the MountDesc field to "" in the request).

The script that is run after the container starts. A script is triggered immediately after the container is created. Format: {"exec":{"command":\["sh","-c","echo hello"\]}}.

The script that is run before the container stops. A script is triggered before the container is deleted. Format: {"exec":{"command":\["sh","-c","echo hello"\]}}.

The description of the change order.

The startup command for deploying a WAR package-based application. The configuration procedure is the same as that for the startup command of an image-based deployment. For more information, see Configure a startup command.

Specifies whether to automatically enable the application elastic scaling policy. Valid values:

• true: enabled.

• false: disabled.

The ConfigMap mount description. Use a ConfigMap created on the namespace configuration items page to inject configuration information into the container. Settings:

• configMapId: the ConfigMap instance ID. You can obtain it by calling the ListNamespacedConfigMaps operation.

• key: the key.

• mountPath: the mount path.

The graceful shutdown timeout period. Default value: 30. Unit: seconds. Valid values: 1 to 300.

Specifies whether to enable Application High Availability Service (AHAS). Valid values:

• true: enables AHAS.

• false: does not enable AHAS.

The mount path for PHP application monitoring. Ensure that the PHP server loads the configuration file from this path. You do not need to manage the configuration content because Serverless App Engine automatically renders the correct configuration file.

The mount path for the PHP application startup configuration. Ensure that the PHP server uses this configuration file for startup.

The content of the PHP configuration file.

The Tomcat configuration. Set this parameter to "" or "{}" to delete the configuration. Valid values:

• port: the port number. Valid values: 1024 to 65535. Ports smaller than 1024 require root permissions. Because the container is configured with admin permissions, specify a port greater than 1024. Default value: 8080.

• contextPath: the access path. Default value: root directory "/".

• maxThreads: the connection pool size. Default value: 400.

• uriEncoding: the encoding format of Tomcat. Valid values: UTF-8, ISO-8859-1, GBK, and GB2312. Default value: ISO-8859-1.

• useBodyEncodingForUri: specifies whether to use BodyEncoding for URL. Default value: true.

The OSS mount description. Parameter settings:

• bucketName: the bucket name.

• bucketPath: the folder or object that you created in OSS. If the OSS mount folder does not exist, an exception is triggered.

• mountPath: the container path in Serverless App Engine. If the path already exists, it is an overwrite relationship. If the path does not exist, it is created.

• readOnly: specifies whether the container path has read-only permission on the mounted folder resources. Valid values:

  • true: read-only permission.

  • false: read and write permission.

The AccessKey ID for OSS read and write operations.

The AccessKey Secret for OSS read and write operations.

Specifies whether to enable traffic canary release rules. This rule applies only to applications that use the Spring Cloud or Dubbo framework. Valid values:

• true: enables canary release rules.

• false: disables canary release rules.

The PHP version on which the deployment package depends. Not supported for images.

The Container Registry Enterprise instance ID. This parameter is required when ImageUrl is set to a Container Registry Enterprise instance image.

The ARN of the RAM role required for cross-account image pulling. For more information, see Grant permissions across Alibaba Cloud accounts by using a RAM role.

The corresponding secret ID.

Specifies whether to associate an elastic IP address (EIP). Valid values:

• true: associates an EIP.

• false: does not associate an EIP.

The summary of log collection configurations for Kafka. Valid values:

• kafkaEndpoint: the endpoint of the Kafka API.

• kafkaInstanceId: the Kafka instance ID.

• kafkaConfigs: the configuration summary for one or more log entries. For example values and parameter descriptions, see the kafkaConfigs request parameter in this topic.

Enables K8s Service-based service registration and discovery. Valid values:

• portProtocols: the port and protocol. Valid port values: [1,65535]. Valid protocol values: TCP and UDP.

• portAndProtocol: the port and protocol. Valid port values: [1,65535]. Valid protocol values: TCP and UDP. portProtocols is recommended. If portProtocols is set, only portProtocols takes effect.

• enable: enables K8s Service-based service registration and discovery.

Configures K8s Service-based service registration and discovery with end-to-end canary release:

• enable: specifies whether to enable end-to-end canary release based on K8s Service.

  • true: enabled.

  • false: disabled.

• namespaceId: the namespace ID.

• portAndProtocol: the listening port and protocol. Format: {"port:protocol type":"container port"}.

• portProtocols: defines the service port and protocol.

  • port: the port.

  • protocol: the protocol.

  • targetPort: the container port.

• pvtzDiscoveryName: the service discovery name.

• serviceId: the service ID.

• serviceName: the service name.

Specifies the Nacos registry. Valid values:

• 0: Serverless App Engine built-in Nacos.

• 1: self-managed Nacos.

• 2: Microservices Engine (MSE) commercial edition Nacos.

The registry configuration, which takes effect only when the registry type is MSE Nacos Enterprise Edition.

The NAS mount configuration. Valid values:

• mountPath: the container mount path.

• readOnly: set to false for read and write permission.

• nasId: the NAS ID.

• mountDomain: the container mount point address. For more information, see DescribeMountTargets.

• nasPath: the NAS relative file directory.

The Python environment. PYTHON 3.9.15 is supported.

The custom installation module dependencies. By default, the dependencies defined in the requirements.txt file in the root folder are installed. If no dependencies are configured or custom packages are needed, you can specify the dependencies to install.

The version of the .NET framework:

• .NET 3.1

• .NET 5.0

• .NET 6.0

• .NET 7.0

• .NET 8.0

This parameter takes effect only for applications in the stopped state. If you call the DeployApplication operation for a running application, the application is immediately redeployed.

• true: default value. Deploys immediately, applies the new deployment configuration, and starts instances.

• false: applies the new deployment configuration only, without starting application instances.

The application package type. Valid values:

• When you deploy with Java, the following types are supported: FatJar, War, and Image.

• When you deploy with PHP, the following types are supported:

  • PhpZip

  • IMAGE_PHP_5_4

  • IMAGE_PHP_5_4_ALPINE

  • IMAGE_PHP_5_5

  • IMAGE_PHP_5_5_ALPINE

  • IMAGE_PHP_5_6

  • IMAGE_PHP_5_6_ALPINE

  • IMAGE_PHP_7_0

  • IMAGE_PHP_7_0_ALPINE

  • IMAGE_PHP_7_1

  • IMAGE_PHP_7_1_ALPINE

  • IMAGE_PHP_7_2

  • IMAGE_PHP_7_2_ALPINE

  • IMAGE_PHP_7_3

  • IMAGE_PHP_7_3_ALPINE

• When you deploy with Python, the following types are supported: PythonZip and Image.

The CPU resources required for each instance. Unit: millicores. This parameter cannot be set to 0. Only the following defined specifications are supported:

• 500

• 1000

• 2000

• 4000

• 8000

• 12000

• 16000

• 32000

The memory required for each instance. Unit: MB. This parameter cannot be set to 0. The memory has a one-to-one mapping with CPU. Only the following defined specifications are supported:

• 1024: corresponds to 500 and 1000 millicores of CPU.

• 2048: corresponds to 500, 1000, and 2000 millicores of CPU.

• 4096: corresponds to 1000, 2000, and 4000 millicores of CPU.

• 8192: corresponds to 2000, 4000, and 8000 millicores of CPU.

• 12288: corresponds to 12000 millicores of CPU.

• 16384: corresponds to 4000, 8000, and 16000 millicores of CPU.

• 24576: corresponds to 12000 millicores of CPU.

• 32768: corresponds to 16000 millicores of CPU.

• 65536: corresponds to 8000, 16000, and 32000 millicores of CPU.

• 131072: corresponds to 32000 millicores of CPU.

The number of instances.

The security group ID.

The vSwitch where the network interface controllers (NICs) of the application instance reside. The vSwitch must be in the specified VPC.

The canary release tags configured for the application.

Specifies whether to enable the new ARMS feature:

• true: enabled.

• false: disabled.

Specifies whether to enable the CPU Burst feature:

• true: enabled.

• false: disabled.

The RAM role for identity authentication.

The Secret mount description. Use a secret created on the namespace secrets page to inject sensitive information into the container. Settings:

• secretId: the secret instance ID. You can obtain it by calling the ListSecrets operation.

• key: the key.

• mountPath: the mount path.

Specifies whether to enable sidecar resource isolation:

• true: enables isolation.

• false: does not enable isolation.

The custom image type. If the image is not a custom image, set this parameter to an empty string:

• internet: public image.

• intranet: private image.

Configures microservice governance.

• Specifies whether to enable microservice governance (enable):

  • true: enabled.

  • false: disabled.

• Configures lossless online/offline (mseLosslessRule):

  • delayTime: the delay time.

  • enable: specifies whether to enable the lossless online feature. true indicates enabled, and false indicates disabled.

  • notice: specifies whether to enable the notification feature. true indicates enabled, and false indicates disabled.

  • warmupTime: the warm-up duration for low-traffic scenarios. Unit: seconds.

The application version:

• lite: lite edition.

• std: standard edition.

• pro: professional edition.

Enables the application startup probe.

• Check succeeded: indicates that the application started successfully. If you configured Liveness and Readiness checks, they are performed after the application starts successfully.

• Check failed: indicates that the application failed to start. An exception is reported and the application is automatically restarted.

Specifies whether to enable custom Prometheus metric collection.

The Nginx version.

• nginx 1.20

• nginx 1.22

• nginx 1.24

• nginx 1.26

• nginx 1.28

The shared ephemeral storage configuration.

The ALB gateway ReadinessGate configuration.

The maximum number of surge instances. Valid values:

If the minimum number of available instances is 100%, the maximum surge cannot be set to 0. If this parameter is set to -1, the system-recommended value of 30% is used, which is 30% of the current number of instances. For example, if the current number of instances is 10, the value is 10 × 30% = 3.

The maximum surge instance percentage. Valid values:

If the minimum number of available instances is 100%, the maximum surge cannot be set to 0. If this parameter is set to -1, the system-recommended value of 30% is used, which is 30% of the current number of instances. For example, if the current number of instances is 10, the value is 10 × 30% = 3.

The AliyunAgent version.

Specifies whether to reuse the namespace Agent version configuration.

sls log tags