Serverless App Engine:CreateApplication

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

SAE namespace ID. Only namespaces consisting of lowercase letters and hyphens (-) are supported, and the name must start with a letter.

The description of the template. The description cannot exceed 1,024 characters in length.

The ID of the virtual private cloud (VPC) that corresponds to the SAE namespace. In SAE, once correspondence is configured between a namespace and a VPC, the namespace cannot correspond to other VPCs. When the SAE application is created within the namespace, the application is bound with the VPC. Multiple namespaces can correspond to the same VPC. The default value is the ID of the VPC that is bound to the namespace.

The vSwitch to which the elastic network interface (ENI) of the application instance is connected. The vSwitch must be located in the VPC specified by the VpcId parameter. The SAE namespace is bound with this vSwitch. The default value is the ID of the vSwitch that is bound to the namespace.

The type of the deployment package. Take note of the following rules:

• If you deploy the application by using a Java Archive (JAR) package, you can set this parameter to FatJar, War, or Image.
• If you deploy the application by using a PHP package, you can set this parameter to one of the following values:

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 the application by using a Python package, you can set this parameter to PythonZip or Image:

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

The address of the deployment package. This parameter is required if you set PackageType to FatJar, War, or PythonZip.

The URL of the image. This parameter is required if you set the PackageType parameter to Image.

The version of the Java development kit (JDK) on which the deployment package of the application 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 returned if the PackageType parameter is set to Image.

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

• apache-tomcat-7.0.91
• apache-tomcat-8.5.42

This parameter is not returned if the PackageType parameter is set to Image.

The CPU specifications that are required for each instance. Unit: millicores. This parameter cannot be set to 0. Valid values:

• 500
• 1000
• 2000
• 4000
• 8000
• 12000
• 16000
• 32000

The memory size that is required by each instance. Unit: MB. This parameter cannot be set to 0. The values of this parameter correspond to the values of the Cpu parameter:

• This parameter is set to 1024 if the Cpu parameter is set to 500 or 1000.
• This parameter is set to 2048 if the Cpu parameter is set to 500, 1000, or 2000.
• This parameter is set to 4096 if the Cpu parameter is set to 1000, 2000, or 4000.
• This parameter is set to 8192 if the Cpu parameter is set to 2000, 4000, or 8,000.
• This parameter is set to 12288 if the Cpu parameter is set to 12000.
• This parameter is set to 16384 if the Cpu parameter is set to 4000, 8000, or 16000.
• This parameter is set to 24576 if the Cpu parameter is set to 12000.
• This parameter is set to 32768 if the Cpu parameter is set to 16000.
• This parameter is set to 65536 if the Cpu parameter is set to 8000, 16000, or 32000.
• This parameter is set to 131072 if the Cpu parameter is set to 32000.

The number of instances when initialized.

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

command:
      - echo
      - abc
      - >
      - file0

In this example, the Command parameter is set to Command="echo", CommandArgs=["abc", ">", "file0"].

The parameters of the image startup command. The CommandArgs parameter specifies the parameters that are required for the Command parameter. You can specify the name in one of the following formats:

["a","b"]

In the preceding example, the CommandArgs parameter is set to CommandArgs=["abc", ">", "file0"]. The data type of ["abc", ">", "file0"] must be an array of strings in the JSON format. This parameter is optional.

The environment variables. You can configure custom environment variables or reference a ConfigMap. Before you can reference a ConfigMap, you must create a ConfigMap. For more information, see CreateConfigMap . Valid values:

• Custom configuration

  • name: the name of the environment variable.
  • value: the value of the environment variable. The priority of the custom configuration is higher than valueFrom.

• Reference a ConfigMap (valueFrom)

  • name: the name of the environment variable. You can reference one or all keys. To reference all keys, specify sae-sys-configmap-all-<ConfigMap name>. Example: sae-sys-configmap-all-test1.
  • valueFrom: the reference of the environment variable. Valid value: configMapRef.
  • configMapId: the ID of the ConfigMap.
  • key: the key. If you want to reference all key values, you do not need to configure this parameter.

The custom mappings between hostnames and IP addresses in the container. Take note of the following rules:

• hostName: the domain name or hostname.
• ip: the IP address.

The option settings in the JAR package. The settings are used to start the application container. The default startup command for application deployment is $JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs.

The arguments in the JAR package. The arguments are used to start the application container. The default startup command is $JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs.

Container health check. If the container fails this check, it will be revoked and relaunch again. Use one of the following methods to perform the health check:

• Example of exec: {"exec":{"command":\["sh","-c","cat/home/admin/start.sh"]},"initialDelaySeconds":30,"periodSeconds":30,"timeoutSeconds":2}
• Sample code of the httpGet method: {"httpGet":{"path":"/","port":18091,"scheme":"HTTP","isContainKeyWord":true,"keyWord":"SAE"},"initialDelaySeconds":11,"periodSeconds":10,"timeoutSeconds":1}
• Sample code of the tcpSocket method: {"tcpSocket":{"port":18091},"initialDelaySeconds":11,"periodSeconds":10,"timeoutSeconds":1}

The following table describes the parameters that are used in the preceding statements.

• exec.command: the health check command.
• httpGet.path: the request path.
• httpGet.scheme: the protocol that is used to perform the health check. Valid values: HTTP and HTTPS.
• httpGet.isContainKeyWord: indicates whether the response contains keywords. Valid values: true and false. If this field is not returned, the advanced settings are not used.
• httpGet.keyWord: the custom keyword. This parameter is available only if the isContainKeyWord field is returned.
• tcpSocket.port: the port that is used to check the status of TCP connections.
• initialDelaySeconds: the delay of the health check. Default value: 10. Unit: seconds.
• periodSeconds: the interval at which health checks are performed. Default value: 30. Unit: seconds.
• timeoutSeconds: the timeout period of the health check. Default value: 1. Unit: seconds. If you set this parameter to 0 or leave this parameter empty, the timeout period is automatically set to 1 second.

Check the launch status of the container. Containers that fail health checks more than once will not receive traffic from Server Load Balancer (SLB) instances any loner. You can use the exec, httpGet, or tcpSocket method to perform health checks. For more information, see the description of the Liveness parameter.

Whether to deploy now.

• true (default): Deploy now.
• false: Deploy later.

The version of the container in HSF.

Time zone. Default to time zone of Asia/Shanghai.

The logging configurations of Log Service.

• To use Log Service resources that are automatically created by SAE, set this parameter to [{"logDir":"","logType":"stdout"},{"logDir":"/tmp/a.log"}].
• To use custom Log Service resources, set this parameter to [{"projectName":"test-sls","logType":"stdout","logDir":"","logstoreName":"sae","logtailName":""},{"projectName":"test","logDir":"/tmp/a.log","logstoreName":"sae","logtailName":""}].

The following table describes the parameters that are used in the preceding statements.

• projectName: the name of the Log Service project.
• logDir: the path in which logs are stored.
• logType: the log type. stdout: the standard output log of the container. You can specify only one stdout value for this parameter. If you leave this parameter empty, file logs are collected.
• logstoreName: the name of the Logstore in Log Service.
• logtailName: the name of the Logtail configuration in Log Service. If you do not configure this parameter, a new Logtail configuration is created.

If you do not need to modify the logging configurations when you deploy the application, configure the SlsConfigs parameter only in the first request. You do not need to include this parameter in subsequent requests. If you no longer need to use Log Service, leave the SlsConfigs parameter empty in the request.

It is not recommended to configure this field; configuring NasConfigs instead. The ID of the mounted NAS must be in the same region as the cluster. The NAS must have available mount point quota or its mount point must already be on a switch within the VPC. If this field is not specified and the mountDescs field exists, a NAS will be automatically purchased and mounted to a switch within the VPC by default.

When deploying, if the configuration has not changed, you do not need to set this parameter (i.e., the NASId field does not need to be included in the request). If you need to clear the NAS configuration, set the value of this field to an empty string in the request (i.e., set the value of the NASId field to "").

It is not recommended to configure this field; configuring NasConfigs instead. This field specifies the NAS mount point within the application's VPC. When deploying, if the configuration has not changed, you do not need to set this parameter (i.e., the MountHost field does not need to be included in the request). If you need to clear the NAS configuration, set the value of this field to an empty string in the request (i.e., set the value of the MountHost field to "").

It is not recommended to configure this field; configuring NasConfigs instead. This field specifies the NAS mount description. When deploying, if the configuration has not changed, you do not need to set this parameter (i.e., the MountDesc field does not need to be included in the request). If you need to clear the NAS configuration, set the value of this field to an empty string in the request (i.e., set the value of the MountDesc field to "").

To controle whether to run a script before the container stops. Example: {"exec":{"command":["cat","/etc/group"]}}

Control whether to run a script after the container is initialized. Example: {"exec":{"command":["cat","/etc/group"]}}

The startup command of the WAR package. For information about how to configure the startup command, see Configure startup commands.

The description of the ConfigMap instance mounted to the application. Use configurations created on the Configuration Items page to configure containers. The following table describes the parameters that are used in the preceding statements.

• congfigMapId: the ID of the ConfigMap instance. You can call the ListNamespacedConfigMaps operation to obtain the ID.
• key: the key.

• mountPath: the mount path in the container.

Security group ID.

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

• true: SAE automatically configures the network environment when you create the application. If you set this parameter to true, the values of the NamespaceId, VpcId, vSwitchId, and SecurityGroupId parameters are ignored.
• false: SAE configures the network environment based on your settings when you create the application.

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

The path on which the PHP configuration file for application monitoring is mounted. Make sure that the PHP server loads the configuration file. SAE automatically generates the corresponding configuration file. No manual operations are required.

The path on which the PHP configuration file for application startup is mounted. Make sure that the PHP server uses this configuration file during the startup.

The details of the PHP configuration file.

The Tomcat configuration. If you want to cancel this configuration, set this parameter to "" or "{}". The following variables are included in the configuration: Take note of the following rules:

• port: the port number. The port number ranges from 1024 to 65535. Though the admin permissions are configured for the container, the root permissions are required to perform operations on ports whose number is smaller than 1024. Enter a value that ranges from 1025 to 65535 because the container has only the admin permissions. If you do not specify this parameter, the default port number 8080 is used.
• contextPath: the path. Default value: /. This value indicates the root directory.
• maxThreads: the maximum number of connections in the connection pool. Default value: 400.
• uriEncoding: the URI encoding scheme in the Tomcat container. Valid values: UTF-8, ISO-8859-1, GBK, and GB2312.************ If you do not specify this parameter, the default value ISO-8859-1 is used.
• useBodyEncoding: specifies whether to use the encoding scheme specified in the request body for URI query parameters. Default value: true.

Information of the Object Storage Service (OSS) bucket mounted to the application. The following table describes the parameters that are used in the preceding statements.

• bucketName: the name of the OSS bucket.

• bucketPath: the directory or object in OSS. If the specified directory or object does not exist, an error is returned.

• mountPath: the directory of the container in SAE. If the path already exists, the newly specified path overwrites the previous one. If the path does not exist, it is created.

• readOnly: specifies whether to only allow the container path to read data from the OSS directory. Valid values:

  • true: The container path only has read permission on the OSS directory.
  • false: The application has read and write permissions.

The Accesskey ID that the OSS reads and writes from.

The AccessKey Secret that the OSS reads and writes from.

The dependent PHP version of PHP package. Image is not supported.

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

The Alibaba Cloud Resource Name (ARN) required for a RAM role to obtain images across accounts. For more information, see Grant permissions across Alibaba Cloud accounts by using a RAM role.

The ID of the corresponding Secret.

Specifies whether to associate an EIP with the node pool. Take note of the following rules:

• true: The EIP is associated with the application instance.
• false: The EIP is not associated with the application instance.

The programming language for the application’s technology stack. The value options are as follows:

• java: Java language
• php: PHP language
• python: Python language
• dotnet: .NET Core language
• other: Multi-language, such as C++, Go, Node.js, etc.

The logging configurations of Message Queue for Apache Kafka. Take note of the following rules:

• kafkaEndpoint: the endpoint of the Message Queue for Apache Kafka API.
• kafkaInstanceId: the ID of the Message Queue for Apache Kafka instance.
• kafkaConfigs: One or more logging configurations of Message Queue for Apache Kafka. For information about sample values and parameters, see the request parameter KafkaLogfileConfig in this topic.

The configurations of Kubernetes Service-based service registration and discovery. Take note of the following rules:

• serviceName: the name of the Alibaba Cloud service. Format: <Custom content>-<Namespace ID>. -<Namespace ID> is automatically specified based on the namespace in which an application resides and cannot be changed. For example, if you select the default namespace in the China (Beijing) region, -cn-beijing-default is automatically specified.
• namespaceId: the namespace ID.
• portAndProtocol: the port number and protocol. Valid values of the port number: 1 to 65535. Valid values of the protocol: TCP and UDP.
• enable: enables the Kubernetes Service-based registration and discovery feature.

The Nacos registry. Valid values:

• 0: SAE built-in Nacos registry
• 1: self-managed Nacos registry
• 2 : MSE enterprise edition Nacos registry

The Registry configurations.

The configurations of mounting the NAS file system. Take note of the following rules:

• mountPath: the mount path of the container.
• readOnly: If you set the value to false, the application has the read and write permissions.
• nasId: the ID of the NAS file system.
• mountDomain: the domain name of the mount target. For more information, see DescribeMountTargets .
• nasPath: the directory in the NAS file system.

The Python environment. Set the value to PYTHON 3.9.15.

The configurations for installing custom module dependencies. By default, the dependencies defined by the requirements.txt file in the root directory are installed. If the package does not contain this file and you do not configure custom dependencies in the package, specify the dependencies that you want to install in the text box.

. NET Framework version number:

• .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. The value options are as follows:

• true: Enable.
• false: Disable (default).

The SAE version. Supported versions:

• v1
• v2

Select micro_service, which is the application.

The ID of the basic application.

The canary tag configured for the application.

Indicates whether to enable the new ARMS feature:

• true: enables this parameter.
• false: disables this parameter.

Enable CPU Burst.

• true: enable
• false: disable

The name of the RAM role used to authenticate the user identity.

The configuration of the container.

Secret Mount Description Use the secret dictionaries created in the Namespace Secret Dictionary page to inject information into containers. Parameter descriptions are as follows:

• secretId: Secret instance ID. Obtain via the ListSecrets interface.

• key: Key-value pair. Note: Set the parameter sae-sys-secret-all to mount all keys.

• mountPath: Mount path.

Enable Sidecar resource isolation.

• true: enable
• false: disable

Custom image type. To it to empty string to use pre-built image.

• internet: Public network image

• intranet: Private network image

The resource type. Supports NULL (default) and haiguang (haiguang server).

SAE edition.

• lite: the lightweight edition.

• std: the standard edition.

• pro: the professional edition.

Configure microservices governance

Whether to enable microservices governance (enable):

• true: Enable
• false: Disable

Configure lossless online/offline deployment (mseLosslessRule):

delayTime: Delay duration (unit: seconds)

enable: Whether to enable lossless deployment

• true: Enable

• false: Disable

notice: Whether to enable notifications

• true: Enable

• false: Disable

warmupTime: Small-traffic warm-up duration (unit: seconds)

The disk size. Unit: GB.

Initialize container configuration.

Enable application startup probe.

Check succeeded: Indicates that the application has started successfully. If you have configured Liveness and Readiness checks, they will be performed after the application startup is successful. Check failed: Indicates that the application failed to start; an exception will be reported and the application will be automatically restarted.