ExecJob - ExecJob_Serverless 应用引擎(SAE)-阿里云帮助中心

调用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.	当前用户处于欠费状态。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史