リクエスト

リクエスト URL

POST {DATA_QUERY API_URL}/queries

リクエストパラメータ

パラメータ名	必須の有無	タイプ	制限事項	説明
query	Yes	String		実行するクエリ
projectId	No	Integer		Queryを実行する Projectの ID
timeout	No	int	最大値: 60	クエリの最大実行時間(単位: 秒) デフォルト: 20秒
isReuse	No	boolean		クエリ結果を再利用するかどうかデフォルト: false
reuseMaxAge	No	int	最大値: 10080	クエリ結果を再利用する最大ライフスタイル(単位: 分) 「60分」と入力すると、クエリ実行から60分前に返すことのできる有効な結果がある場合に結果を再利用デフォルト: 60分(1時間)
dataSource	No	String		クエリを実行する基本 Data Source
database	No	String		クエリを実行する基本 Database

リクエストヘッダ

共通ガイドを参照

リクエスト例

curl -X POST "https://kr.dataquery.naverncp.com/api/v2/queries \
    -H "Content-Type:application/json" \
    -H "x-ncp-apigw-timestamp: {x-ncp-apigw-timestamp}" \
    -H "x-ncp-iam-access-key: {x-ncp-iam-access-key}"  \
    -H "x-ncp-apigw-signature-v2: {x-ncp-apigw-signature-v2}"
    -d \
    '{
        "query": "SELECT * FROM public_data.korea_trade_insurance.exchange_rate LIMIT 2",
        "timeout": 20,
        "isReuse": true,
        "reuseMaxAge": 60
    }'

レスポンス

レスポンスボディ

項目	タイプ	説明
id	String	Query ID
columns	Column	Column情報
data	List<List<Object>>	Queryのレスポンス値
offset	long	クエリ offset、次のレスポンス照会時に offsetの伝達が必要
isFinished	boolean	クエリ結果がすべて返されたかどうか

Column

項目	タイプ	説明
name	String	Column名
type	String	Columnのタイプ
typeSignature	ClientTypeSignature

ClientTypeSignature

項目	タイプ	説明
rawType	String
arguments	List<ClientTypeSignatureParameter>

ClientTypeSignatureParameter

項目	タイプ	説明
kind	String	ENUMの値: TYPE、NAMED_TYPE、LONG、VARIABLE
value	Object

レスポンス例

HTTP

HTTP Status	Description
200	OK

JSON

{
  "id":"75b1b1bf-e808-456d-aa45-f74aaff0b0a4",
  "columns":[
    {
      "name":"currency_code",
      "type":"varchar",
      "typeSignature":{
        "rawType":"varchar",
        "arguments":[
          {
            "kind":"LONG",
            "value":2147483647
          }]
      }
    },
    {
      "name":"date",
      "type":"varchar",
      "typeSignature":{
        "rawType":"varchar",
        "arguments":[
          {
            "kind":"LONG",
            "value":2147483647
          }]
      }
    },
    {
      "name":"trade_rate",
      "type":"varchar",
      "typeSignature":{
        "rawType":"varchar",
        "arguments":[
          {
            "kind":"LONG",
            "value":2147483647
          }]
      }
    },
    {
      "name":"us_conversion_rate",
      "type":"varchar",
      "typeSignature":{
        "rawType":"varchar",
        "arguments":[
          {
            "kind":"LONG",
            "value":2147483647
          }]
      }
    }],
  "data":[
    [
      "CNY",
      "1995.10.25",
      "92.13",
      "0.1203"],
    [
      "CNY",
      "1995.10.24",
      "92.13",
      "0.1203"]],
  "offset":121,
  "isFinished":true
}

この記事は役に立ちましたか?

リクエスト
レスポンス
- レスポンスボディ
- レスポンス例

タグ

Data Catalog