SQL 쿼리 취소(Cancel SQL Query) (V2)

실행 중인 SQL 쿼리를 취소합니다. 쿼리가 더 이상 실행 중이 아니면 추가 상태 변경을 하지 않습니다. 쿼리를 실행한 사용자만 해당 쿼리를 조작할 수 있습니다.

쿼리 매개변수와 요청 본문은 없습니다. 성공 응답에는 반환 본문이 정의되어 있지 않으므로 JSON 상태 객체를 파싱하는 호출로 사용하지 않습니다. 상태가 필요하면 Get Status로 조회합니다.

HTTP 요청

POST /api/v2/sqlQueries/{sqlQueryId}/cancel

작업 식별자는 v2.cancelSqlQuery입니다. Authorization: Bearer <접근 토큰> 헤더로 인증합니다. OAuth 클라이언트에는 api:sql-queries-execute 권한 범위가 필요합니다.

오류

실패 응답은 공통 오류 형식을 따릅니다.

요청 예제

FOUNDRY_HOST에는 https://를 제외한 Foundry 호스트를, FOUNDRY_TOKEN에는 유효한 토큰을 환경 변수로 제공합니다. SQL_QUERY_ID_URL_ENCODED에는 쿼리 응답의 queryId를 경로 조각으로 퍼센트 인코딩한 값을 제공합니다.

cURL

curl -X POST \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/sqlQueries/${SQL_QUERY_ID_URL_ENCODED}/cancel"

Python

Requests 라이브러리가 설치된 Python 환경에서 사용합니다.

import os
import requests

HOSTNAME = os.environ["FOUNDRY_HOST"]
TOKEN = os.environ["FOUNDRY_TOKEN"]
headers = {
    "authorization": "Bearer {}".format(TOKEN)
}

response = requests.post('https://{}/api/v2/sqlQueries/{}/cancel'.format(HOSTNAME, os.environ["SQL_QUERY_ID_URL_ENCODED"]), headers=headers)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용하는 예제입니다. 클래스 이름에 맞는 CancelSqlQueryExample.java 파일에서 사용합니다.

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;

public class CancelSqlQueryExample {
    public static void main(String[] args) throws Exception {
        String HOSTNAME = System.getenv("FOUNDRY_HOST");
        String TOKEN = System.getenv("FOUNDRY_TOKEN");

        try (CloseableHttpClient httpClient = HttpClientBuilder.create().build()) {
            HttpPost request = new HttpPost("https://" + HOSTNAME + "/api/v2/sqlQueries/" + System.getenv("SQL_QUERY_ID_URL_ENCODED") + "/cancel");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            try (CloseableHttpResponse response = httpClient.execute(request)) {
                System.out.println(response);
            }
        }
    }
}

JavaScript

fetch를 제공하는 Node.js 환경에서 사용합니다. 서비스 사용자 토큰을 브라우저로 전달하지 않습니다.

const HOSTNAME = process.env.FOUNDRY_HOST;
const TOKEN = process.env.FOUNDRY_TOKEN;

fetch(`https://${HOSTNAME}/api/v2/sqlQueries/${process.env.SQL_QUERY_ID_URL_ENCODED}/cancel`, {
    method: 'POST',
    headers: {
        'Authorization': `Bearer ${TOKEN}`,
    }
}).then((response) => {
    console.log(response)
});

PowerShell

$TOKEN = $env:FOUNDRY_TOKEN
$HOSTNAME = $env:FOUNDRY_HOST

$headers = @{
    "authorization" = "Bearer $TOKEN"
}

$response = Invoke-WebRequest -Uri "https://$HOSTNAME/api/v2/sqlQueries/${env:SQL_QUERY_ID_URL_ENCODED}/cancel" `
	-Method Post `
	-Headers $headers

$response.content