ListJobTemplates_作业模板管理_API 参考_弹性高性能计算E-HPC-阿里云

查询作业模板列表。

描述

用户可以进行作业模板列表的查询。有关作业模板的使用，请参阅作业模板管理。

请求参数

字段	类型	是否必须	默认值	描述
Action	String	是	-	操作接口名，系统规定参数，取值：`ListJobTemplates`
RegionId	String	是	-	地域ID
Uid	String	是	-	用户ID
Name	String	否	-	作业模板名称
PageNumber	Integer	否	1	当前页码
PageSize	Integer	否	10	本页条数

返回参数

除公共返回参数外返回如下结果：

字段	类型	描述
Templates	Array<JobTemplates>	作业模板信息数组，JobTemplates结构见下面的对象描述
TotalCount	Integer	列表条目总数
PageNumber	Integer	当前页码
PageSize	Integer	本页条数

其中，每个JobTemplates结构包含以下字段：

字段	取值	描述
Id	String	作业模板ID
CommandLine	String	作业命令
Name	String	作业模板名称
RunasUser	String	作业owner
Priority	String	作业优先级
PackagePath	String	作业命令所在目录
StdoutRedirectPath	String	stdout输出目录
StderrRedirectPath	String	stderr输出目录
ReRunable	Boolean	作业是否支持rerun
ArrayRequest	String	队列作业，格式是：1-10:2
Variables	String	作业的环境变量，格式是：[{Name:,Value:},{Name:,Value:}]

示例

请求示例

https://ehpc.cn-hangzhou.aliyuncs.com/?Action=ListJobTemplates&RegionId=cn-hangzhou&Uid=<用户ID>&<公共请求参数>

返回示例

XML格式

<ListJobTemplatesResponse>
    <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
    <TotalCount>1</TotalCount>
    <PageNumber>1</PageNumber>
    <PageSize>1</PageSize>
    <Templates>
        <JobTemplates>
            <Name>LammpsTestPbs</Name>
            <RunasUser>alibaba</RunasUser>
            <CommandLine>./LammpsTest/lammps.pbs</CommandLine>
            <StdoutRedirectPath>./LammpsTest</StdoutRedirectPath>
            <Id>ehpc-job-tmpl-6RxO5yVcMK</Id>
            <ReRunable>false</ReRunable>
            <StderrRedirectPath>./LammpsTest</StderrRedirectPath>
            <Priority>0</Priority>
        </JobTemplates>
    </Templates>
</ListJobTemplatesResponse>

JSON格式

{
    "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
    "TotalCount": 1,
    "PageNumber": 1,
    "PageSize": 1,
    "Templates": {
        "JobTemplates": [
            {
                "Name": "LammpsTestPbs",
                "RunasUser": "alibaba",
                "CommandLine": "./LammpsTest/lammps.pbs",
                "StdoutRedirectPath": "./LammpsTest",
                "Id": "ehpc-job-tmpl-6RxO5yVcMK",
                "ReRunable": false,
                "StderrRedirectPath": "./LammpsTest",
                "Priority": 0,
            }
        ]
    }
}

错误码

查询E-HPC接口错误码请访问错误码。更多错误码，请访问 API 错误中心。