Serverless App Engine:CreateJob

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

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

The description of the job template. The description cannot exceed 1024 characters in length.

The VPC that corresponds to the SAE namespace. In SAE, a namespace can be bound to only one VPC and the binding cannot be changed. When you create a job template in a namespace for the first time, the namespace is bound to the VPC. Multiple namespaces can be bound to the same VPC. If you do not specify this parameter, the VPC ID that is bound to the namespace is used by default.

The vSwitch to which the elastic network interface (ENI) of the task instance is connected. The vSwitch must be located in the preceding VPC. The vSwitch is also bound to the SAE namespace. If you do not specify this parameter, the vSwitch ID that is bound to the namespace is used by default.

The type of the deployment package. Valid values:

• For Java deployments, valid values are FatJar, War, and Image.

• For PHP deployments, valid values 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

• For Python deployments, valid values are PythonZip and Image.

The version number 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 version of the 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 the Tomcat container 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 amount of CPU required for each instance, in millicores. This parameter cannot be set to 0. The following fixed specifications are supported:

• 500

• 1000

• 2000

• 4000

• 8000

• 16000

• 32000

The amount of memory required for each instance, in MB. This parameter cannot be set to 0. The CPU and memory specifications have a one-to-one correspondence. The following fixed specifications are supported:

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

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

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

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

• 12288: corresponds to 12,000 millicores of CPU.

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

• 24576: corresponds to 12,000 millicores of CPU.

• 32768: corresponds to 16,000 millicores of CPU.

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

• 131072: corresponds to 32,000 millicores of CPU.

The number of concurrent instances for the task.

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, set Command to "echo" and CommandArgs to ["abc", ">", "file0"].

The parameters of the image startup command. These are the parameters 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 that is a JSON array. If this parameter is not used, you do not need to specify it.

The environment variables of the container. You can customize environment variables or reference ConfigMaps. To reference a ConfigMap, you must first create a ConfigMap instance. For more information, see CreateConfigMap. Valid values:

• Custom configuration

  • name: The name of the environment variable.

  • value: The value of the environment variable.

• Reference a ConfigMap

  • 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>. For example, sae-sys-configmap-all-test1.

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

  • configMapId: The ID of the ConfigMap.

  • key: The key. If you reference all key-value pairs, you do not need to set this field.

The custom mapping between a hostname and an IP address in the container. Valid values:

• hostName: The domain name or hostname.

• ip: The IP address.

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

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

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

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

The configuration for collecting logs to Simple Log Service (SLS).

• To use an SLS resource that is automatically created by SAE: [{"logDir":"","logType":"stdout"},{"logDir":"/tmp/a.log"}].

• To use a custom SLS resource: [{"projectName":"test-sls","logType":"stdout","logDir":"","logstoreName":"sae","logtailName":""},{"projectName":"test","logDir":"/tmp/a.log","logstoreName":"sae","logtailName":""}].

The parameters are described as follows:

• projectName: The name of the SLS project.

• logDir: The path of the log file.

• logType: The type of the log. 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 in SLS. If you do not specify this parameter, a new Logtail is created.

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

The ID of the NAS file system. If the configuration does not change during a deployment, you do not need to set this parameter. In this case, the request does not need to include the NasId field. To clear the NAS configuration, set the value of this parameter to an empty string ("") in the request.

The mount target of the NAS file system in the VPC where the job template is located. If the configuration does not change during a deployment, you do not need to set this parameter. In this case, the request does not need to include the MountHost field. To clear the NAS configuration, set the value of this parameter to an empty string ("") in the request.

The description of the NAS mount. If the configuration does not change during a deployment, you do not need to set this parameter. In this case, the request does not need to include the MountDesc field. To clear the NAS configuration, set the value of this parameter to an empty string ("") in the request.

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

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

The startup command for a WAR package deployment task. The configuration 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.

The description of the ConfigMap mount. Use the ConfigMap that you created on the Namespace Configurations page to inject configuration information into the container. The parameters are described as follows:

• configMapId: The ID of the ConfigMap instance. You can obtain the ID by calling the ListNamespacedConfigMaps operation.

• key: The key.

• mountPath: The mount path.

The ID of the security group.

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

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

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

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

The mount path of the startup configuration for the PHP task. The PHP server must use this configuration file to start.

The content of the PHP configuration file.

The configuration of the Tomcat file. Set this parameter to "" or "{}" to delete the configuration. The parameters are described as follows:

• port: The port number. The valid range is 1024 to 65535. Ports smaller than 1024 require root permissions. Because the container is configured with administrator permissions, specify a port number greater than 1024. If you do not configure this parameter, the default port 8080 is used.

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

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

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

• useBodyEncoding: Indicates whether to use BodyEncoding for URL. The default value is true.

The description of the Object Storage Service (OSS) mount. The parameters are described as follows:

• bucketName: The name of the bucket.

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

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

• readOnly: Indicates 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 for reading from and writing to OSS.

The AccessKey secret for reading from and writing to OSS.

The ID of the Container Registry Enterprise Edition instance. This parameter is required when ImageUrl is the address of an image in a Container Registry 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 pull images across Alibaba Cloud accounts using a RAM role.

The ID of the secret.

Indicates whether to enable image acceleration. Valid values:

• true: enable.

• false: disable.

The workload. Set the value to job.

The configuration of the task trigger. The settings vary depending on the task type.

• Scheduled task: Set the type field to 'time', the config field to a Cron expression, and the timezone field to a specific time zone. Example: {"type":"time","config":"0 1 */1 * ?","timezone":"GMT+8:00"}

• Manually triggered task: Set the type field to 'http' and specify the HTTP trigger rules in the config field. For more information, see SourceHttpEventParameters. Example: {"type":"http","config":{"type":"HTTPS","method":["GET"],"ip":[],"referer":[],"securityConfig":"none"}}

The concurrency policy of the task. Valid values:

• Forbid: Prohibits concurrent running. A new task is not created if the previous task is not complete.

• Allow: Allows concurrent running.

• Replace: When the time for creating a new task is reached but the previous task is not complete, the new task replaces the previous task.

The timeout period of the task. Unit: seconds.

The number of retries for the task.

Enables task sharding.

The parameters for task sharding.

The ID of the referenced task.

The programming language of the program. Supported languages are java, php, python, and shell.

The Python environment. PYTHON 3.9.15 is supported.

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