Cancel Query

delete https://api.{region}.rockset.com/v1/orgs/self/queries/{queryId}

Attempts to cancel an actively-running query.

Responses

Response body

object

data

object

destination_uri

string

destination for query results. Only populated for Insert INTO s3 queries.

executed_by

string

User ID who executed the query.

expires_at

string

Time (UTC) that query results expire. Only populated if status is COMPLETE.

last_offset

string

The log offset that query results were written to in the destination collection. Only populated for INSERT INTO queries.

pagination

object

Information for fetching query results pages. Only populated if status is COMPLETE.

query_errors

array of objects

Errors encountered while executing the query.

query_errors

object

message

string

A message associated with the error, containing more information about it.

status_code

int32

The HTTP status code associated with this error, had it been sent as the response status code

type

string

The type of error.

query_id

string

Unique Query ID.

select_command_completed

boolean

Whether this query has completed the SELECT command. Only populated for INSERT INTO queries.

sql

string

The SQL query for this request

stats

object

Various stats about the query's execution.

status

string

Status of the query.

QUEUED RUNNING COMPLETED ERROR CANCELLED

submitted_at

string

Time (UTC) the query request was first received and queued for execution.

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request DELETE \
2
     --url https://api.usw2a1.rockset.com/v1/orgs/self/queries/queryId \
3
     --header 'Authorization: ApiKey YOUR_ROCKSET_KEY' \
4
     --header 'accept: application/json'


xxxxxxxxxx
30
}
1
{
2
  "data": {
3
    "destination_uri": "string",
4
    "executed_by": "xyz@rockset.com",
5
    "expires_at": "2001-08-28T00:23:41Z",
6
    "last_offset": "string",
7
    "pagination": {
8
      "start_cursor": "vZNDIBi_E_cIwjo8ZbFl7XcxXxd4VfwjB7Q5CF6tplw0RqNgyG7q4sPuHUTBhYnrg"
9
    },
10
    "query_errors": [
11
      {
12
        "message": "Too many rows",
13
        "status_code": 429,
14
        "type": "ResourceExceeded"
15
      }
16
    ],
17
    "query_id": "5b596206-c632-4a08-8343-0c560f7ef7f1",
18
    "select_command_completed": true,
19
    "sql": "string",
20
    "stats": {
21
      "elapsed_time_ms": 128,
22
      "result_set_bytes_size": 1235,
23
      "result_set_document_count": 1235,
24
      "result_set_file_count": 1235,
25
      "throttled_time_ms": 16

200Successfully canceled query

400bad request

401unauthorized

403forbidden

404not found

405not allowed

406not acceptable

408request timeout

409conflict

415not supported

429resource exceeded

500internal error

501not implemented

502bad gateway

503not ready