Serverless App Engine:DeployApplication

The ID of the application that you want to deploy.

The version of the Java Development Kit (JDK) on which the deployment package depends. The following versions are supported:

• 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 version of Tomcat on which the deployment package depends. The following versions are supported:

• apache-tomcat-7.0.91

• apache-tomcat-8.5.42

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

The version 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 address of the image. This parameter is required when Package Type is set to Image.

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

command:
      - echo
      - abc
      - >
      - file0

Based on this example, Command is "echo" and CommandArgs is ["abc", ">", "file0"].

The parameters of the image startup command. The parameters are for the Command parameter. Format:

["a","b"]

In the preceding example, CommandArgs is ["abc", ">", "file0"]. The value ["abc", ">", "file0"] must be converted to a string. The content in the string is a JSON array. If this parameter is not used, leave it empty.

The environment variables of the container. You can customize environment variables or reference configurations. To reference a configuration item, create a ConfigMap instance first. For more information, see CreateConfigMap. The following table describes the parameters:

• Custom configuration

  • name: The name of the environment variable.

  • value: The value of the environment variable. This parameter takes precedence over valueFrom.

• Reference a configuration item (valueFrom)

  • name: The name of the environment variable. You can reference a single key or all keys. To reference all keys, enter sae-sys-configmap-all-<ConfigMap name>, such as sae-sys-configmap-all-test1.

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

  • configMapId: The ID of the ConfigMap.

  • key: The key. If you want to reference all keys, do not set this parameter.

• Reference a secret (valueFrom)

  • name: The name of the environment variable. You can reference a single key or all keys. To reference all keys, enter sae-sys-secret-all-<Secret name>, such as sae-sys-secret-all-test1.

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

  • secretId: The ID of the secret.

  • key: The key. If you want to reference all keys, do not set this parameter.

The custom mapping between a hostname and an IP address in the container. The following table describes the parameters:

• hostName: The domain name or hostname.

• ip: The IP address.

The startup options of the JAR package. The default startup command is: $JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs

The startup parameters of the JAR package. The default startup command is: $JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs

The container health check. A container that fails the health check will be shut down and restored. The following check 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}

The following table describes the parameters:

• exec.command: The health check command.

• httpGet.path: The request path.

• httpGet.scheme: HTTP or HTTPS.

• httpGet.isContainKeyWord: true indicates that the check is successful if the keyword is included, and false indicates that the check is successful if the keyword is not included. If you do not set this parameter, the advanced feature is not used.

• httpGet.keyWord: The custom keyword. This parameter cannot be left empty when you use the isContainKeyWord parameter.

• tcpSocket.port: The port for the TCP connection check.

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

• periodSeconds: The interval for the health check. Default value: 30. Unit: seconds.

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

The readiness check on the application. A container that fails the readiness check multiple times will be shut down and restarted. The container that fails the check will not receive traffic from the SLB instance. The exec, httpGet, and tcpSocket check methods are supported. For more information, see the Liveness parameter.

The minimum number of surviving instances. Valid values:

• If you set this parameter to 0, the business may be interrupted during an upgrade.

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

The percentage of the minimum number of surviving instances. Valid values:

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

• 0 to 100: The value is a percentage that is rounded up. For example, if you set this parameter to 50% and the total number of instances is 5, the minimum number of surviving instances is 3.

The deployment interval between batches. Unit: seconds.

The version of the application runtime environment in the High-Speed Service Framework (HSF), such as an Ali-Tomcat container.

The deployment policy. If the minimum number of surviving instances is 1, the value of the UpdateStrategy parameter is "". If the minimum number of surviving instances is greater than 1, the following examples are for your reference:

• Canary release for one instance, phased release in two batches, automatic batching, and a 1-minute interval between batches: {"type":"GrayBatchUpdate","batchUpdate":{"batch":2,"releaseType":"auto","batchWaitTime":1},"grayUpdate":{"gray":1}}

• Canary release for one instance, phased release in two batches, and manual batching: {"type":"GrayBatchUpdate","batchUpdate":{"batch":2,"releaseType":"manual"},"grayUpdate":{"gray":1}}

• Phased release in two batches, automatic batching, and a 0-minute interval between batches: {"type":"BatchUpdate","batchUpdate":{"batch":2,"releaseType":"auto","batchWaitTime":0}}

The following table describes the parameters:

• type: The type of the release policy. Valid values: GrayBatchUpdate (canary release) and BatchUpdate (phased release).

• batchUpdate: The phased release policy.

  • batch: The number of release batches.

  • releaseType: The processing method for the batches. Valid values: auto and manual.

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

• grayUpdate: The number of instances for the canary release. This parameter is required when type is set to GrayBatchUpdate.

The configuration for collecting logs to SLS.

• Use SLS resources that are automatically created by SAE: [{"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":""}].

The following table describes the parameters:

• projectName: The name of the SLS project.

• logDir: The log path.

• logType: The log type. stdout indicates the standard output log of the container. You can specify only one standard output log. If you do not set this parameter, file logs are collected.

• logstoreName: The name of the Logstore in SLS.

• logtailName: The name of the Logtail configuration in SLS. If you do not specify this parameter, a new Logtail configuration is created.

If the SLS log collection configuration remains unchanged during a new deployment, you do not need to set this parameter. If you no longer need to use the SLS log collection feature, set this parameter to an empty string ("").

The time zone. The default value is Asia/Shanghai.

We recommend that you do not configure this parameter. We recommend that you configure NasConfigs. The ID of the NAS file system. If the configuration remains unchanged during a new deployment, you do not need to set this parameter. If you want to clear the NAS configuration, set this parameter to an empty string ("").

We recommend that you do not configure this parameter. We recommend that you configure NasConfigs. The mount target of the NAS file system in the VPC where the application is deployed. If the configuration remains unchanged during a new deployment, you do not need to set this parameter. If you want to clear the NAS configuration, set this parameter to an empty string ("").

We recommend that you do not configure this parameter. We recommend that you configure NasConfigs. The description of the NAS mount. If the configuration remains unchanged during a new deployment, you do not need to set this parameter. If you want to clear the NAS configuration, set this parameter to an empty string ("").

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

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

The description of the release order.

The startup command for the application that is deployed using a WAR package. The procedure is the same as the procedure for configuring the startup command for an image-based deployment. For more information, see Set a startup command.

Specifies whether to automatically enable the Auto Scaling policy for the application. Valid values:

• true: Enable.

• false: Disable.

The description of the ConfigMap that is mounted. Use the configuration items created on the Configurations page of a namespace to inject configurations into the container. The following table describes the parameters:

• configMapId: The ID of the ConfigMap instance. You can call the ListNamespacedConfigMaps operation to obtain the ID.

• key: The key.

• mountPath: The mount path.

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

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

• true: Enable AHAS.

• false: Do not enable AHAS.

The mount path of the Application Real-Time Monitoring Service (ARMS) agent for a PHP application. You must make sure that the PHP server loads the configuration file from this path. SAE automatically renders the correct configuration file. You do not need to pay attention to the content of the file.

The mount path of the startup configuration file for a PHP application. You must make sure that the PHP server uses this configuration file to start.

The content of the PHP configuration file.

The Tomcat file configuration. Set this parameter to "" or "{}" to delete the configuration. The following table describes the parameters:

• port: The port number. Valid values: 1024 to 65535. A port number smaller than 1024 can be used only by a root user. Because the container is configured with the admin permissions, enter a port number greater than 1024. If you do not configure this parameter, the default port 8080 is used.

• contextPath: The request path. The default value is the root directory (/).

• maxThreads: The maximum number of connections in the connection pool. Default value: 400.

• uriEncoding: The encoding format for Tomcat. Valid values: UTF-8, ISO-8859-1, GBK, and GB2312. If you do not set this parameter, the default value ISO-8859-1 is used.

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

The description of the OSS bucket that is mounted. The following table describes the parameters:

• bucketName: The name of the bucket.

• bucketPath: The directory or object that you created in OSS. An exception is triggered if the mount directory does not exist.

• mountPath: The container path in SAE. If the path exists, the new path overwrites the existing path. If the path does not exist, a new path is created.

• readOnly: Specifies whether the container has read-only permissions on the resources in the mount directory. Valid values:

  • true: Read-only permission.

  • false: Read and write permission.

The AccessKey ID that is used to read data from and write data to the OSS bucket.

The AccessKey secret that is used to read data from and write data to the OSS bucket.

Specifies whether to enable the canary release rule. This rule applies only to applications that use the Spring Cloud and Dubbo frameworks. Valid values:

• true: Enable the canary release rule.

• false: Disable the canary release rule.

The version of PHP on which the PHP deployment package depends. This parameter is not supported for image-based deployments.

The ID of the ACR Enterprise Edition instance. This parameter is required if ImageUrl is set to the URL of an image in an ACR Enterprise Edition instance.

The Alibaba Cloud Resource Name (ARN) of the RAM role that is required to pull images across accounts. For more information, see Grant permissions to a RAM role to implement cross-account authorization.

The ID of the secret.

Specifies whether to bind an EIP. Valid values:

• true: Bind.

• false: Do not bind.

The configurations for collecting logs to Kafka. The following table describes the parameters:

• kafkaEndpoint: The endpoint of the Kafka API.

• kafkaInstanceId: The ID of the Kafka instance.

• kafkaConfigs: The configurations for one or more logs. For more information about the sample value and parameters, see the kafkaConfigs request parameter in this topic.

Enables service registration and discovery for a K8s service. The following table describes the parameters:

• portProtocols: The port and protocol. The port number must be in the range of [1,65535]. The supported protocols are TCP and UDP.

• portAndProtocol: The port and protocol. The port number must be in the range of [1,65535]. The supported protocols are TCP and UDP. We recommend that you use portProtocols. If you set portProtocols, only portProtocols takes effect.

• enable: Enables service registration and discovery for a K8s service.

Configures service registration and discovery and end-to-end canary release based on a K8s service:

• enable: Specifies whether to enable end-to-end canary release based on a K8s service.

  • true: Enable.

  • false: Disable.

• namespaceId: The namespace ID.

• portAndProtocol: The listening port and protocol. Format: {"Port:Protocol type":"Container port"}

• portProtocols: The port and protocol of the service.

  • port: The port.

  • protocol: The protocol.

  • targetPort: The container port.

• pvtzDiscoveryName: The name of the service discovery.

• serviceId: The service ID.

• serviceName: The service name.

The Nacos registry. Valid values:

• 0: The built-in Nacos registry of SAE.

• 1: A user-created Nacos registry.

• 2: MSE Nacos Enterprise Edition.

The configuration of the registry. This parameter is valid only when the registry type is MSE Nacos Enterprise Edition.

The configurations for mounting a NAS file system. The following table describes the parameters:

• mountPath: The container mount path.

• readOnly: If you set this parameter to false, the container has read and write permissions.

• nasId: The NAS ID.

• mountDomain: The mount target address of the container. For more information, see DescribeMountTargets.

• nasPath: The relative path to the NAS file directory.

The Python environment. PYTHON 3.9.15 is supported.

The dependencies of a custom module. By default, the dependencies defined in the requirements.txt file in the root directory are installed. If no configuration is provided or a custom software package is used, you can specify the dependencies to be installed.

The version number of the .NET framework:

• .NET 3.1

• .NET 5.0

• .NET 6.0

• .NET 7.0

• .NET 8.0

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

• true: This is the default value. The new deployment configuration immediately takes effect, and the instances are immediately started.

• false: Only the new deployment configuration takes effect. The application instances are not started.

The type of the application package. Valid values:

• If you select Java for deployment, FatJar, War, and Image are supported.

• If you select PHP for deployment, 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

• If you select Python for deployment, PythonZip and Image are supported.

The CPU required for each instance. Unit: millicores. This parameter cannot be set to 0. The following 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 size must correspond to the CPU specification. The following specifications are supported:

• 1024: corresponds to 500 millicores and 1,000 millicores.

• 2048: corresponds to 500, 1,000, and 2,000 millicores.

• 4096: corresponds to 1,000, 2,000, and 4,000 millicores.

• 8192: corresponds to 2,000, 4,000, and 8,000 millicores.

• 12288: corresponds to 12,000 millicores.

• 16384: corresponds to 4,000, 8,000, and 16,000 millicores.

• 24576: corresponds to 12,000 millicores.

• 32768: corresponds to 16,000 millicores.

• 65536: corresponds to 8,000, 16,000, and 32,000 millicores.

• 131072: corresponds to 32,000 millicores.

The number of instances.

The ID of the security group.

The vSwitch to which the ENI of the application instance is connected. The vSwitch must be located in the preceding VPC.

The canary release tags of the application configuration.

Specifies whether to enable the new ARMS feature:

• true: Enable.

• false: Do not enable.

Specifies whether to enable the CPU burst feature:

• true: Enable.

• false: Do not enable.

The RAM role of the identity authentication service.

The description of the Secret that is mounted. Use the secrets created on the Secrets page of a namespace to inject confidential information into the container. The following table describes the parameters:

• secretId: The ID of the secret instance. You can call the ListSecrets operation to obtain the ID.

• key: The key.

• mountPath: The mount path.

Specifies whether to enable resource isolation for the sidecar container:

• true: Isolate.

• false: Do not isolate.

The type of the custom image. If you do not use a custom image, set this parameter to an empty string.

• internet: an image on the Internet.

• intranet: an image in a private network.

Configures the microservice governance feature.

• Specifies whether to enable microservice governance (enable):

  • true: Enable.

  • false: Do not enable.

• Configures graceful start and shutdown (mseLosslessRule):

  • delayTime: The delay time.

  • enable: Specifies whether to enable the graceful start feature. true indicates that the feature is enabled. false indicates that the feature is not enabled.

  • notice: Specifies whether to enable the notification feature. true indicates that the feature is enabled. false indicates that the feature is not enabled.

  • warmupTime: The duration of traffic prefetching. Unit: seconds.

The application version:

• lite: Lightweight Edition

• std: Standard Edition

• pro: Professional Edition

Enables the startup probe for the application.

• If the check is successful, the application is considered to have started successfully. If you have configured Liveness and Readiness checks, they will be performed after the application starts successfully.

• If the check fails, the application is considered to have failed to start. An exception is reported and the application is automatically restarted.

Specifies whether to enable custom metric collection for Prometheus.

The Nginx version.

• nginx 1.20

• nginx 1.22

• nginx 1.24

• nginx 1.26

• nginx 1.28

The configuration of the shared temporary storage.

The configuration of the ALB Ingress ReadinessGate.

The maximum number of peak instances. Valid values:

If the minimum number of surviving instances is 100%, the maximum number of peak instances cannot be set to 0. If you set this parameter to -1, the system recommended value of 30% is used. The value is 30% of the total number of instances. If the total number of instances is 10, the value is 10 × 30% = 3.

The ratio of the maximum number of peak instances. Valid values:

If the minimum number of surviving instances is 100%, the maximum number of peak instances cannot be set to 0. If you set this parameter to -1, the system recommended value of 30% is used. The value is 30% of the total number of instances. If the total number of instances is 10, the value is 10 × 30% = 3.

The version of AliyunAgent.

Specifies whether to reuse the agent version configuration of the namespace.

The SLS log tags.