调用ListJobTemplates查询作业模板列表。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListJobTemplates

系统规定参数。取值:ListJobTemplates

Name String jobtemplateName

作业模板名称。

您可以通过调用ListJobTemplates获取模板名称。

PageNumber Integer 1

当前页码。起始值:1

默认值:1

PageSize Integer 10

分页查询时设置的每页行数。最大值:50

默认值:10

返回数据

名称 类型 示例值 描述
PageSize Integer 1

本页条数。

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

请求ID。

PageNumber Integer 1

当前页码。

TotalCount Integer 1

列表条目总数。

Templates Array of JobTemplates

作业模板信息列表。

JobTemplates
Task Integer 2

单个计算节点所需任务数。可能值:1~1000

Variables String [{Name:,Value:},{Name:,Value:}]

作业的环境变量。

CommandLine String ./LammpsTest/lammps.pbs

执行作业命令。

Queue String workq

作业队列。

Priority Integer 0

作业优先级。可能值:0~9,取值越大,优先级越高。

Mem String 1GB

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

Thread Integer 1

单个任务所需线程数。可能值:1~1000

ArrayRequest String 2-7:2

作业队列。

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

StderrRedirectPath String ./LammpsTest

错误输出路径。

Node Integer 2

提交作业所需计算节点数。可能值:1~500

StdoutRedirectPath String ./Lammps

标准输出路径。

Gpu Integer 1

单个计算节点使用GPU的数量。可能值:1~8。

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

PackagePath String ./jobfolder

执行作业路径。

ClockTime String 12:00:00

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

  • hh:mm:ss
  • mm:ss
  • ss
ReRunable Boolean false

是否支持重新执行作业。可能值:

  • true:支持
  • false:不支持
Name String job1

作业模板名称。

Id String ehpc-job-tmpl-6RxO5y****

作业模板ID。

RunasUser String user1

执行作业的用户名称。

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

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

WithUnzipCmd Boolean true

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

  • true:是
  • false:否
UnzipCmd String tar xzf

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

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

示例

请求示例

http(s)://ehpc.cn-hangzhou.aliyuncs.com/?Action=ListJobTemplates
&Name=jobtemplateName
&PageNumber=1
&PageSize=10
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListJobTemplatesResponse>
    <PageSize>1</PageSize>
    <RequestId>04F0F334-1335-436C-A1D7-6C044FE7****</RequestId>
    <PageNumber>1</PageNumber>
    <TotalCount>1</TotalCount>
    <Templates>
        <Task>2</Task>
        <Variables>[{Name:,Value:},{Name:,Value:}]</Variables>
        <CommandLine>./LammpsTest/lammps.pbs</CommandLine>
        <Queue>workq</Queue>
        <Priority>0</Priority>
        <Mem>1GB</Mem>
        <Thread>1</Thread>
        <ArrayRequest>2-7:2</ArrayRequest>
        <StderrRedirectPath>./LammpsTest</StderrRedirectPath>
        <Node>2</Node>
        <StdoutRedirectPath>./Lammps</StdoutRedirectPath>
        <Gpu>1</Gpu>
        <PackagePath>./jobfolder</PackagePath>
        <ClockTime>12:00:00</ClockTime>
        <ReRunable>false</ReRunable>
        <Name>job1</Name>
        <Id>ehpc-job-tmpl-6RxO5y****</Id>
        <RunasUser>user1</RunasUser>
        <InputFileUrl>https://test.oss-cn-beijing.aliyuncs.com//test.py</InputFileUrl>
        <WithUnzipCmd>true</WithUnzipCmd>
        <UnzipCmd>tar xzf</UnzipCmd>
    </Templates>
</ListJobTemplatesResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PageSize" : 1,
  "RequestId" : "04F0F334-1335-436C-A1D7-6C044FE7****",
  "PageNumber" : 1,
  "TotalCount" : 1,
  "Templates" : [ {
    "Task" : 2,
    "Variables" : "[{Name:,Value:},{Name:,Value:}]",
    "CommandLine" : "./LammpsTest/lammps.pbs",
    "Queue" : "workq",
    "Priority" : 0,
    "Mem" : "1GB",
    "Thread" : 1,
    "ArrayRequest" : "2-7:2",
    "StderrRedirectPath" : "./LammpsTest",
    "Node" : 2,
    "StdoutRedirectPath" : "./Lammps",
    "Gpu" : 1,
    "PackagePath" : "./jobfolder",
    "ClockTime" : "12:00:00",
    "ReRunable" : false,
    "Name" : "job1",
    "Id" : "ehpc-job-tmpl-6RxO5y****",
    "RunasUser" : "user1",
    "InputFileUrl" : "https://test.oss-cn-beijing.aliyuncs.com//test.py",
    "WithUnzipCmd" : true,
    "UnzipCmd" : "tar xzf"
  } ]
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidParams The specified parameter %s is invalid. 无效的参数: %s
403 ConflictOpt A conflicting operation is running. 有冲突的操作在执行中,请您稍后再试。
406 DbError A database service error occurred. 数据库请求失败
406 AliyunError An Alibaba Cloud product error occurred. 阿里云产品错误
407 NotAuthorized You are not authorized by RAM for this request. 此请求未获得RAM授权
500 UnknownError An unknown error occurred. 未知错误,请您稍后再试,若还出现相同的错误请提交工单处理。
503 ServiceUnavailable The request has failed due to a temporary failure of the server 请求失败,服务暂时不可用

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