Available in VPC
Run a query asynchronously.
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
POST | /api/v2/queries/async |
Request headers
For information about the headers common to all Data Query APIs, see Data Query request headers.
Request body
You can include the following data in the body of your request:
Field | Type | Required | Description |
---|---|---|---|
query |
String | Required | Execution query statement |
executionParameters |
Array | Optional | Query execution parameter |
isReuse |
Boolean | Optional | Whether to reuse query results
|
reuseMaxAge |
Integer | Conditional | Time allowed to reuse query results (minute)
|
dataSource |
String | Optional | Query execution data source name |
database |
String | Optional | Query execution database name |
Request example
The request example is as follows:
curl --location --request POST 'https://kr.dataquery.naverncp.com/api/v2/queries/async' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
"query": "SELECT * FROM public_data.korea_trade_insurance.exchange_rate",
"isReuse": false
}'
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
|
data |
Array | - | Query execution result
|
offset |
Long | - | Offset to use for page query
|
isFinished |
Boolean | - | Whether all pages have been queried
|
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": "dc82c8a8-****-****-****-990cb114e172",
"columns": [],
"data": [],
"offset": 0,
"isFinished": false
}