Help Center> MapReduce Service> API Reference> API V2> SQL APIs> Cancel an SQL Execution Task
View PDF

Cancel an SQL Execution Task

Function

This API is used to cancel the execution task of an SQL statement in the MRS cluster. MRS 1.9.2 or later supports this API.

URI

  • Format

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

  • Parameter description
    Table 1 URI parameter description

    Parameter

    Mandatory

    Description

    project_id

    Yes

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

    cluster_id

    Yes

    Cluster ID. For details on how to obtain the cluster ID, see Obtaining a Cluster ID.

    sql_id

    Yes

    SQL execution ID, that is, sql_id in the return result in Submitting an SQL Statement.

Request

Request parameters

None.

Response

Table 2 Response parameter description

Parameter

Type

Description

status

String

The result of SQL cancelation

  • SUCCEED: successful
  • FAILED: failed
NOTE:

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.

message

String

Error message

Example

  • Example request

    None.

  • Example response
    • Example of a successful response 
      {
    "status":"SUCCEED"
 }
    • Example of a failed response 
      { 
    "status":"FAILED",
    "message":"Cancel sql error"
 }

Status Code

For details about status codes, see Status Codes.

Parent topic: SQL APIs