Query job templates by calling ListJobTemplates - Elastic High Performance Computing - Alibaba Cloud - Elastic High Performance Computing

Queries the list of job templates.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ehpc:ListJobTemplates

*All Resource

*

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 elements

Element	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
JobTemplates	array<object>	The list of job templates.
	object
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

Success response

JSON format

{
  "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.
500	UnknownError	An unknown error occurred.	An unknown error occurred.
403	ConflictOpt	A conflicting operation is running.	A conflicting operation is running. Please try again later.
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.
406	DbError	A database service error occurred.	Database request failed.
406	AliyunError	An Alibaba Cloud product error occurred.	Alibaba Cloud product error. %s
407	NotAuthorized	You are not authorized by RAM for this request.	The request is not authorized by RAM.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.