調用ExecJob API執行任務-Serverless 應用引擎-阿里雲 - Serverless App Engine

調用ExecJob介面執行任務

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

sae:ExecJob

*全部資源

*

無

請求文法

GET /pop/v1/sam/job/execJob HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
AppId	string	是	工作範本 ID	ee1a7a07-abcb-4652-a1d3-2d57f415****
EventId	string	否	事件 ID，使用者自訂。用作等冪使用，相同事件 ID 僅建立一個任務。	custom
Command	string	否	鏡像啟動命令。該命令必須為容器記憶體在的可執行檔對象。樣本如下： `command: - echo - abc - > - file0` 根據上述樣本，則`Command="echo", CommandArgs=["abc", ">", "file0"]`。	echo
CommandArgs	string	否	鏡像啟動命令參數。上述啟動命令 Command 所需參數。格式如下： `["a","b"]` 在上述樣本中，`CommandArgs=["abc", ">", "file0"]`，其中`["abc", ">", "file0"]`需要轉成 String 類型，裡面的格式為 JSON 數組。如果無此參數，則無需填寫。	["a","b"]
Envs	string	否	容器環境變數參數。支援自訂或引用配置項。如需引用配置項，請先建立 ConfigMap 執行個體。更多資訊，請參見 CreateConfigMap 。取值說明如下：自訂配置 name：環境變數名稱。 value：環境變數值。引用配置項 name：環境變數名稱。支援引用單個或全部鍵，如果引用全部鍵，需輸入`sae-sys-configmap-all-<配置項名稱>`，例如`sae-sys-configmap-all-test1`。 valueFrom：環境變數引用。取值為`configMapRef`。 configMapId：配置項 ID。 key：鍵。如果引用全部健值，則不設定該欄位。	[{"name":"envtmp","value":"0"}]
JarStartOptions	string	否	JAR 包啟動任務選項。任務預設啟動命令： `$JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArg`	-Xms4G -Xmx4G
JarStartArgs	string	否	JAR 包啟動任務參數。任務預設啟動命令： `$JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs`	custom-args
WarStartOptions	string	否	設定 WAR 包部署任務的啟動命令，操作步驟與鏡像部署的啟動命令配置操作相同。更多資訊，請參見設定啟動命令。	CATALINA_OPTS=\"$CATALINA_OPTS $Options\" catalina.sh run
Time	string	否	任務觸發時間，格式為`yyyy-MM-dd'T'HH:mm:ss'Z'`。	2023-09-14T14:25:02Z
Replicas	string	否	任務並發執行個體數	3

返回參數

名稱	類型	描述	樣本值
	object	返回資料
RequestId	string	請求 ID	67DD9A98-9CCC-5BE8-8C9E-B45E72F4****
Message	string	附加資訊。取值說明如下：請求正常，返回 success。請求異常，返回具體異常錯誤碼。	success
TraceId	string	調用鏈 ID，用於精確查詢調用資訊。	0b87b7e716575071334387401e****
Data	object	返回資料
Data	string	任務 ID	manual-3db7a8fa-5d40-4edc-92e4-49d50eab****
Msg	string	附加資訊。取值說明如下：請求正常，返回 success。請求異常，返回具體異常錯誤碼。	success
Success	string	執行任務是否成功。取值說明如下： true：執行成功。 false：執行失敗。	true
Code	string	介面狀態或 POP 錯誤碼。取值說明如下： 2xx：成功。 3xx：重新導向。 4xx：請求錯誤。 5xx：伺服器錯誤。	200
ErrorCode	string	錯誤碼。取值說明如下：請求成功：不返回 ErrorCode 欄位。請求失敗：返回 ErrorCode 欄位。具體資訊，請參見本文的錯誤碼列表。
Code	string	介面狀態或 POP 錯誤碼。取值說明如下： 2xx：成功。 3xx：重新導向。 4xx：請求錯誤。 5xx：伺服器錯誤。	200
Success	boolean	執行任務是否成功。取值說明如下： true：執行成功。 false：執行失敗。	true

樣本

正常返回樣本

JSON格式

{
  "RequestId": "67DD9A98-9CCC-5BE8-8C9E-B45E72F4****",
  "Message": "success",
  "TraceId": "0b87b7e716575071334387401e****",
  "Data": {
    "Data": "manual-3db7a8fa-5d40-4edc-92e4-49d50eab****",
    "Msg": "success",
    "Success": "true",
    "Code": "200"
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidApplication.NotFound	The current application does not exist.	找不到當前應用。
400	JobForbidPolicy	You cannot execute new jobs because ongoing jobs exist.	存在正在執行的任務，根據並發策略無法執行新任務。
400	JobSuspend	The job is suspended.	任務已經停止，請啟用任務後再進行執行。
400	user.indebt	The user has an outstanding payment.	目前使用者處於欠費狀態。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。