Cancel query

Prev Next

Available in VPC

Cancel query execution.

Request

This section describes the request format. The method and URI are as follows:

Method URI
DELETE /api/v2/queries/{executionId}

Request headers

For information about the headers common to all Data Query APIs, see Data Query request headers.

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
executionId String Required Execution ID

Request example

The request example is as follows:

curl --location --request DELETE 'https://kr.dataquery.naverncp.com/api/v2/queries/20e7fe40-****-****-****-f37605aa5241' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
id String - Execution ID
columns Array - Column information
  • [] (valid value for execution cancellation)
data Array - Query response value
  • [] (valid value for execution cancellation)
offset Long - Offset to use for page query
  • If isFinished is false, use it for the next page query request.
isFinished Boolean - Whether all pages have been queried
  • true | false
    • true: Completed (Next page does not exist.)
    • false: Incomplete (Next page exists.)

Response status codes

For information about the HTTP status codes common to all Data Query APIs, see Data Query response status codes.

Response example

The response example is as follows:

{
    "id": "20e7fe40-****-****-****-f37605aa5241",
    "columns": [],
    "data": [],
    "offset": 0,
    "isFinished": true
}