Canceling a Job (Recommended)

Function

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

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:queue:cancelJob	write	queue *	g:EnterpriseProjectId g:ResourceTag/<tag-key>	-	-

URI

• URI format

  DELETE /v1.0/{project_id}/jobs/{job_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.
  job_id	Yes	String	Job ID. You can get the value by calling Submitting a SQL Job (Recommended).

Request Parameters

None

Response Parameters

Example Request

None

Example Response

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

Status Codes

Table 3 describes the status code.

Error Codes

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.