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 through automatic authentication in API Explorer. API Explorer can automatically generate sample SDK code and provide the sample SDK code debugging.

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

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.