Serverless App Engine:CreateJob

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

The ID of the Serverless App Engine (SAE) namespace. The ID can contain only lowercase letters and hyphens (-). It must start with a lowercase 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 if you set PackageType 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 returned only if the PackageType parameter is set 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. You cannot set this parameter to 0. Valid values:

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

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

• Set the value to 1024 when Cpu is set to 500 or 1000.
• Set the value to 2048 when Cpu is set to 500, 1000 or 2000.
• Set the value to 4096 when Cpu is set to 1000, 2000, or 4000.
• Set the value to 8192 when Cpu is set to 2000, 4000, or 8000.
• Set the value to 12288 when Cpu is set to 12000.
• Set the value to 16384 when Cpu is set to 4000, 8000, or 16000.
• Set the value to 24576 when Cpu is set to 12000.
• Set the value to 32768 when Cpu is set to 16000.
• Set the value to 65536 when Cpu is set to 8000, 16000, or 32000.
• Set the value to 131072 when Cpu is set to 32000.

The number of concurrent instances.

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. If you want to reference a ConfigMap, you must first create a ConfigMap. For more information, see CreateConfigMap . Take note of the following rules:

• Customize

  • name: the name of the environment variable.
  • value: the value of the environment variable.

• Reference ConfigMap

  • name: the name of the environment variable. You can reference one or all keys. If you want to reference all keys, specify sae-sys-configmap-all-<ConfigMap name>. Example: sae-sys-configmap-all-test1.
  • valueFrom: the reference of the environment variable. Set the value to configMapRef.
  • configMapId: the ConfigMap ID.
  • key: the key. If you want to reference all keys, do not 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.

The version of the container, such as Ali-Tomcat, in which an application developed based on High-speed Service Framework (HSF) is deployed.

The time zone. Default value: 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.

The ID of the Apsara File Storage NAS file system. After the application is created, you may want to call other operations to manage the application. If you do not want to change the NAS configurations in these subsequent operations, you can omit the NasId parameter in the requests. If you want to unmount the NAS file system, you must set the NasId values in the subsequent requests to an empty string ("").

The mount target of the NAS file system in the VPC where the application is deployed. If you do not need to modify this configuration during the deployment, configure the MountHost parameter only in the first request. You do not need to include this parameter in subsequent requests. If you need to remove this configuration, leave the MountHost parameter empty in the request.

The configurations for mounting the NAS file system. After the application is created, you may want to call other operations to manage the application. If you do not want to change the NAS configurations in these subsequent operations, you can omit the MountDesc parameter in the requests. If you want to unmount the NAS file system, you must set the MountDesc values in the subsequent requests to an empty string ("").

The script that is run before the container is stopped. Example: {"exec":{"command":\["sh","-c","echo hello"\]}}

The script that is run immediately after the container is started. Example: {"exec":{"command":\["sh","-c","echo hello"\]}}

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.

The ID of the security group.

Specifies whether to automatically configure the network environment. Take note of the following rules:

• true: The network environment is automatically configured by SAE when the application is created. In this case, the values of the NamespaceId, VpcId, vSwitchId, and SecurityGroupId parameters are ignored.
• false: The network environment is manually configured based on your settings when the application is created.

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 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 is used to read data from and write data to Object Storage Service (OSS) buckets.

The AccessKey secret that is used to read data from and write data to OSS buckets.

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.

Set the value to job.

The trigger configuration. Configure this parameter based on the job type.

• Scheduled job: Set type to time, config to a CRON expression, and timezone to a specific time zone.

Example: {"type":"time","config":"0 1 */1 * ?","timezone":"GMT+8:00"}

• One-time job: Set type to http and configure an HTTP trigger rule for config. For more information, see SourceHttpEventParameters .

Example: {"type":"http","config":{"type":"HTTPS","method"、["GET"],"ip":[],"referer":[],"securityConfig":"none"}}

The concurrency policy of the job. Take note of the following rules:

• Forbid: Prohibits concurrent running. If the previous job is not completed, no new job is created.
• Allow: Allows concurrent running.
• Replace: If the previous job is not completed when the time to create a new job is reached, the new job replaces the previous job.

The timeout period. Unit: seconds.

The number of times the job is retried.

Specifies whether to enable job sharding.

The parameters of job sharding.

The ID of the job that you reference.

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

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.