Help Center> RES> API Reference> APIs (Old Version)> Job-related APIs> Terminating Operators
View PDF

Terminating Operators

Function

This API is used to terminate the running operators.

URI

DELETE /v1/{project_id}/terminate-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

Training job ID

Request

N/A

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 terminate job!"
}
  • Example of a failed response 
    {
    "is_success": false,
    "error_code": "res.1008",
    "error_msg": "The request parameter(job_id) is null."
}

Status Code

For details about status codes, see Status Codes.

Parent topic: Job-related APIs