CreateJob_Serverless 应用引擎_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

当前云产品API请求速率暂未透出。

授权信息

当前云产品暂无权限信息透出。

请求语法

POST /pop/v1/sam/job/createJob HTTP/1.1

请求参数

字段名称字段详情
AppNamestring

任务模板名称。允许数字、字母以及短划线(-)组合。必须以字母开始,不超过 36 个字符。

示例值:test
NamespaceIdstring

SAE 命名空间 ID。仅支持名称为小写字母加短划线(-)的命名空间,必须以字母开始。

示例值:cn-beijing:test
AppDescriptionstring

任务模板描述信息。不超过 1024 个字符。

示例值:This is a test description.
VpcIdstring

SAE 命名空间对应的 VPC。在 SAE 中,一个命名空间只能对应一个 VPC,且不能修改。第一次在命名空间内创建 SAE 任务模板将形成绑定关系。多个命名空间可以对应一个 VPC。不填则默认为命名空间绑定的 VPC ID。

示例值:vpc-bp1aevy8sofi8mh1q****
VSwitchIdstring

任务实例弹性网卡所在的虚拟交换机。该交换机必须位于上述 VPC 内。该交换机与 SAE 命名空间同样存在绑定关系。不填则默认为命名空间绑定的 vSwitch ID。

示例值:vsw-bp12mw1f8k3jgygk9****
PackageTypestring

任务包类型。取值说明如下:展开详情

示例值:FatJar
PackageVersionstring

部署包的版本号。当Package TypeFatJarWarPythonZip 时必填。

示例值:1.0.1
PackageUrlstring

部署包地址。当Package TypeFatJarWarPythonZip 时必填。

示例值:http://myoss.oss-cn-hangzhou.aliyuncs.com/my-buc/2019-06-30/****.jar
ImageUrlstring

镜像地址。当Package TypeImage 时必填。

示例值:registry.cn-hangzhou.aliyuncs.com/sae_test/ali_sae_test:0.0.1
Jdkstring

部署包依赖的 JDK 版本。支持版本如下:展开详情

示例值:Open JDK 8
WebContainerstring

部署包依赖的 Tomcat 版本。支持版本如下:展开详情

示例值:apache-tomcat-7.0.91
Cpuinteger<int32>

每个实例所需的 CPU,单位为毫核,不能为 0。目前仅支持以下固定规格:展开详情

示例值:1000
Memoryinteger<int32>

每个实例所需的内存,单位为 MB,不能为 0。与 CPU 为一一对应关系,目前仅支持以下固定规格:展开详情

示例值:1024
Replicasinteger<int32>

任务并发实例数。

示例值:3
Commandstring

镜像启动命令。该命令必须为容器内存在的可执行的对象。示例如下:展开详情

示例值:echo
CommandArgsstring

镜像启动命令参数。上述启动命令 Command 所需参数。格式如下:展开详情

示例值:["a","b"]
Envsstring

容器环境变量参数。支持自定义或引用配置项。如需引用配置项,请先创建 ConfigMap 实例。更多信息,请参见 CreateConfigMap 。取值说明如下:展开详情

示例值:[{"name":"envtmp","value":"0"}]
CustomHostAliasstring

容器内自定义 Host 映射。取值说明如下:展开详情

示例值:[{"hostName":"samplehost","ip":"127.0.0.1"}]
JarStartOptionsstring

JAR 包启动任务选项。任务默认启动命令:$JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs

示例值:custom-option
JarStartArgsstring

JAR 包启动任务参数。任务默认启动命令:$JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs

示例值:-Xms4G -Xmx4G
EdasContainerVersionstring

HSF 框架中任务运行环境版本,例如 Ali-Tomcat 容器。

示例值:3.5.3
Timezonestring

时区,默认为Asia/Shanghai

示例值:Asia/Shanghai
SlsConfigsstring

日志采集到 SLS 的配置。展开详情

示例值:[{"logDir":"","logType":"stdout"},{"logDir":"/tmp/a.log"}]
NasIdstring

NAS 文件系统的 ID。部署时如果配置没有变更,则不需要设置该参数(即请求中无需包含 NasId 字段);如果需要清除 NAS 配置,您需要在请求中将该字段的值设置为空字符串(即请求中 NasId 字段的值为"")。

示例值:10d3b4****
MountHoststring

NAS 在任务模板 VPC 内的挂载点。部署时如果配置没有变更,则不需要设置该参数(即请求中无需包含 MountHost 字段);如果需要清除 NAS 配置,您需要在请求中将该字段的值设置为空字符串(即请求中 MountHost 字段的值为"")。

示例值:10d3b4bc9****.com
MountDescstring

NAS 挂载描述。部署时如果配置没有变更,则不需要设置该参数(即请求中无需包含 MountDesc 字段);如果需要清除 NAS 配置,您需要在请求中将该字段的值设置为空字符串(即请求中 MountDesc 字段的值为"")。

示例值:[{mountPath: "/tmp", nasPath: "/"}]
PreStopstring

容器停止前执行脚本。在容器被删除前触发执行一段脚本,格式如:{"exec":{"command":\["sh","-c","echo hello"\]}}

示例值:{"exec":{"command":["sh","-c","echo hello"]}}
PostStartstring

容器启动后执行脚本。在容器被创建后立刻触发执行一段脚本,格式如:{"exec":{"command":\["sh","-c","echo hello"\]}}

示例值:{"exec":{"command":["sh","-c","echo hello"]}}
WarStartOptionsstring

设置 WAR 包部署任务的启动命令,操作步骤与镜像部署的启动命令配置操作相同。更多信息,请参见设置启动命令

示例值:CATALINA_OPTS=\"$CATALINA_OPTS $Options\" catalina.sh run
ConfigMapMountDescstring

ConfigMap 挂载描述。使用在命名空间配置项页面创建的配置项来向容器中注入配置信息。参数说明如下:展开详情

示例值:[{"configMapId":16,"key":"test","mountPath":"/tmp"}]
SecurityGroupIdstring

安全组 ID。

示例值:sg-wz969ngg2e49q5i4****
AutoConfigboolean

是否自动配置网络环境。取值说明如下:展开详情

示例值:false
TerminationGracePeriodSecondsinteger<int32>

优雅下线超时时间,默认为 30,单位为秒。取值范围为 1~300。

示例值:10取值 <= 6000
PhpConfigLocationstring

PHP 任务启动配置挂载路径,需要您保证 PHP 服务器会使用这个配置文件启动。

示例值:/usr/local/etc/php/php.ini
PhpConfigstring

PHP 配置文件内容。

示例值:k1=v1
TomcatConfigstring

Tomcat 文件配置,设置为""或"{}"表示删除配置。取值说明如下:展开详情

示例值:{"port":8080,"contextPath":"/","maxThreads":400,"uriEncoding":"ISO-8859-1","useBodyEncodingForUri":true}
OssMountDescsstring

OSS 挂载描述信息。参数说明如下:展开详情

示例值:[{"bucketName": "oss-bucket", "bucketPath": "data/user.data", "mountPath": "/usr/data/user.data", "readOnly": true}]
OssAkIdstring

OSS 读写的 AccessKey ID。

示例值:xxxxxx
OssAkSecretstring

OSS 读写的 AccessKey Secret。

示例值:xxxxxx
AcrInstanceIdstring

ACR 企业版实例 ID。当 ImageUrl 为容器镜像服务企业版时必填。

示例值:cri-xxxxxx
AcrAssumeRoleArnstring

跨账号拉取镜像时所需的 RAM 角色的 ARN。更多信息,请参见通过 RAM 角色实现跨云账号授权

示例值:acs:ram::123456789012****:role/adminrole
ImagePullSecretsstring

对应保密字典 ID。

示例值:10
EnableImageAcclboolean

是否开启镜像加速。取值说明如下:展开详情

示例值:false
Workloadstring

Workload 需指定为job

示例值:job
TriggerConfigstring

任务触发配置,根据任务类型进行配置。展开详情

示例值:{"type":"time","config":"0 1 */1 * ?","timezone":"GMT+8:00"}
ConcurrencyPolicystring

任务并发策略。取值说明如下:展开详情

示例值:Allow
Timeoutinteger<int64>

任务超时时间,单位为秒。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:3600
BackoffLimitinteger<int64>

任务重试次数。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:3
Sliceboolean

启用任务分片。

示例值:true
SliceEnvsstring

任务分片参数。

示例值:[0,1,2]
RefAppIdstring

引用的任务目标 ID。

示例值:7171a6ca-d1cd-4928-8642-7d5cfe69****
ProgrammingLanguagestring

程序编程语言。支持 javaphppythonshell

示例值:java
Pythonstring

Python 环境。支持PYTHON 3.9.15

示例值:PYTHON 3.9.15
PythonModulesstring

自定义安装模块依赖。默认安装根目录下 requirements.txt 定义的依赖项。如果未配置或自定义软件包,可以指定安装的依赖。

示例值:Flask==2.0

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:01CF26C7-00A3-4AA6-BA76-7E95F2A3***
Messagestring

附加信息。取值说明如下:展开详情

示例值:success
TraceIdstring

调用链 ID,用于精确查询调用信息。

示例值:ac1a0b2215622246421415014e****
Dataobject

返回结果。

ErrorCodestring

错误码。取值说明如下:展开详情

示例值:
Codestring

接口状态或 POP 错误码。取值说明如下:展开详情

示例值:200
Successboolean

创建任务模板是否成功。取值说明如下:展开详情

示例值:true

返回示例

变更历史

暂无变更历史

相关示例