Help Center/ MapReduce Service/ API Reference/ API V2/ SQL APIs/ Canceling a SQL Execution Task
Updated on 2024-09-30 GMT+08:00
View PDF
Share

Canceling a SQL Execution Task

Function

This API is used to cancel the execution task of a SQL statement in an MRS cluster.

Constraints

None

Debugging

You can debug this API in API Explorer. Automatic authentication is supported. API Explorer can automatically generate sample SDK code and provide the sample SDK code debugging.

URI

POST /v2/{project_id}/clusters/{cluster_id}/sql-execution/{sql_id}/cancel
Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Explanation

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Constraints

N/A

Value range

The value must consist of 1 to 64 characters. Only letters and digits are allowed.

Default value

N/A

cluster_id

Yes

String

Explanation

Cluster ID. If this parameter is specified, the latest metadata of the cluster that has been patched will be obtained. For details on how to obtain the cluster ID, see Obtaining a Cluster ID.

Constraints

N/A

Value range

The value can contain 1 to 64 characters, including only letters, digits, underscores (_), and hyphens (-).

Default value

N/A

sql_id

Yes

String

Explanation

The execution ID of a SQL statement, that is, sql_id in the return result in Submitting a SQL Statement.

Constraints

N/A

Value range

N/A

Default value

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response parameters

Parameter

Type

Description

message

String

Explanation

Error message

Value range

N/A

status

String

Explanation

The result of canceling the execution of the SQL statement. By default, SUCCEED is returned. SUCCEED is also returned when the task is completed. Only when the running SQL statement fails to be canceled, FAILED is returned.

Value range

  • SUCCEED
  • FAILED

Status code: 400

Table 3 Response body parameter

Parameter

Type

Description

message

String

Explanation

Error message

Value range

N/A

status

String

Explanation

The result of canceling the execution of the SQL statement. By default, SUCCEED is returned. SUCCEED is also returned when the task is completed. Only when the running SQL statement fails to be canceled, FAILED is returned.

Value range

  • SUCCEED
  • FAILED

Example Request

Cancel a SQL execution task.

POST https://{endpoint}/v2/{project_id}/clusters/{cluster_id}/sql-execution/{sql_id}/cancel

Example Response

Status code: 200

Canceling a SQL execution task is successful.

{
  "status" : "SUCCEED"
}

Status code: 400

Failed to cancel a SQL execution task.

{
  "status" : "FAILED",
  "message" : "Cancel sql error"
}

Status Codes

See Status Codes.

Error Codes

See Error Codes.

Parent topic: SQL APIs