ExecJob
调用ExecJob接口执行任务。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求头
该接口使用公共请求头,无特殊请求头。更多信息,请参见公共请求和返回头。
请求语法
GET /pop/v1/sam/job/execJob HTTP/1.1
请求参数
名称 |
类型 |
位置 |
是否必选 |
示例值 |
描述 |
AppId | String | Query | 是 | ee1a7a07-abcb-4652-a1d3-2d57f415**** | 任务模板ID。 |
EventId | String | Query | 否 | custom | 事件ID,用户自定义。用作幂等使用,相同事件ID仅创建一个任务。 |
Command | String | Query | 否 | echo | 镜像启动命令。该命令必须为容器内存在的可执行的对象。示例如下:
根据上述示例,则 |
CommandArgs | String | Query | 否 | ["a","b"] | 镜像启动命令参数。上述启动命令Command所需参数。格式如下: ["a","b"]
在上述示例中, |
Envs | String | Query | 否 | [{"name":"envtmp","value":"0"}] | 容器环境变量参数。支持自定义或引用配置项。如需引用配置项,请先创建ConfigMap实例。更多信息,请参见CreateConfigMap。取值说明如下:
|
JarStartOptions | String | Query | 否 | -Xms4G -Xmx4G | JAR包启动任务选项。任务默认启动命令: $JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArg
|
JarStartArgs | String | Query | 否 | custom-args | JAR包启动任务参数。任务默认启动命令: $JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs
|
WarStartOptions | String | Query | 否 | CATALINA_OPTS=\"$CATALINA_OPTS $Options\" catalina.sh run | 设置WAR包部署任务的启动命令,操作步骤与镜像部署的启动命令配置操作相同。更多信息,请参见设置启动命令。 |
Time | String | Query | 否 | 2023-09-14T14:25:02Z | 任务触发时间,格式为 |
Replicas | String | Query | 否 | 3 | 任务并发实例数。 |
返回数据
名称 |
类型 |
示例值 |
描述 |
RequestId | String | 67DD9A98-9CCC-5BE8-8C9E-B45E72F4**** | 请求ID。 |
Message | String | success | 附加信息。取值说明如下:
|
TraceId | String | 0b87b7e716575071334387401e**** | 调用链ID,用于精确查询调用信息。 |
Data | Object | 返回数据。 |
|
Data | String | manual-3db7a8fa-5d40-4edc-92e4-49d50eab**** | 任务ID。 |
Msg | String | success | 附加信息。取值说明如下:
|
Success | String | true | 执行任务是否成功。取值说明如下:
|
Code | String | 200 | 接口状态或POP错误码。取值说明如下:
|
ErrorCode | String | 空 | 错误码。取值说明如下:
|
Code | String | 200 | 接口状态或POP错误码。取值说明如下:
|
Success | Boolean | true | 执行任务是否成功。取值说明如下:
|
示例
请求示例
GET /pop/v1/sam/job/execJob?AppId=ee1a7a07-abcb-4652-a1d3-2d57f415****&EventId=custom&Command=echo&CommandArgs=["a","b"]&Envs=[{"name":"envtmp","value":"0"}]&JarStartOptions=-Xms4G -Xmx4G&JarStartArgs=custom-args&WarStartOptions=CATALINA_OPTS=\"$CATALINA_OPTS $Options\" catalina.sh run&Time=2023-09-14T14:25:02Z&Replicas=3 HTTP/1.1
Host:sae.aliyuncs.com
Content-Type:application/json
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ExecJobResponse>
<RequestId>67DD9A98-9CCC-5BE8-8C9E-B45E72F4****</RequestId>
<Message>success</Message>
<TraceId>0b87b7e716575071334387401e****</TraceId>
<Data>
<Data>manual-3db7a8fa-5d40-4edc-92e4-49d50eab****</Data>
<Msg>success</Msg>
<Success>true</Success>
<Code>200</Code>
</Data>
<Code>200</Code>
<Success>true</Success>
</ExecJobResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/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"
},
"Code" : "200",
"Success" : true
}
错误码
HttpCode |
错误码 |
错误信息 |
描述 |
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. | 当前用户处于欠费状态。 |
访问错误中心查看更多错误码。