调用ListJobTemplates查询作业模板列表_弹性高性能计算(E-HPC)-阿里云帮助中心

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

调试

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

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
ehpc:ListJobTemplates		全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
Name	string	否	作业模板名称。您可以通过调用 ListJobTemplates 获取模板名称。	jobtemplateName
PageNumber	integer	否	当前页码。起始值：1 默认值：1	1
PageSize	integer	否	分页查询时设置的每页行数。最大值：50 默认值：10	10

返回参数

名称	类型	描述	示例值
	object
PageSize	integer	本页条数。	1
RequestId	string	请求 ID。	04F0F334-1335-436C-A1D7-6C044FE7****
PageNumber	integer	当前页码。	1
TotalCount	integer	列表条目总数。	1
Templates	array<object>	作业模板信息列表。
JobTemplates	object
Task	integer	单个计算节点所需任务数。可能值：1~1000	2
Variables	string	作业的环境变量。	[{Name:,Value:},{Name:,Value:}]
CommandLine	string	执行作业命令。	./LammpsTest/lammps.pbs
Queue	string	作业队列。	workq
Priority	integer	作业优先级。可能值：0~9，取值越大，优先级越高。	0
Mem	string	单个计算节点最大使用内存数。支持 GB、MB、KB，单位不区分大小写。	1GB
Thread	integer	单个任务所需线程数。可能值：1~1000	1
ArrayRequest	string	作业队列。格式为 X-Y:Z，最小值 X 是第一个索引，最大值 Y 是最后一个索引，Z 表示步长，例如 2-7:2，表示作业队列包含编号为 2、4、6 的 3 个子作业。	2-7:2
StderrRedirectPath	string	错误输出路径。	./LammpsTest
Node	integer	提交作业所需计算节点数。可能值：1~500	2
StdoutRedirectPath	string	标准输出路径。	./Lammps
Gpu	integer	单个计算节点使用 GPU 的数量。可能值：1~8。仅支持使用 pbs 调度器的集群，且集群内计算节点含 GPU 时该参数生效。	1
PackagePath	string	执行作业路径。	./jobfolder
ClockTime	string	作业最大运行时间。支持三种格式： hh:mm:ss mm:ss ss	12:00:00
ReRunable	boolean	是否支持重新执行作业。可能值： true：支持 false：不支持	false
Name	string	作业模板名称。	job1
Id	string	作业模板 ID。	ehpc-job-tmpl-6RxO5y****
RunasUser	string	执行作业的用户名称。	user1
InputFileUrl	string	已上传到 OSS 上的作业文件链接。	https://test.oss-cn-beijing.aliyuncs.com/test.py
WithUnzipCmd	boolean	是否解压下载后的作业文件。取值范围： true：是 false：否	true
UnzipCmd	string	解压命令，当 WithUnzipCmd 取值为 true 时，该参数生效。取值范围： tar xzf：解开 gzip 格式压缩包 tar xf：解开 tar 格式压缩包 unzip：解开 zip 格式压缩包	tar xzf

示例

正常返回示例

JSON格式

{
  "PageSize": 1,
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE7****",
  "PageNumber": 1,
  "TotalCount": 1,
  "Templates": {
    "JobTemplates": [
      {
        "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"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
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.	阿里云产品错误。%s
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	请求失败，服务暂时不可用

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

变更历史

变更时间	变更内容概要	操作
2021-11-17	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情