Serverless App Engine:DescribeJob

The VPC ID.

The security group ID.

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 applicable if Package Type is set to Image.

The image URL. This parameter is required if Package Type is set to Image.

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

• Use an SLS resource that SAE automatically creates: [{"logDir":"","logType":"stdout"},{"logDir":"/tmp/a.log"}].

• 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 log path.

• logType: The log type. stdout specifies the container's standard output logs. You can specify only one log of the stdout type. If this parameter is omitted, file logs are collected.

• logstoreName: The name of the Logstore in SLS.

• logtailName: The name of the Logtail configuration in SLS. If you do not specify this parameter, a new Logtail configuration is created.

You can omit this parameter if the Log Service configuration is unchanged during redeployment. To disable log collection, set this parameter to an empty string ("").

The URL of the package. This parameter is required if Package Type is set to FatJar or War.

The type of the job package. Valid values:

• For Java deployments, FatJar, War, and Image are supported.

• For PHP deployments, the following package types are supported:

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

The script to execute before the container stops. This script runs before the system deletes the container. Example: {"exec":{"command":["cat","/etc/group"]}}

The version of the package. This parameter is required if Package Type is set to FatJar or War.

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

The name of the job template.

The ID of the job template.

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

The number of job instances.

The memory required by each instance, in MB. This value cannot be 0. CPU and memory resources are allocated in fixed ratios. The following combinations are supported:

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

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

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

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

• 12288: corresponds to 12,000 millicores.

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

• 24576: corresponds to 12,000 millicores.

• 32768: corresponds to 16,000 millicores.

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

• 131072: corresponds to 32,000 millicores.

The content of the PHP configuration file.

The mount path of the PHP job startup configuration. Make sure that the PHP server uses this configuration to start.

The script to execute after the container starts. This script runs immediately after the system creates the container. Example: {"exec":{"command":["cat","/etc/group"]}}

The timeout for a graceful stop, in seconds. Default: 30. Valid values: 1 to 300.

The arguments of the image startup command. The arguments are passed to the Command parameter. Format:

["a","b"]

In the example of the Command parameter, CommandArgs=["abc", ">", "file0"]. In this case, ["abc", ">", "file0"] must be converted to a string in the format of a JSON array. If this parameter is not specified, you do not need to configure it.

The namespace ID.

The mount target of the Apsara File Storage NAS file system in the job template's VPC. You can omit this parameter if the NAS configuration is unchanged during redeployment. To clear the NAS configuration, set this parameter to an empty string ("").

The Tomcat file configuration. To delete the configuration, set this parameter to "" or "{}".

• port: The port number. Valid values: 1024 to 65535. Ports below 1024 are reserved. If you do not specify a port, the default value is 8080.

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

• maxThreads: The maximum number of connections 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 you do not specify this parameter, the default value ISO-8859-1 is used.

• useBodyEncodingForUri: Specifies whether to use the character encoding from the request body for the URI. Default value: true.

The region ID.

The vSwitch ID.

The number of CPU cores that are required by each instance. Unit: millicores. This parameter cannot be set to 0. Only the following fixed specifications are supported:

• 500

• 1000

• 2000

• 4000

• 8000

• 16000

• 32000

The container environment variables. You can define custom variables or reference a ConfigMap. To reference a ConfigMap, you must first create a ConfigMap. For more information, see CreateConfigMap. The following formats are supported:

• Define 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 sae-sys-configmap-all-<ConfigMap name>, for 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 of the key-value pair. If you reference all keys in the ConfigMap, you do not need to specify this parameter.

The custom host mapping in the container. The parameters are described as follows:

• hostName: The domain name or hostname.

• ip: The IP address.

The version of the Tomcat container on which the 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 image startup command. The command must be an executable that exists in the container. Example:

command:
      - echo
      - abc
      - >
      - file0

In this example, Command="echo", CommandArgs=["abc", ">", "file0"].

The options for the startup of a WAR package. The default startup command is java $JAVA_OPTS $CATALINA_OPTS -Options org.apache.catalina.startup.Bootstrap "$@" start.

The ID of the Apsara File Storage NAS file system.

The AccessKey ID for accessing Object Storage Service (OSS) buckets.

The AccessKey secret for accessing OSS buckets.

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

The time zone. Default value: Asia/Shanghai.

The description of the job template.

The ID of the Container Registry (ACR) Enterprise Edition instance.

The ARN of the RAM role that is required to pull images across accounts. For more information, see Pull images across Alibaba Cloud accounts and Grant permissions across Alibaba Cloud accounts by using a RAM role.

The ID of the Secret.

The job trigger configuration. The configuration varies based on the job type.

• Scheduled task: 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 task: Set type to http, and for config, specify the HTTP trigger rules. For more information, see SourceHttpEventParameters. Example: {"type":"http","config":{"type":"HTTPS","method":["GET"],"ip":[],"referer":[],"securityConfig":"none"}}

The concurrency policy for the job. Valid values:

• Forbid: Forbids concurrent runs. A new job is not created if the previous one has not completed.

• Allow: Allows concurrent runs.

• Replace: If the previous job has not completed, the new job replaces it.

Specifies whether to suspend the job template.

The timeout period for the job. Unit: seconds.

The maximum number of retries for a failed job.

Specifies whether to enable job sharding.

The parameters for job sharding.

The ID of the referenced job template.

The programming language that is used for the job template. Valid values:

• java: Java

• php: PHP

• python: Python

• other: Other languages, such as C++, Go, .NET, and Node.js.

The configuration for mounting an Apsara File Storage NAS file system.

The Python environment. PYTHON 3.9.15 is supported.

The Python module dependencies to install. By default, SAE installs dependencies from a requirements.txt file in the package's root directory. Use this parameter to specify dependencies if a requirements.txt file is not present or to add extra modules.

The Best-Effort policy.