Updated on 2023-11-27 GMT+08:00

Canceling a Job (Discarded)

Function

This API is used to cancel a submitted job. If execution of a job completes or fails, this job cannot be canceled.

This API has been discarded and is not recommended.

URI

  • URI format

    DELETE /v1.0/{project_id}/queues/{queue_name}/jobs/{job_id}

  • Parameter description
    Table 1 URI parameters

    Parameter

    Mandatory

    Description

    project_id

    Yes

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

    queue_name

    Yes

    Name of the queue where the job to be canceled resides.

    job_id

    Yes

    Job ID.

Request

None

Response

Table 2 Response parameters

Parameter

Mandatory

Type

Description

is_success

No

Boolean

Indicates whether the request is successfully executed. Value true indicates that the request is successfully executed.

message

No

String

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

Example

  • Example request
    None
  • Example response (successful request)
    {
      "is_success": true,
      "message": ""
    }

    If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Codes.