All Products
Search

This Product

    Elastic High Performance Computing:EditJobTemplate

    Document Center

    Elastic High Performance Computing:EditJobTemplate

    Last Updated:Apr 09, 2024

    Modifies a job template.

    Debugging

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

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    ehpc:EditJobTemplateWRITE
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    TemplateIdstringYes

    The ID of the job template.

    You can call the ListJobTemplates operation to obtain the job template ID.

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

    The command that is used to run the job.

    		./LammpsTest/lammps.pbs
    NamestringYes

    The name of the job template.

    You can call the ListJobTemplates operation to obtain the job template name.

    		jobTemapleteName
    RunasUserstringNo

    The name of the user that runs the job.

    You can call the ListUsers operation to query the users of the cluster.

    		user
    PriorityintegerNo

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

    Default value: 0

    		0
    PackagePathstringNo

    The path that is used to run the job.

    		./packageFolder
    StdoutRedirectPathstringNo

    The output file path of stdout.

    		./LammpsTest
    StderrRedirectPathstringNo

    The output file path of stderr.

    		./Lammps
    ReRunablebooleanNo

    Specifies whether the job can be rerun. Valid values:

    • true: The job can be rerun.
    • false: The job cannot be rerun.
    		false
    ArrayRequeststringNo

    The job array.

    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.

    		1-10:2
    VariablesstringNo

    The runtime variables passed to the job. They can be accessed by using environment variables in the executable file.

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

    The name of the queue.

    		workq
    ClockTimestringNo

    The maximum running time of the job. Valid formats:

    • hh:mm:ss
    • mm:ss
    • ss

    We recommend that you use the hh:mm:ss format. If the maximum running time is 12 hours, set the value to 12:00:00.

    		12:00:00
    NodeintegerNo

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

    Note If the parameter is not specified, the Task, Thread, Mem, and Gpu parameters become invalid.
    		2
    TaskintegerNo

    The number of tasks required by a single compute node. Valid values: 1 to 1000.

    		2
    ThreadintegerNo

    The number of threads required by a single compute node. Valid values: 1 to 1000.

    		1
    MemstringNo

    The maximum memory usage required by a single compute node. Unit: GB, MB, or KB. The unit is case-insensitive.

    		1GB
    GpuintegerNo

    The maximum GPU usage required by a single compute node. 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
    InputFileUrlstringNo

    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
    WithUnzipCmdbooleanNo

    Specifies whether to decompress the job files downloaded from an OSS bucket. Valid values:

    • true: The job files are decompressed.
    • false: The job files are not decompressed.
    		true
    UnzipCmdstringNo

    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

    Response parameters

    ParameterTypeDescriptionExample
    object
    TemplateIdstring

    The ID of the job template.

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

    The ID of the request.

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

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidParamsThe specified parameter %s is invalid.The specified parameter %s is invalid.
    400NotEnabledYou have not enabled this serviceYou have not enabled this service
    400InDebtYour account has overdue payments.Your account has overdue payments.
    403InvalidClusterStatusThe operation failed due to invalid cluster status.The cluster status does not support the operation.
    403ConflictOptA conflicting operation is running.A conflicting operation is running. Please try again later.
    403TemplateNameExistThe template name already exists.The template name already exists.
    403TooMuchTemplatesThe number of templates exceeds the quota.The number of templates exceeds the quota.
    404TemplateNotExistThe template ID does not exist.The template ID does not exist.
    406DbErrorA database service error occurred.Database request failed.
    406AliyunErrorAn Alibaba Cloud product error occurred.An Alibaba Cloud product error occurred.
    407NotAuthorizedYou are not authorized by RAM for this request.The request is not authorized by RAM.
    409PartFailurePart of the batch operation failed.Part of the batch operation failed.
    500UnknownErrorAn unknown error occurred.An unknown error occurred.
    503ServiceUnavailableThe request has failed due to a temporary failure of the serverThe 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 timeSummary of changesOperation
    2021-11-17The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 403
      delete Error Codes: 404
      delete Error Codes: 406
      delete Error Codes: 407
      delete Error Codes: 409
      delete Error Codes: 500
      delete Error Codes: 503
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: InputFileUrl
      Added Input Parameters: WithUnzipCmd
      Added Input Parameters: UnzipCmd