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.
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¶
None
Response¶
Parameter | Mandatory | Type | Description |
|---|---|---|---|
is_success | No | Boolean | 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 Request¶
None
Example Response¶
{
"is_success": true,
"message": ""
}
Status Codes¶
Table 3 describes the status code.
Status Code | Description |
|---|---|
200 | Canceled. |
400 | Request error. |
500 | Internal service error. |
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.