Editing and Modifying Jobs

Function

This API is used to edit and modify jobs.

URI

PUT /v1/{project_id}/modify-job/{job_id}

Table 1 describes the URI parameters.

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 the project ID, see Obtaining a Project ID.

job_id

Yes

String

ID of the job to be modified.

Request

For details, see the request body of the job when it is submitted.

Response

Table 2 describes the response parameters.

Table 2 Response parameters

Parameter

Mandatory

Type

Description

is_success

Yes

Boolean

Whether the request is successful

message

Yes

String

Prompt message

error_code

Yes

String

Error code that indicates a request has failed. This parameter is unavailable when a request is successful.

error_msg

Yes

String

Error message that indicates a request has failed. This parameter is unavailable when a request is successful.

Example

  • Example of a successful response
    {
        "is_success": true,
        "message":"Succeed to modify job!"
    }
  • Example of a failed response
    {
        "is_success": false,
        "error_code": "res.2301",
        "error_msg": "Failed to resolve the token from the request."
    }