Serverless App Engine：CreateJob - 建立工作範本

工作範本名稱。允許數字、字母以及短劃線（-）組合。必須以字母開始，不超過 36 個字元。

SAE 命名空間 ID。僅支援名稱為小寫字母加短劃線（-）的命名空間，必須以字母開始。

工作範本描述資訊。不超過 1024 個字元。

SAE 命名空間對應的 VPC。在 SAE 中，一個命名空間只能對應一個 VPC，且不能修改。第一次在命名空間內建立 SAE 工作範本將形成綁定關係。多個命名空間可以對應一個 VPC。不填則預設為命名空間綁定的 VPC ID。

任務執行個體彈性網卡所在的虛擬交換器。該交換器必須位於上述 VPC 內。該交換器與 SAE 命名空間同樣存在綁定關係。不填則預設為命名空間綁定的 vSwitch ID。

任務包類型。取值說明如下：

• 當您選擇用 Java 部署時，支援 FatJar、War 和 Image。

• 當您選擇用 PHP 部署時，支援類型如下：

  • 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

• 當您選擇用 Python 部署時，支援 PythonZip 和 Image。

部署套件的版本號碼。當Package Type為 FatJar、War 或 PythonZip 時必填。

部署套件地址。當Package Type為 FatJar、War 或 PythonZip 時必填。

鏡像地址。當Package Type為 Image 時必填。

部署套件依賴的 JDK 版本。支援版本如下：

• Open JDK 8

• Open JDK 7

• Dragonwell 11

• Dragonwell 8

• openjdk-8u191-jdk-alpine3.9

• openjdk-7u201-jdk-alpine3.9

當Package Type為 Image 時不支援。

部署套件依賴的 Tomcat 版本。支援版本如下：

• apache-tomcat-7.0.91

• apache-tomcat-8.5.42

當Package Type為 Image 時不支援。

每個執行個體所需的 CPU，單位為毫核，不能為 0。目前僅支援以下固定規格：

• 500

• 1000

• 2000

• 4000

• 8000

• 16000

• 32000

每個執行個體所需的記憶體，單位為 MB，不能為 0。與 CPU 為一一對應關係，目前僅支援以下固定規格：

• 1024：對應 CPU 為 500 毫核和 1000 毫核。

• 2048：對應 CPU 為 500、1000 毫核和 2000 毫核。

• 4096：對應 CPU 為 1000、2000 毫核和 4000 毫核。

• 8192：對應 CPU 為 2000、4000 毫核和 8000 毫核。

• 12288：對應 CPU 為 12000 毫核。

• 16384：對應 CPU 為 4000、8000 毫核和 16000 毫核。

• 24576：對應 CPU 為 12000 毫核。

• 32768：對應 CPU 為 16000 毫核。

• 65536：對應 CPU 為 8000、16000 和 32000 毫核。

• 131072：對應 CPU 為 32000 毫核。

任務並發執行個體數。

鏡像啟動命令。該命令必須為容器記憶體在的可執行檔對象。樣本如下：

command:
      - echo
      - abc
      - >
      - file0

根據上述樣本，則Command="echo", CommandArgs=["abc", ">", "file0"]。

鏡像啟動命令參數。上述啟動命令 Command 所需參數。格式如下：

["a","b"]

在上述樣本中，CommandArgs=["abc", ">", "file0"]，其中["abc", ">", "file0"]需要轉成 String 類型，裡面的格式為 JSON 數組。如果無此參數，則無需填寫。

容器環境變數參數。支援自訂或引用配置項。如需引用配置項，請先建立 ConfigMap 執行個體。更多資訊，請參見 CreateConfigMap 。取值說明如下：

• 自訂配置

  • name：環境變數名稱。

  • value：環境變數值。

• 引用配置項

  • name：環境變數名稱。支援引用單個或全部鍵，如果引用全部鍵，需輸入sae-sys-configmap-all-<配置項名稱>，例如sae-sys-configmap-all-test1。

  • valueFrom：環境變數引用。取值為configMapRef。

  • configMapId：配置項 ID。

  • key：鍵。如果引用全部健值，則不設定該欄位。

容器內自訂 Host 映射。取值說明如下：

• hostName：網域名稱或主機名稱。

• ip：IP 位址。

JAR 包啟動任務選項。任務預設啟動命令：$JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs

JAR 包啟動任務參數。任務預設啟動命令：$JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs

HSF 架構中任務運行環境版本，例如 Ali-Tomcat 容器。

時區，預設為Asia/Shanghai。

日誌採集到 SLS 的配置。

• 使用 SAE 自動建立的 SLS 資源：[{"logDir":"","logType":"stdout"},{"logDir":"/tmp/a.log"}]。

• 使用自訂的 SLS 資源：[{"projectName":"test-sls","logType":"stdout","logDir":"","logstoreName":"sae","logtailName":""},{"projectName":"test","logDir":"/tmp/a.log","logstoreName":"sae","logtailName":""}]。

參數說明如下：

• projectName：配置 SLS 上的 Project 名稱。

• logDir：日誌路徑。

• logType：日誌類型。stdout 表示容器標準輸出日誌，僅可設定 1 條；如果不設定，則表示收集檔案日誌。

• logstoreName：配置 SLS 上的 Logstore 名稱。

• logtailName：配置 SLS 上的 Logtail 名稱，如果不指定，則表示建立 Logtail。

多次部署時如果 SLS 採集配置沒有變更，則不需要設定該參數（即請求中無需包含 SlsConfigs 欄位）；如果不再需要使用 SLS 採集功能，您需要在請求中將該欄位的值設定為空白字串（即請求中 SlsConfigs 欄位的值為""）。

NAS 檔案系統的 ID。部署時如果配置沒有變更，則不需要設定該參數（即請求中無需包含 NasId 欄位）；如果需要清除 NAS 配置，您需要在請求中將該欄位的值設定為空白字串（即請求中 NasId 欄位的值為""）。

NAS 在工作範本 VPC 內的掛載點。部署時如果配置沒有變更，則不需要設定該參數（即請求中無需包含 MountHost 欄位）；如果需要清除 NAS 配置，您需要在請求中將該欄位的值設定為空白字串（即請求中 MountHost 欄位的值為""）。

NAS 掛載描述。部署時如果配置沒有變更，則不需要設定該參數（即請求中無需包含 MountDesc 欄位）；如果需要清除 NAS 配置，您需要在請求中將該欄位的值設定為空白字串（即請求中 MountDesc 欄位的值為""）。

容器停止前執行指令碼。在容器被刪除前觸發執行一段指令碼，格式如：{"exec":{"command":\["sh","-c","echo hello"\]}}

容器啟動後執行指令碼。在容器被建立後立刻觸發執行一段指令碼，格式如：{"exec":{"command":\["sh","-c","echo hello"\]}}

設定 WAR 包部署任務的啟動命令，操作步驟與鏡像部署的啟動命令配置操作相同。更多資訊，請參見設定啟動命令。

ConfigMap 掛載描述。使用在命名空間配置項頁面建立的配置項來向容器中注入配置資訊。參數說明如下：

• congfigMapId：ConfigMap 執行個體 ID。可通過調用 ListNamespacedConfigMaps 介面擷取。

• key：索引值。

• mountPath：掛載路徑。

安全性群組 ID。

是否自動設定網路環境。取值說明如下：

• true：建立工作範本時 SAE 自動設定網路環境。NamespaceId、VpcId、vSwitchId 和 SecurityGroupId 的取值將被忽略。

• false：建立工作範本時 SAE 手動設定網路環境。

優雅下線逾時時間，預設為 30，單位為秒。取值範圍為 1~300。

PHP 任務啟動配置掛載路徑，需要您保證 PHP 伺服器會使用這個設定檔啟動。

PHP 設定檔內容。

Tomcat 檔案配置，設定為""或"{}"表示刪除配置。取值說明如下：

• port：連接埠範圍為 1024~65535，小於 1024 的連接埠需要 Root 許可權才能操作。因為容器配置的是 Admin 許可權，所以請填寫大於 1024 的連接埠。如果不配置，則預設為 8080。

• contextPath：訪問路徑，預設為根目錄"/"。

• maxThreads：配置串連池的串連數大小，預設大小為 400。

• uriEncoding：Tomcat 的編碼格式，包括UTF-8、ISO-8859-1、GBK 和 GB2312。如果不設定，則預設為ISO-8859-1。

• useBodyEncoding：是否使用BodyEncoding for URL，預設為 true。

OSS 掛載描述資訊。參數說明如下：

• bucketName：Bucket 名稱。

• bucketPath：您在 OSS 建立的目錄或 OSS 對象，如果 OSS 掛載目錄不存在，會觸發異常。

• mountPath：您在 SAE 的容器路徑。如果路徑已存在，為覆蓋關係；如果路徑不存在，會建立。

• readOnly：容器路徑是否對掛載目錄資源有可讀許可權，取值說明如下：

  • true：唯讀許可權。

  • false：讀寫權限。

OSS 讀寫的 AccessKey ID。

OSS 讀寫的 AccessKey Secret。

ACR 企業版執行個體 ID。當 ImageUrl 為Container Registry企業版時必填。

跨帳號拉取鏡像時所需的 RAM 角色的 ARN。更多資訊，請參見通過 RAM 角色實現跨雲帳號授權。

對應保密字典 ID。

是否開啟鏡像加速。取值說明如下：

• true：開啟。

• false：關閉。

Workload 需指定為job。

任務觸發配置，根據任務類型進行配置。

• 定時任務：type 欄位設為 time，config 欄位為具體 Cron 運算式，timezone 欄位為指定時區。 配置樣本：{"type":"time","config":"0 1 */1 * ?","timezone":"GMT+8:00"}

• 一次性任務：type 欄位設為 http，config 配置具體的 HTTP 觸發規則。更多資訊，請參見請求參數 SourceHttpEventParameters。 配置樣本：{"type":"http","config":{"type":"HTTPS","method"、["GET"],"ip":[],"referer":[],"securityConfig":"none"}}

任務並發策略。取值說明如下：

• Forbid：禁止並發運行，在前一個任務未完成時，不建立新任務。

• Allow：允許並發運行任務。

• Replace：當到達新任務建立時間點，而前一個任務未完成時，新的任務會取代前一個任務。

任務逾時時間，單位為秒。

任務重試次數。

啟用任務分區。

任務分區參數。

引用的任務目標 ID。

程式程式設計語言。支援 java、php、python 和 shell。

Python 環境。支援PYTHON 3.9.15。

自訂安裝模組依賴。預設安裝根目錄下 requirements.txt 定義的依賴項。如果未配置或自訂軟體包，可以指定安裝的依賴。

掛載 NAS 的配置。

BestEffort 策略。