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 consisting of lowercase letters and hyphens (-) are supported. The name must start with a letter. Obtain the namespace by calling the DescribeNamespaceList API operation.

The application description. It cannot exceed 1024 characters.

The VPC corresponding to the SAE namespace. In SAE, a namespace can only correspond to one VPC, and you cannot change it. The first time you create an SAE application in a namespace, a binding relationship forms. Multiple namespaces can correspond to one VPC. If you do not specify this parameter, the system uses the VPC ID bound to the namespace by default.

The virtual switch (vSwitch) where the application instance's Elastic Network Interface (ENI) is located. This vSwitch must be within the specified VPC. This vSwitch also has a binding relationship with the SAE namespace. If you do not specify this parameter, the system uses the vSwitch ID bound to the namespace by default.

The application package type. Valid values:

• If you deploy with Java, supported types are FatJar, War, and Image.

• If you deploy with PHP, supported types are:

  • 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 with Python, supported types are PythonZip and Image.

• If you deploy with .NET Core, supported types are DotnetZip and Image.

  Note

  When you select DotnetZip, Dotnet is the version number of the .NET Core environment. Supported versions are .NET 3.1, .NET 5.0, .NET 6.0, .NET 7.0, and .NET 8.0. The Dotnet, Command, and CommandArgs options are required.

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

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

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

The JDK version that the deployment package depends on. 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 Image.

The Tomcat version that the WebContainer deployment package depends on. Supported versions:

• apache-tomcat-7.0.91

• apache-tomcat-8.5.42

This parameter is not supported when Package Type is Image.

The CPU required for each instance, in millicores. It cannot be 0. Currently, only the following defined specifications are supported:

• 500

• 1000

• 2000

• 4000

• 8000

• 16000

• 32000

The memory required for each instance, in MB. It cannot be 0. It has a one-to-one correspondence with CPU. Currently, only the following defined specifications are supported:

• 1024: Corresponds to 500 millicores and 1000 millicores CPU.

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

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

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

• 12288: Corresponds to 12000 millicores CPU.

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

• 24576: Corresponds to 12000 millicores CPU.

• 32768: Corresponds to 16000 millicores CPU.

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

• 131072: Corresponds to 32000 millicores CPU.

The initial number of instances.

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

command:
      - echo
      - abc
      - >
      - file0

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

The image start command parameters. These are the parameters required by the Command parameter. Format:

["a","b"]

In the example, CommandArgs=["abc", ">", "file0"]. Convert ["abc", ">", "file0"] to a string type, with the format as a JSON array. If this parameter is not needed, do not specify it.

Container environment variable parameters. Support custom configurations or referencing 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 has a higher priority than valueFrom.

• Reference 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-values, do not set this field.

Custom Host mapping within the container. Valid values:

• hostName: The domain name or hostname.

• ip: The IP address.

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

JAR package startup parameters for the application. The application's default start 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}

Parameter description:

• exec.command: Set the health check command.

• httpGet.path: The access path.

• httpGet.scheme: HTTP or HTTPS.

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

• httpGet.keyWord: The custom keyword. Do not omit the isContainKeyWord field when using it.

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

• initialDelaySeconds: Set the health check delay detection time. Default is 10 seconds.

• periodSeconds: Set the health check period. Default is 30 seconds.

• timeoutSeconds: Set the health check timeout duration. Default is 1 second. If you set it to 0 or do not set it, the default timeout is 1 second.

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

Whether to deploy immediately. Valid values:

• true: Default value. Deploy immediately.

• false: Deploy later.

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

The time zone. Default is Asia/Shanghai.

The configuration for collecting logs to Simple Log Service (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":""}].

Parameter description:

• projectName: The name of the Project on SLS.

• logDir: The log path.

• logType: The log type. stdout indicates container standard output logs; you can set only one such entry. If you do not set this, the system collects file logs.

• logstoreName: The name of the Logstore on SLS.

• logtailName: The name of the Logtail on SLS. If you do not specify this, the system creates a new Logtail.

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

Do not configure this field; configure NasConfigs instead. The ID of the mounted NAS. It must be in the same region as the cluster. It must have available mount target creation quotas, or its mount target must already be on a vSwitch within the VPC. If you do not specify this parameter and the mountDescs field exists, the system automatically purchases a NAS and mounts it to a vSwitch within the VPC by default.

If the configuration has not changed during deployment, you do not need to set this parameter (that is, the request does not need to include the NASId field). To clear the NAS configuration, set the value of this field to an empty string in the request (that is, the value of the NASId field in the request is "").

Do not configure this field; configure NasConfigs instead. The NAS mount target within the application VPC. If the configuration has not changed during deployment, you do not need to set this parameter (that is, the request does not need to include the MountHost field). To clear the NAS configuration, set the value of this field to an empty string in the request (that is, the value of the MountHost field in the request is "").

Do not 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 request does not need to include the MountDesc field). To clear the NAS configuration, set the value of this field to an empty string in the request (that is, the value of the MountDesc field in the request is "").

The script to execute before the container stops. A script is triggered before the container is deleted. Format: {"exec":{"command":\["cat","/etc/group"]}}

The script to execute after the container starts. A script is triggered immediately after the container is created. Format: {"exec":{"command":\["cat","/etc/group"]}}

Set the startup command for WAR package deployed applications. The procedure is the same as configuring the startup command for image deployments. For more information, see Set the startup command.

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

• configMapId: The ConfigMap instance ID. Obtain it by calling the ListNamespacedConfigMaps API operation.

• key: The key value.

• 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 an application. The values of NamespaceId, VpcId, vSwitchId, and SecurityGroupId are ignored.

• false: SAE manually configures the network environment when creating an application.

The graceful shutdown timeout duration. Default is 30 seconds. Valid values are 1 to 300.

The mount path for PHP application monitoring. Ensure that the PHP server loads the configuration file from this path. You do not need to focus on 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 content of the PHP configuration file.

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

• port: The port range is 1024 to 65535. Ports less than 1024 require root permissions to operate. Because the container is configured with Admin permissions, specify a port greater than 1024. If you do not configure this, the default is 8080.

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

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

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

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

OSS mount description. Parameter description:

• bucketName: The Bucket name.

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

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

• readOnly: Whether the container path has read permission for the mounted directory resource. 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 that the PHP deployment package depends on. Images do not support this.

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

The ARN of the RAM role required to pull images across Alibaba Cloud accounts. For more information, see Authorize cross-account access using a RAM role.

The ID of the corresponding secret.

Whether to bind an Elastic IP address (EIP). Valid values:

• true: Bind.

• false: Do not bind.

The technology stack language for creating the application. Valid values:

• java: Java language.

• php: PHP language.

• python: Python language.

• dotnet: .NET Core language.

• other: Multi-language, such as C++, Go, and Node.js.

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

• kafkaEndpoint: The service registration address for the Kafka API.

• kafkaInstanceId: The Kafka instance ID.

• kafkaConfigs: The summary configuration for single or multiple logs. For valid values, see the kafkaConfigs request parameter in this topic.

Enable K8s Service service discovery. Valid values:

• serviceName: The service name. Format: custom-namespace ID. The suffix -namespace ID cannot be customized; specify it based on the application's namespace. For example, if you select the default namespace in the China (Beijing) region, it is -cn-beijing-default.

• namespaceId: The namespace ID.

• portProtocols: The port and protocol. The port range is [1, 65535]. Supported protocols are TCP and UDP.

• portAndProtocol: The port and protocol. The port range is [1, 65535]. Supported protocols are TCP and UDP. portProtocols is recommended. If portProtocols is set, only portProtocols takes effect.

• enable: Enable K8s Service service discovery.

Select the Nacos registry. Valid values:

• 0: SAE built-in Nacos.

• 1: User-managed Nacos.

• 2: MSE Professional Edition Nacos.

The registry configuration information.

The configuration for mounting NAS. Valid values:

• mountPath: The container mount path.

• readOnly: If the value is false, it indicates read and write permission.

• nasId: The NAS ID.

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

• nasPath: The relative file directory of NAS.

The Python environment. Supports PYTHON 3.9.15.

Custom installation of module dependencies. By default, the system installs dependencies defined in requirements.txt in the root directory. If you do not configure or customize packages, you can specify the dependencies to install.

The version number of the .NET framework:

• .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. Default value.

The SAE version. Supported versions:

• v1

• v2

Select micro_service for a microservice application.

The base application ID.

The grayscale tags for application configuration.

Whether to enable new ARMS features:

• true: Enable.

• false: Do not enable.

Whether to enable the CPU Burst feature:

• true: Enable.

• false: Do not enable.

Set the identity authentication service RAM role.

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

• secretId: The secret instance ID. Obtain it by calling the ListSecrets API operation.

• key: The key value.

• mountPath: The mount path.

Whether to enable Sidecar resource isolation:

• true: Enable isolation.

• false: Do not enable isolation.

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

• internet: Public network image.

• intranet: Private network image.

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

The application version:

• lite: Lightweight Edition

• std: Standard Edition

• pro: Professional Edition

Configure microservice administration features.

• Whether to enable microservice administration (enable):

  • true: Enable.

  • false: Do not enable.

• Configure graceful start and graceful shutdown (mseLosslessRule):

  • delayTime: The delay time.

  • enable: Whether to enable the graceful start feature. true means enabled, false means not enabled.

  • notice: Whether to enable the notification feature. true means enabled, false means enabled.

  • warmupTime: The duration of traffic prefetch, in seconds.

The disk storage size, in GB.

Enable application startup probes.

• Successful check: Indicates that the application started successfully. If you configured Liveness and Readiness checks, the system performs Liveness and Readiness checks after the application starts successfully.

• Failed check: Indicates that the application failed to start. The system reports an exception and automatically restarts the application.

Whether it is a stateful application.

Whether to enable Prometheus custom metric collection.

K8s Headless Service service 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

Shared temporary storage configuration.

The AliyunAgent version.

Whether to reuse the namespace Agent version configuration.

Whether to reuse the namespace SLS log configuration.

SLS log tags.