Updated on 2022-12-14 GMT+08:00

Canceling a SQL Execution Task

Function

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

URI

  • Format

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

  • Parameter description
    Table 1 URI parameters

    Parameter

    Mandatory

    Description

    project_id

    Yes

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

    cluster_id

    Yes

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

    sql_id

    Yes

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

Request Parameters

Request parameters

None

Response Parameters

Table 2 Response parameters

Parameter

Type

Description

status

String

The result of canceling the execution of the SQL statement. Possible values:

  • 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

The error message.

Example

  • Example request
    POST https://{endpoint}/v2/{project_id}/clusters/{cluster_id}/sql-execution/{sql_id}/cancel
  • Example response
    • Example of a successful response
      {
          "status":"SUCCEED"
       }
    • Example of a failed response
      { 
          "status":"FAILED",
          "message":"Cancel sql error"
       }

Status Codes

See Status Codes.

Error Codes

See Error Codes.