SQL 쿼리 상태 조회(Get Status SQL Query) (V2)

제출한 SQL 쿼리의 상태를 조회합니다. 쿼리를 실행한 사용자의 토큰으로 요청합니다.

쿼리 매개변수와 요청 본문은 없습니다. 응답은 type으로 구분하는 QueryStatus입니다.

상태 응답은 결과 데이터가 아닙니다. 성공한 쿼리의 데이터는 결과 조회로 가져옵니다. queryId의 원래 값과 URL 인코딩한 값을 구분합니다.

HTTP 요청

GET /api/v2/sqlQueries/{sqlQueryId}/getStatus

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

오류

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

요청 예제

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

cURL

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

Python

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

import os
import requests

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

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

Java

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

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

public class GetStatusSqlQueryExample {
    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()) {
            HttpGet request = new HttpGet("https://" + HOSTNAME + "/api/v2/sqlQueries/" + System.getenv("SQL_QUERY_ID_URL_ENCODED") + "/getStatus");
            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}/getStatus`, {
    method: 'GET',
    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}/getStatus" `
	-Headers $headers

$response.content