Serverless App Engine:CreateApplication

The application name. The name can contain digits, letters, and hyphens (-). The name must start with a letter and cannot end with a hyphen (-). The name can be up to 36 characters in length.

The SAE namespace ID. Only namespaces whose names contain lowercase letters and hyphens (-) are supported. The name must start with a letter. You can obtain namespaces by calling the DescribeNamespaceList operation.

The application description. The description can be up to 1024 characters in length.

The VPC that corresponds to the SAE namespace. In SAE, a namespace can correspond to only one VPC, and the mapping cannot be modified. The binding relationship is established when the first SAE application is created in the namespace. Multiple namespaces can correspond to the same VPC. If you leave this parameter empty, the VPC bound to the namespace is used by default.

The vSwitch where the elastic network interface controller (NIC) of the application instance resides. The vSwitch must be in the specified VPC. The vSwitch also has a binding relationship with the SAE namespace. If you leave this parameter empty, the vSwitch attached to the namespace is used by default.

The type of the application deployment package. Valid values:

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

• If you use 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 use Python for deployment, PythonZip and Image are supported.

• If you use .NET Core for deployment, DotnetZip and Image are supported.

  Note

  When DotnetZip is selected, Dotnet specifies the version of the .NET Core runtime. .NET 3.1, .NET 5.0, .NET 6.0, .NET 7.0, and .NET 8.0 are supported. The Dotnet, Command, and CommandArgs parameters are required.

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

The address of the deployment package. 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. 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 version of Tomcat on which the WebContainer 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 CPU specifications required for each instance, in millicores. This parameter cannot be set to 0. Only the following defined specifications are supported:

• 500

• 1000

• 2000

• 4000

• 8000

• 16000

• 32000

The memory required for each instance, in 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 initial number of instances.

The command that is used to start the image. The command must be an executable object in the container. Example:

command:
      - echo
      - abc
      - >
      - file0

In 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 the String type. 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 a ConfigMap. To reference a ConfigMap, 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 (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 environment variable reference. Set the value to configMapRef.

    • configMapId: the ConfigMap ID.

    • key: the key. If you reference all keys, do not set this field.

The custom host mapping in the container. Valid values:

• hostName: the domain name or hostname.

• ip: the IP address.

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

The arguments for starting the JAR package application. The default startup command for the application: $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}

Parameter description:

• exec.command: 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. If this field is missing, the advanced feature is not used.

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

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

• initialDelaySeconds: the health check delay detection time. Default value: 10. Unit: seconds.

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

• timeoutSeconds: 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.

Specifies whether to immediately deploy the application. Valid values:

• true: default value. The application is deployed immediately.

• false: the application is deployed later.

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

The time zone. Default value: Asia/Shanghai.

The configurations for log collection to Simple Log Service.

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

Parameter description:

• projectName: the Project name in Simple Log Service.

• logDir: the log path.

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

• logstoreName: the Logstore name in Simple Log Service.

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

If the SLS collection configuration does not change 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).

We recommend that you do not set this parameter. Set NasConfigs instead. The ID of the mounted NAS file system. The NAS file system must be in the same region as the cluster. The NAS file system must have available mount target creation quota, or its mount target must already be on a vSwitch in the VPC. If this parameter is left empty and the mountDescs field exists, a NAS file system 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, 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 recommend that you do not set this parameter. Set NasConfigs instead. The mount target of the NAS file system in the VPC of the application. If the configuration does not change 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 recommend that you do not set this parameter. Set NasConfigs instead. The NAS mount description. If the configuration does not change 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 before the container is stopped. A script is triggered and run before the container is deleted. Format: {"exec":{"command":\["cat","/etc/group"]}}

The script that is run after the container is started. A script is triggered and run immediately after the container is created. Format: {"exec":{"command":\["cat","/etc/group"]}}

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

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

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

• key: the key.

• mountPath: the mount path.

The security group ID.

Specifies whether to automatically configure the network environment. Valid values:

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

• false: SAE manually configures the network environment when the application is created.

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

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

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

The content of the PHP configuration file.

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

• port: the port number. Valid values: 1024 to 65535. Ports less 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 maximum number of connections in the connection pool. 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 description:

• 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 SAE. 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.

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

The instance ID of the Container Registry Enterprise instance. This parameter is required when ImageUrl is set to a Container Registry Enterprise Edition 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 EIP. Valid values:

• true: associate an EIP.

• false: do not associate an EIP.

The programming language of the technology stack used to create the application. Valid values:

• java: Java.

• php: PHP.

• python: Python.

• dotnet: .NET Core.

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

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

• kafkaEndpoint: the service registration address of the Kafka API.

• kafkaInstanceId: the Kafka instance ID.

• kafkaConfigs: the summary of configurations for one or more log entries. For more information about the valid values, see the kafkaConfigs request parameter in this topic.

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

• serviceName: the service name. Format: custom name-namespace ID. The suffix -namespace ID cannot be customized and must be set based on 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. 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.

Specifies the Nacos registry. Valid values:

• 0: SAE built-in Nacos.

• 1: self-managed Nacos.

• 2: MSE commercial edition Nacos.

The registry configuration.

The NAS mount configuration. Valid values:

• mountPath: the container mount path.

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

• nasId: the NAS ID.

• mountDomain: the container mount target 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 the file is not configured or you need custom packages, 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

Specifies whether to enable application monitoring for non-Java applications based on eBPF technology. Valid values:

• true: enabled.

• false: disabled. This is the default value.

The SAE version. Valid values:

• v1

• v2

Set this parameter to micro_service to create a microservice application.

The base application ID.

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.

Specifies 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. Parameter description:

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

• key: the key.

• mountPath: the mount path.

Specifies whether to enable sidecar resource isolation:

• true: Isolated.

• false: Not isolated.

The custom image type. Set this parameter to an empty string if the image is not a custom image:

• internet: public image

• intranet: private image

The resource type. Valid values: NULL (default), default, and haiguang (Hygon server).

The application version:

• lite: Lite Edition

• std: Standard Edition

• pro: Professional Edition

Configures the microservice governance feature.

• 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. false indicates disabled.

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

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

The disk storage size, in GB.

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 the application is stateful.

Specifies whether to enable Prometheus custom metric collection.

The K8s Headless Service-based service registration and discovery.

• serviceName: the service name.

• namespaceId: the namespace ID.

The Nginx version.

• nginx 1.20

• nginx 1.22

• nginx 1.24

• nginx 1.26

• nginx 1.28

The shared ephemeral storage configuration.

Specifies whether to reuse the namespace agent version configuration.

The AliyunAgent version.

Specifies whether to reuse the namespace SLS log configuration.

sls log tags