Updated on 2026-01-08 GMT+08:00

Modifying a Job Template

Function

This API is used to modify a job template.

Authorization

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see the required permissions in Introduction.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependency

    dli:template:update

    write

    template *

    -

    -

    -

URI

  • URI format

    PUT /v3/{project_id}/templates/{template_id}

  • Parameter description
    Table 1 URI parameters

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID, which is used for resource isolation. For details about how to obtain its value, see Obtaining a Project ID.

    template_id

    Yes

    String

    Template ID.

Request Parameters

Table 2 Parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Template name

body

Yes

String

Template content

group

No

String

Template group

description

No

String

Description of the template

Response Parameters

Table 3 Parameters

Parameter

Type

Description

is_success

Boolean

Whether the request is successfully executed. Value true indicates that the request is successfully executed.

message

String

System prompt. If execution succeeds, the message may be left blank.

Example Request

Modify the name and content of a job template.

{  
   "name": "test1",
   "body":"ss"
 }

Example Response

{ 
  "is_success": true, 
  "message": "" 
 }

Status Codes

Status Code

Description

200

OK

Error Codes

For details, see Error Codes.