ListJobTemplates - Elastic High Performance Computing - Alibaba Cloud Documentation Center

Queries the list of job templates.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ehpc:ListJobTemplates	READ	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
Name	string	No	The name of the job template. You can call the ListJobTemplates operation to obtain the job template name.	jobtemplateName
PageNumber	integer	No	The page number to return. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return per page. Maximum value: 50. Default value: 10.	10

Response parameters

Parameter	Type	Description	Example
	object
PageSize	integer	The number of entries returned per page.	1
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE7****
PageNumber	integer	The page number returned.	1
TotalCount	integer	The total number of returned entries.	1
Templates	object []	The list of job templates.
Task	integer	The number of tasks required by a single compute node. Valid values: 1 to 1000.	2
Variables	string	The environment variables of the job.	[{Name:,Value:},{Name:,Value:}]
CommandLine	string	The command that is used to run the job.	./LammpsTest/lammps.pbs
Queue	string	The queue of the job.	workq
Priority	integer	The priority of the job. Valid values: 0 to 9. A larger value indicates a higher priority.	0
Mem	string	The maximum memory usage of a single compute node. The unit can be GB, MB, or KB, and is case-insensitive.	1GB
Thread	integer	The number of threads required by a single task. Valid values: 1 to 1000.	1
ArrayRequest	string	The queue of the job. Format: X-Y:Z. X is the minimum index value. Y is the maximum index value. Z is the step size. For example, 2-7:2 indicates that three jobs need to be run and their index values are 2, 4, and 6.	2-7:2
StderrRedirectPath	string	The output file path of stderr.	./LammpsTest
Node	integer	The number of compute nodes. Valid values: 1 to 500.	2
StdoutRedirectPath	string	The output file path of stdout.	./Lammps
Gpu	integer	The maximum GPU usage for individual compute nodes. Valid values: 1 to 8. The parameter takes effect only when the cluster uses PBS and a compute node is a GPU-accelerated instance.	1
PackagePath	string	The path that is used to run the job.	./jobfolder
ClockTime	string	The maximum running time of the job. Valid formats: hh:mm:ss mm:ss ss	12:00:00
ReRunable	boolean	Specifies whether the job can be rerun. Valid values: true: The job can be rerun. false: The job cannot be rerun.	false
Name	string	The name of the job template.	job1
Id	string	The ID of the job template.	ehpc-job-tmpl-6RxO5y****
RunasUser	string	The name of the user that runs the job.	user1
InputFileUrl	string	The URL of the job files that are uploaded to an Object Storage Service (OSS) bucket.	https://test.oss-cn-beijing.aliyuncs.com/test.py
WithUnzipCmd	boolean	Specifies whether to decompress the job files downloaded from an OSS bucket. Valid value: true: decompresses the job file. false: does not decompress the job file.	true
UnzipCmd	string	The command that is used to decompress the job files downloaded from an OSS bucket. The parameter takes effect only when WithUnzipCmd is set to true. Valid values: tar xzf: decompresses GZIP files. tar xf: decompresses TAR files. unzip: decompresses ZIP files.	tar xzf

Examples

Sample success responses

JSONformat

{
  "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"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParams	The specified parameter %s is invalid.	The specified parameter %s is invalid.
403	ConflictOpt	A conflicting operation is running.	A conflicting operation is running. Please try again later.
406	DbError	A database service error occurred.	Database request failed.
406	AliyunError	An Alibaba Cloud product error occurred.	An Alibaba Cloud product error occurred.
407	NotAuthorized	You are not authorized by RAM for this request.	The request is not authorized by RAM.
500	UnknownError	An unknown error occurred.	An unknown error occurred.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server	The request has failed due to a temporary failure of the server.

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2021-11-17

The Error code has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 403
	delete Error Codes: 406
	delete Error Codes: 407
	delete Error Codes: 500
	delete Error Codes: 503
Output Parameters	The response structure of the API has changed.