All Products
Search
Document Center

Elastic High Performance Computing:CreateJobTemplate

Last Updated:Oct 26, 2026

Creates a job template.

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:CreateJobTemplate

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

CommandLine

string

Yes

The command to run the job.

./LammpsTest/lammps.pbs

Name

string

Yes

The name of the job template. The name must be 2 to 64 characters in length. It must start with a letter and can contain digits, hyphens (-), and underscores (_).

jobtemplate1

RunasUser

string

No

The username used to run the job.

You can call the ListUsers operation to obtain the username.

user1

Priority

integer

No

The priority of the job. Valid values: 0 to 9. A larger value indicates a higher priority.

Default value: 0.

0

PackagePath

string

No

The path to run the job.

./jobfolder

StdoutRedirectPath

string

No

The standard output path.

./LammpsTest

StderrRedirectPath

string

No

The error output path.

./LammpsTest

ReRunable

boolean

No

Specifies whether to automatically retry the job after a failure. Valid values:

  • true: Supported.

  • false: Not supported.

false

ArrayRequest

string

No

The job array.

The format is X-Y:Z, where X is the first index, Y is the last index, and Z is the step size. For example, 2-7:2 indicates that the job array contains three sub-jobs numbered 2, 4, and 6.

1-10:2

Variables

string

No

The environment variables for running the job. You can access the environment variables in the job execution file.

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

Queue

string

No

The name of the queue used to run the job.

You can call the ListQueues operation to obtain the queue name.

workq

ClockTime

string

No

The maximum runtime of the job. Three formats are supported:

  • hh:mm:ss

  • mm:ss

  • ss

The first format is recommended. For example, if the maximum runtime is 12 hours, set the value to 12:00:00.

12:00:00

Node

integer

No

The number of compute nodes required to submit the job. Valid values: 1 to 500.

Note

If this parameter is left empty, the Task, Thread, Mem, and Gpu parameters do not take effect.

2

Task

integer

No

The number of tasks required per compute node. Valid values: 1 to 1000.

2

Thread

integer

No

The number of threads required per task. Valid values: 1 to 1000.

1

Mem

string

No

The maximum memory usage per compute node. The unit can be GB, MB, or KB, and is not case-sensitive.

1GB

Gpu

integer

No

The number of GPUs used by a single compute node. Valid values: 1 to 8.

This parameter takes effect only for clusters that use the PBS scheduler and contain compute nodes with GPUs.

1

InputFileUrl

string

No

The URL of the job file uploaded to OSS.

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

WithUnzipCmd

boolean

No

Specifies whether to decompress the downloaded job file. Valid values:

  • true: yes

  • false: no

true

UnzipCmd

string

No

The decompression command. This parameter takes effect when WithUnzipCmd is set to true. Valid values:

  • tar xzf: decompresses gzip archives

  • tar xf: decompresses tar archives

  • unzip: decompresses zip archives

tar xzf

Response elements

Element

Type

Description

Example

object

TemplateId

string

The ID of the job template.

ehpc-job-tmpl-6RxO5y****

RequestId

string

The ID of the request.

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

Examples

Success response

JSON format

{
  "TemplateId": "ehpc-job-tmpl-6RxO5y****",
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE7****"
}

Error codes

HTTP status code

Error code

Error message

Description

400 InvalidParams The specified parameter %s is invalid. The specified parameter %s is invalid.
400 NotEnabled You have not enabled this service You have not enabled this service
400 InDebt Your account has overdue payments. Your account has overdue payments.
500 UnknownError An unknown error occurred. An unknown error occurred.
403 InvalidClusterStatus The operation failed due to invalid cluster status. The cluster status does not support the operation.
403 ConflictOpt A conflicting operation is running. A conflicting operation is running. Please try again later.
403 TemplateNameExist The template name already exists. The template name already exists.
403 TooMuchTemplates The number of templates exceeds the quota.
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.
409 PartFailure Part of the batch operation failed. Part of the batch operation failed.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.