Serverless App Engine:CreateApplication

The application name. It can contain digits, letters, and hyphens (-). It must start with a letter and cannot end with a hyphen (-). The name cannot exceed 36 characters.

The SAE namespace ID. Only namespaces with names that consist of lowercase letters and hyphens (-) are supported. The name must start with a letter. You can get the namespace by calling the DescribeNamespaceList API.

The application description. It cannot exceed 1,024 characters.

The VPC associated with the SAE namespace. In SAE, one namespace can only be associated with one VPC, and this association cannot be changed. The binding relationship is established when you create the first SAE application in the namespace. Multiple namespaces can be associated with the same VPC. If you leave this field empty, the default VPC ID bound to the namespace is used.

The virtual switch where the application instance's Elastic Network Interface (ENI) resides. This vSwitch must be in the VPC specified above. It has a binding relationship with the SAE namespace. If you leave this field empty, the default vSwitch ID bound to the namespace is used.

The application package type. Valid values:

• If you deploy using Java, valid values are FatJar, War, and Image.

• If you deploy using PHP, valid values include the following:

  • 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 deploy using Python, valid values are PythonZip and Image.

• If you deploy using .NET Core, valid values are DotnetZip and Image.

  Note

  When you select DotnetZip, .NET refers to the .NET Core runtime version. Supported versions include .NET 3.1, .NET 5.0, .NET 6.0, .NET 7.0, and .NET 8.0. When you choose DotnetZip, the Dotnet, Command, and CommandArgs parameters are required.

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

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

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

The JDK version on which the deployment package depends. Supported versions:

• 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 WebContainer deployment package depends. Supported versions:

• apache-tomcat-7.0.91

• apache-tomcat-8.5.42

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

The CPU required for each instance, in milli-cores. The value cannot be 0. Only the following fixed specifications are supported:

• 500

• 1000

• 2000

• 4000

• 8000

• 16000

• 32000

The memory required for each instance, in MB. The value cannot be 0. Memory and CPU have a one-to-one mapping. Only the following fixed specifications are supported:

• 1024: corresponds to 500 or 1000 milli-cores of CPU.

• 2048: corresponds to 500, 1000, or 2000 milli-cores of CPU.

• 4096: corresponds to 1000, 2000, or 4000 milli-cores of CPU.

• 8192: corresponds to 2000, 4000, or 8000 milli-cores of CPU.

• 12288: corresponds to 12000 milli-cores of CPU.

• 16384: corresponds to 4000, 8000, or 16000 milli-cores of CPU.

• 24576: corresponds to 12000 milli-cores of CPU.

• 32768: corresponds to 16000 milli-cores of CPU.

• 65536: corresponds to 8000, 16000, or 32000 milli-cores of CPU.

• 131072: corresponds to 32000 milli-cores of CPU.

The initial number of instances.

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

command:
      - echo
      - abc
      - >
      - file0

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

The arguments for the image startup command. These are the arguments required by the Command parameter. Format:

["a","b"]

In the preceding example, CommandArgs=["abc", ">", "file0"]. The value ["abc", ">", "file0"] must be converted to a string in JSON array format. If no arguments are required, leave this field empty.

Container environment variables. You can define custom variables or reference configuration items. To reference a configuration item, create a ConfigMap instance first. For more information, see CreateConfigMap. Valid values:

• Custom configuration

  • name: the environment variable name.

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

• Reference a configuration item (valueFrom)

  • name: the environment variable name. You can reference a single key or all keys. To reference all keys, enter sae-sys-configmap-all-<configuration item name>, for example, sae-sys-configmap-all-test1.

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

    • configMapId: the configuration item ID.

    • key: the key. If you reference all key-value pairs, leave this field empty.

Custom host mapping in the container. Valid values:

• hostName: the domain name or hostname.

• ip: the IP address.

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

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

Container health check. Containers that fail the health check are shut down and recovered. Supported methods:

• 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}

Parameters:

• exec.command: the health check command.

• httpGet.path: the access path.

• httpGet.scheme: HTTP or HTTPS.

• httpGet.isContainKeyWord: true means the response contains the keyword. false means it does not. If this field is missing, advanced features are not used.

• httpGet.keyWord: the custom keyword. You must specify isContainKeyWord when using this field.

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

• initialDelaySeconds: the delay before the first health check, in seconds. Default is 10.

• periodSeconds: the health check interval, in seconds. Default is 30.

• timeoutSeconds: the timeout for health checks, in seconds. Default is 1. If you set this to 0 or omit it, the default timeout is 1 second.

Application startup status check. Containers that repeatedly fail the readiness check are shut down and restarted. Containers that fail the readiness check receive no SLB traffic. Supported methods: exec, httpGet, and tcpSocket. For examples, see the Liveness parameter.

Whether to deploy immediately. Valid values:

• true: deploy immediately. This is the default value.

• false: deploy later.

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

The time zone. Default is Asia/Shanghai.

The configuration for collecting logs to SLS.

• Use SLS resources 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":""}].

Parameters:

• projectName: the project name in SLS.

• logDir: the log path.

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

• logstoreName: the Logstore name in SLS.

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

If the SLS collection configuration does not change during redeployment, you do not need to set this parameter (that is, exclude the SlsConfigs field from the request). If you no longer need SLS collection, set this field to an empty string in the request (that is, set SlsConfigs to "").

We do not recommend configuring this field. We recommend using NasConfigs. The ID of the NAS to mount. It must be in the same region as the cluster. It must have available mount target quotas, or its mount targets must already exist on the vSwitches in the VPC. If you leave this field empty and the mountDescs field exists, a NAS is automatically purchased and mounted to a vSwitch in the VPC.

If the configuration does not change during deployment, you do not need to set this parameter (that is, exclude the NASId field from the request). If you want to clear the NAS configuration, set this field to an empty string in the request (that is, set NASId to "").

We do not recommend configuring this field. We recommend using NasConfigs. The mount target of the NAS in the application VPC. If the configuration does not change during deployment, you do not need to set this parameter (that is, exclude the MountHost field from the request). If you want to clear the NAS configuration, set this field to an empty string in the request (that is, set MountHost to "").

We do not recommend configuring this field. We recommend using NasConfigs. The NAS mount description. If the configuration does not change during deployment, you do not need to set this parameter (that is, exclude the MountDesc field from the request). If you want to clear the NAS configuration, set this field to an empty string in the request (that is, set MountDesc to "").

The script to run before the container stops. This script runs before the container is deleted. Format: {"exec":{"command":["cat","/etc/group"]}}

The script to run after the container starts. This script runs immediately after the container is created. Format: {"exec":{"command":["cat","/etc/group"]}}

The startup command for WAR package deployment. The configuration steps are the same as those for image deployment. For more information, see Set startup commands.

The ConfigMap mount description. Use configuration items created on the namespace configuration page to inject configuration information into containers. Parameters:

• configMapId: the ConfigMap instance ID. You can get it by calling the ListNamespacedConfigMaps API.

• key: the key.

• mountPath: the mount path.

The security group ID.

Whether to automatically configure the network environment. Valid values:

• true: SAE automatically configures the network environment when creating the application. The values of NamespaceId, VpcId, vSwitchId, and SecurityGroupId are ignored.

• false: manually configure the network environment when creating the application.

The graceful shutdown timeout, in seconds. Default is 30. Valid values: 1 to 300.

The mount path for PHP application monitoring. Ensure that the PHP server loads the configuration file at this path. You do not need to manage the configuration content. SAE automatically renders the correct configuration file.

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

The PHP configuration file content.

Tomcat file configuration. Set this to "" or "{}" to delete the configuration:

• port: the port. Valid values: 1024 to 65535. Ports below 1024 require root permissions. Because containers run with admin permissions, use ports above 1024. If you do not configure this, the default port is 8080.

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

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

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

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

OSS mount description. Parameters:

• bucketName: the bucket name.

• bucketPath: the directory or OSS object you created in OSS. If the OSS mount directory does not exist, an exception occurs.

• mountPath: the container path in SAE. If the path exists, it is overwritten. If it does not exist, it is created.

• readOnly: whether the container path has read-only access to the mounted directory. 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.

The PHP version on which the PHP deployment package depends. This parameter is not supported for images.

The Container Registry (ACR) Enterprise Edition instance ID. This parameter is required when ImageUrl points to an ACR Enterprise Edition image.

The ARN of the RAM role required for cross-account image pulling. For more information, see Authorize cross-cloud account access using RAM roles.

The secret ID.

Whether to bind an EIP. Valid values:

• true: bind.

• false: do not bind.

The programming language of the application. Valid values:

• java: Java.

• php: PHP.

• python: Python.

• dotnet: .NET Core.

• other: multiple languages, such as C++, Go, and Node.js.

The aggregated configuration for collecting logs to Kafka. Valid values:

• kafkaEndpoint: the service endpoint for the Kafka API.

• kafkaInstanceId: the Kafka instance ID.

• kafkaConfigs: the aggregated configuration for one or more logs. For details, see the kafkaConfigs request parameter in this topic.

Enable K8s Service registration and discovery. Valid values:

• serviceName: the service name. Format: custom-namespace ID. The suffix -namespace ID cannot be customized and must match the namespace of the application. For example, if you select the default namespace in the China (Beijing) region, the suffix is -cn-beijing-default.

• namespaceId: the namespace ID.

• portProtocols: the port and protocol. Port range: [1,65535]. Supported protocols: TCP and UDP.

• portAndProtocol: the port and protocol. Port range: [1,65535]. Supported protocols: TCP and UDP. We recommend using portProtocols. If you set portProtocols, only portProtocols takes effect.

• enable: enable K8s Service registration and discovery.

Select the Nacos registry. Valid values:

• 0: built-in Nacos in SAE.

• 1: self-managed Nacos.

• 2: commercial Nacos in MSE.

Registry configuration.

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 target address. For more information, see DescribeMountTargets.

• nasPath: the relative NAS file directory.

The Python environment. Supports PYTHON 3.9.15.

Custom module dependencies. By default, dependencies defined in requirements.txt in the root directory are installed. If you do not configure this or custom packages, you can specify dependencies to install.

The .NET framework version:

• .NET 3.1

• .NET 5.0

• .NET 6.0

• .NET 7.0

• .NET 8.0

Enable application monitoring for non-Java applications based on eBPF technology. Valid values:

• true: enable.

• false: disable. This is the default value.

The SAE version. Supported versions:

• v1

• v2

Set this to micro_service to create a microservice application.

The base application ID.

The grayscale tags configured for the application.

Whether to enable the new ARMS feature:

• true: enable

• false: disable

Whether to enable the CPU Burst feature:

• true: enable

• false: disable

Set the RAM role for identity authentication.

Secret mount description. Use secrets created on the namespace secret page to inject confidential information into containers. Parameters:

• secretId: the secret instance ID. You can get it by calling the ListSecrets API.

• key: the key.

• mountPath: the mount path.

Whether to enable Sidecar resource isolation:

• true: isolate

• false: do not isolate

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

• internet: public network image

• intranet: private network image

The resource type. Supported types: NULL (default), default (default), and haiguang (Hygon server).

The application edition:

• lite: Lite Edition

• std: Standard Edition

• pro: Professional Edition

Configure microservice governance.

• Enable microservice governance (enable):

  • true: enable

  • false: disable

• Configure graceful start and shutdown (mseLosslessRule):

  • delayTime: delay time

  • enable: whether to enable graceful start. true means enabled, false means disabled.

  • notice: whether to enable notifications. true means enabled, false means disabled.

  • warmupTime: warm-up duration for small traffic, in seconds.

Disk storage size, in GB.

Enable application startup probe.

• Success: the application started successfully. If you configure Liveness and Readiness checks, they run after the application starts.

• Failure: the application failed to start. An exception is reported and the application restarts automatically.

Whether the application is stateful.

Whether to enable Prometheus custom metric collection.

K8s Headless Service registration and discovery

• serviceName: the service name

• namespaceId: the namespace ID

Nginx version

• nginx 1.20

• nginx 1.22

• nginx 1.24

• nginx 1.26

• nginx 1.28

Shared temporary storage configuration.

AliyunAgent version

Whether to reuse the namespace Agent version configuration.

Whether to reuse the namespace SLS log configuration.

sls log tags