クエリのキャンセル

VPC環境で利用できます。

クエリの実行をキャンセルします。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
DELETE	/api/v2/queries/{executionId}

リクエストヘッダ

Data Query APIで共通して使用されるヘッダの詳細は、Data Queryのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`executionId`	String	Required	実行 ID クエリ履歴の照会を参照

リクエスト例

リクエストのサンプルコードは次の通りです。

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}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`id`	String	-	実行 ID
`columns`	Array	-	カラム情報 `[]` (実行キャンセル時の有効値)
`data`	Array	-	クエリのレスポンス値 `[]` (実行キャンセル時の有効値)
`offset`	Long	-	ページ照会に使用するオフセット `isFinished`が`false`の場合、次のページ照会のリクエストに使用
`isFinished`	Boolean	-	全ページ照会が完了しているか `true` \| `false` `true`: 完了 (次のページが存在しない) `false`: 完了していない (次のページが存在)

レスポンスステータスコード

Data Query APIで共通して使用されるレスポンスステータスコードの詳細は、Data Queryのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

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