CreateJob

The name of the job template. The name can contain letters, digits, and hyphens (-). It must start with a letter and be no longer than 36 characters.

The ID of the SAE namespace. The namespace name can contain only lowercase letters and hyphens (-), and must start with a letter.

The description of the job template. It cannot exceed 1,024 characters.

The ID of the VPC for the SAE namespace. In SAE, a namespace can be bound to only one VPC, and this binding cannot be changed. The binding is established when you create the first SAE job template in the namespace. A single VPC can be associated with multiple namespaces. If you do not specify this parameter, the ID of the VPC that is bound to the namespace is used by default.

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

The type of the deployment package. Valid values:

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

• For PHP applications, the 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 applications, valid values are PythonZip and Image.

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

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

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

The JDK version that the deployment package requires. 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 PackageType is set to Image.

The Tomcat version that the deployment package requires. The following versions are supported:

• apache-tomcat-7.0.91

• apache-tomcat-8.5.42

This parameter is not supported when PackageType is set to Image.

The CPU required for each instance, in millicores. This value cannot be 0. Only the following fixed specifications are currently supported:

• 500

• 1000

• 2000

• 4000

• 8000

• 16000

• 32000

The memory required for each instance, in MB. This value cannot be 0. CPU and memory specifications are coupled. The following specifications are currently supported:

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

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

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

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

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

• 16384: corresponds to 4,000, 8,000, or 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, or 32,000 millicores of CPU.

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

The number of concurrent task instances.

The entrypoint command for the container. The command must be an executable inside the container. Example:

command:
      - echo
      - abc
      - >
      - file0

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

Arguments for the entrypoint command (Command). The format is as follows:

["a","b"]

In the example for the Command parameter, the value for CommandArgs is ["abc", ">", "file0"]. This value must be a string that contains a JSON array. If the command takes no arguments, you can omit this parameter.

Environment variables to set in the container. To reference variables, the ConfigMap must already exist. For more information, see CreateConfigMap. The value can be configured in one of the following ways:

• Specify custom variables

  • 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 a value in the sae-sys-configmap-all-<ConfigMap name> format. Example: sae-sys-configmap-all-test1.

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

  • configMapId: The ID of the ConfigMap.

  • key: The key to reference. If you want to reference all key-value pairs, do not specify this parameter.

The host alias that maps a hostname to an IP address in the container. The parameters are described as follows:

• 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 arguments for the JAR package. The default startup command is: $JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs

The version of the HSF runtime environment for the task, such as an Ali-Tomcat container.

The time zone. Default value: Asia/Shanghai.

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

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

• To use your own SLS resources: [{"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 log type. stdout indicates the standard output of the container. You can specify only one standard output. 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 log collection configuration does not change during subsequent deployments, you do not need to set this parameter (the request does not need to include the SlsConfigs field). If you no longer need to use the log collection feature, set the value of this parameter to an empty string ("") in your request.

The ID of the NAS file system. If this configuration does not change in subsequent deployments, you can omit this parameter. To clear the NAS configuration, set this parameter to an empty string ("").

The NAS mount target in the VPC of the job template. If this configuration does not change in subsequent deployments, you can omit this parameter. To clear the NAS configuration, set this parameter to an empty string ("").

The NAS mount description. If this configuration does not change in subsequent deployments, you can omit this parameter. To clear the NAS configuration, set this parameter to an empty string ("").

A PreStop hook. This script runs immediately before the container is stopped. The value must be a JSON string, for example: {"exec":{"command":["sh","-c","echo hello"]}}

A PostStart hook. This script runs immediately after the container is created. The value must be a JSON string, for example: {"exec":{"command":["sh","-c","echo hello"]}}

The startup command for a WAR package deployment. The configuration steps are the same as for an image-based deployment. For more information, see Set a startup command.

The ConfigMap mount description. Use a ConfigMap created in the namespace to inject configurations into the container. The parameters are described as follows:

• configMapId: The ID of the ConfigMap. You can call the ListNamespacedConfigMaps operation to obtain this ID.

• key: The key.

• mountPath: The mount path in the container.

The security group ID.

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

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

• false: You must manually configure the network environment.

The graceful shutdown timeout, in seconds. The value must be an integer from 1 to 300. Default: 30.

The mount path of the startup configuration file for a PHP task. You must make sure that the PHP server uses this configuration file on startup.

The content of the PHP configuration file.

The Tomcat configuration. To delete the configuration, set this parameter to "" or {}. The parameters are described as follows:

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

• contextPath: The context path. Default value: /.

• maxThreads: The maximum number of threads in the connection pool. Default value: 400.

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

• useBodyEncodingForUri: Specifies whether to use the encoding specified in request.getCharacterEncoding() to decode the request URI. Default value: 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 object in OSS. If the specified directory or object does not exist, an exception is thrown.

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

• readOnly: Specifies whether the container has read-only access to the resources in the mount directory. Valid values:

  • true: read-only permission.

  • false: read and write permissions.

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 (ACR) Enterprise Edition instance. This parameter is required when ImageUrl points to an image in an ACR 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 by using a RAM role.

The ID of the secret used to pull the image.

Specifies whether to enable image acceleration. Valid values:

• true: Enables image acceleration.

• false: Disables image acceleration.

The workload. Set the value to job.

The task trigger configuration, which varies based 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"}

• One-off 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 for the task. Valid values:

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

• Allow: Allows concurrent running.

• Replace: If a previous task is still running when the next one is scheduled, the new task replaces the old one.

The task timeout, in seconds.

The maximum number of retries for a task before it is marked as failed.

Specifies whether to enable task sharding.

The parameters for task sharding.

The ID of the referenced job.

The programming language. Valid values: java, php, python, and shell.

The Python environment. PYTHON 3.9.15 is supported.

Python dependencies to install by using pip. If you do not set this parameter, SAE installs dependencies from the 'requirements.txt' file in the root directory of your project.

The configurations for mounting a NAS file system.

The BestEffort policy.