全部产品
Search
文档中心

弹性高性能计算E-HPC:CreateJobTemplate - 创建作业模板

更新时间:Mar 03, 2024

调用CreateJobTemplate创建作业模板。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ehpc:CreateJobTemplateWRITE
  • 全部资源
    *

请求参数

名称类型必填描述示例值
CommandLinestring

执行作业命令。

./LammpsTest/lammps.pbs
Namestring

作业模板名称。长度为 2~64 字符,必须以英文字母开头,可以包含数字、短划线(-)、下划线(_)。

jobtemplate1
RunasUserstring

执行作业的用户名。

您可以通过调用 ListUsers 获取用户名。

user1
Priorityinteger

执行作业优先级,取值范围:0~9,取值越大,优先级越高。

默认值:0

0
PackagePathstring

执行作业路径。

./jobfolder
StdoutRedirectPathstring

标准输出路径。

./LammpsTest
StderrRedirectPathstring

错误输出路径。

./LammpsTest
ReRunableboolean

作业执行失败后,是否支持自动重试。取值范围:

  • true:支持
  • false:不支持
false
ArrayRequeststring

作业队列。

格式 X-Y:Z, 最小值 X 是第一个索引,最大值 Y 是最后一个索引,Z 表示步长,例如 2-7:2,表示作业队列包含编号为 2、4、6 的 3 个子作业。

1-10:2
Variablesstring

执行作业的环境变量,可以在作业执行文件中访问环境变量。

[{Name:,Value:},{Name:,Value:}]
Queuestring

执行作业的队列名称。

您可以通过调用 ListQueues 获取队列名称。

workq
ClockTimestring

作业最大运行时间,支持三种格式:

  • hh:mm:ss
  • mm:ss
  • ss

推荐使用第一种格式。若最大运行时间为 12 小时,示例:12:00:00。

12:00:00
Nodeinteger

提交作业所需计算节点数。取值范围:1~500

说明 若该参数为空,则参数 Task、Thread、Mem、Gpu 不生效。
2
Taskinteger

单个计算节点所需任务数。取值范围:1~1000

2
Threadinteger

单个任务所需线程数。取值范围:1~1000

1
Memstring

单个计算节点最大使用内存数,支持 GB、MB、KB,单位不区分大小写。

1GB
Gpuinteger

单个计算节点使用 GPU 的数量,取值范围:1~8。

仅支持使用 PBS 调度器的集群,且集群内计算节点含 GPU 时该参数生效。

1
InputFileUrlstring

已上传到 OSS 上的作业文件链接。

https://test.oss-cn-beijing.aliyuncs.com/test.py
WithUnzipCmdboolean

是否解压下载后的作业文件。取值范围:

  • true:是

  • false:否

true
UnzipCmdstring

解压命令,当 WithUnzipCmd 取值为 true 时,该参数生效。取值范围:

  • tar xzf:解开 gzip 格式压缩包

  • tar xf:解开 tar 格式压缩包

  • unzip:解开 zip 格式压缩包

tar xzf

返回参数

名称类型描述示例值
object
TemplateIdstring

作业模板 ID。

ehpc-job-tmpl-6RxO5y****
RequestIdstring

请求 ID。

04F0F334-1335-436C-A1D7-6C044FE7****

示例

正常返回示例

JSON格式

{
  "TemplateId": "ehpc-job-tmpl-6RxO5y****",
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE7****"
}

错误码

HTTP status code错误码错误信息描述
400InvalidParamsThe specified parameter %s is invalid.无效的参数:%s
400NotEnabledYou have not enabled this service您的账户还未开通此服务
400InDebtYour account has overdue payments.您的账户已欠费
403InvalidClusterStatusThe operation failed due to invalid cluster status.集群状态不允许执行本次操作。
403ConflictOptA conflicting operation is running.有冲突的操作在执行中,请您稍后再试。
403TemplateNameExistThe template name already exists.模板名称已存在
403TooMuchTemplatesThe number of templates exceeds the quota.模版数超出用户最大配额
406DbErrorA database service error occurred.数据库请求失败
406AliyunErrorAn Alibaba Cloud product error occurred.阿里云产品错误
407NotAuthorizedYou are not authorized by RAM for this request.此请求未获得RAM授权
409PartFailurePart of the batch operation failed.批量操作部分失败
500UnknownErrorAn unknown error occurred.未知错误
503ServiceUnavailableThe request has failed due to a temporary failure of the server请求失败,服务暂时不可用

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

变更历史

变更时间变更内容概要操作
2021-11-17OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:406
    删除错误码:407
    删除错误码:409
    删除错误码:500
    删除错误码:503
入参OpenAPI 入参发生变更
    新增入参:InputFileUrl
    新增入参:WithUnzipCmd
    新增入参:UnzipCmd