Time Series Database:HTTP API

SELECT クエリの実行

curl -G 'https://<domain-name>:3242/query?db=mydb&u=<username>&p=<password>' \
  --data-urlencode 'q=SELECT * FROM "mymeas"'

レスポンス：

{"results":[{"statement_id":0,"series":[{"name":"mymeas","columns":["time","myfield","mytag1","mytag2"],"values":[["2017-03-01T00:17:18Z",12.4,"12","14"]]}]}]}

CLI での同じデータ：

name: mymeas
time                  myfield  mytag1  mytag2
----                  -------  ------  ------
2017-03-01T00:16:18Z  33.1
2017-03-01T00:17:18Z  12.4     12      14

SELECT ... INTO クエリの実行

SELECT ... INTO は結果を新しいメジャメントに書き込み、POST が必要です：

curl -XPOST 'https://<domain-name>:3242/query?db=mydb&u=<username>&p=<password>' \
  --data-urlencode 'q=SELECT * INTO "newmeas" FROM "mymeas"'

レスポンス：

{"results":[{"statement_id":0,"series":[{"name":"result","columns":["time","written"],"values":[["1970-01-01T00:00:00Z",2]]}]}]}

2 つのポイントが newmeas に書き込まれました。タイムスタンプ 1970-01-01T00:00:00Z (エポック 0) は null タイムスタンプに使用されます。

整形出力された JSON の返却

curl -G 'https://<domain-name>:3242/query?db=mydb&pretty=true&u=<username>&p=<password>' \
  --data-urlencode 'q=SELECT * FROM "mymeas"'

レスポンス：

{
    "results": [
        {
            "statement_id": 0,
            "series": [
                {
                    "name": "mymeas",
                    "columns": ["time", "myfield", "mytag1", "mytag2"],
                    "values": [
                        ["2017-03-01T00:16:18Z", 33.1, null, null],
                        ["2017-03-01T00:17:18Z", 12.4, "12", "14"]
                    ]
                }
            ]
        }
    ]
}

エポックタイムスタンプの返却

curl -G 'https://<domain-name>:3242/query?db=mydb&epoch=s&u=<username>&p=<password>' \
  --data-urlencode 'q=SELECT * FROM "mymeas"'

レスポンス：

{"results":[{"statement_id":0,"series":[{"name":"mymeas","columns":["time","myfield","mytag1","mytag2"],"values":[[1488327378,33.1,null,null],[1488327438,12.4,"12","14"]]}]}]}

複数クエリの送信

クエリはセミコロンで区切ります。レスポンス内の各結果は、0 から始まる statement_id によって識別されます。

curl -G 'https://<domain-name>:3242/query?db=mydb&epoch=s&u=<username>&p=<password>' \
  --data-urlencode 'q=SELECT * FROM "mymeas";SELECT mean("myfield") FROM "mymeas"'

レスポンス：

{"results":[{"statement_id":0,"series":[{"name":"mymeas","columns":["time","myfield","mytag1","mytag2"],"values":[[1488327378,33.1,null,null],[1488327438,12.4,"12","14"]]}]},{"statement_id":1,"series":[{"name":"mymeas","columns":["time","mean"],"values":[[0,22.75]]}]}]}

CSV 出力のリクエスト

curl -H "Accept: application/csv" \
  -G 'https://<domain-name>:3242/query?db=mydb&u=<username>&p=<password>' \
  --data-urlencode 'q=SELECT * FROM "mymeas"'

レスポンス：

name,tags,time,myfield,mytag1,mytag2
mymeas,,1488327378000000000,33.1,mytag1,mytag2
mymeas,,1488327438000000000,12.4,12,14

空のタグ列は空白で表示されます。タイムスタンプはエポックナノ秒です。

ファイルからのクエリ送信

curl -F "q=@queries.txt" -F "async=true" \
  'https://<domain-name>:3242/query?u=<username>&p=<password>'

queries.txt の例：

SELECT * FROM "mymeas";
SELECT mean("myfield") FROM "mymeas";

タグ値パラメーターのバインド

curl -G 'https://<domain-name>:3242/query?db=mydb&u=<username>&p=<password>' \
  --data-urlencode 'q=SELECT * FROM "mymeas" WHERE "mytag1" = $tag_value' \
  --data-urlencode 'params={"tag_value":"12"}'

レスポンス：

{"results":[{"statement_id":0,"series":[{"name":"mymeas","columns":["time","myfield","mytag1","mytag2"],"values":[["2017-03-01T00:17:18Z",12.4,"12","14"]]}]}]}

$tag_value は "12" にマップされます。タグ値は文字列として保存され、ダブルクォーテーションで囲む必要があります。

数値フィールド値パラメーターのバインド

curl -G 'https://<domain-name>:3242/query?db=mydb&u=<username>&p=<password>' \
  --data-urlencode 'q=SELECT * FROM "mymeas" WHERE "myfield" > $field_value' \
  --data-urlencode 'params={"field_value":30}'

レスポンス：

{"results":[{"statement_id":0,"series":[{"name":"mymeas","columns":["time","myfield","mytag1","mytag2"],"values":[["2017-03-01T00:16:18Z",33.1,null,null]]}]}]}

$field_value は 30 にマップされます。数値に引用符は不要です。

複数パラメーターのバインド

curl -G 'https://<domain-name>:3242/query?db=mydb&u=<username>&p=<password>' \
  --data-urlencode 'q=SELECT * FROM "mymeas" WHERE "mytag1" = $tag_value AND "myfield" < $field_value' \
  --data-urlencode 'params={"tag_value":"12","field_value":30}'

レスポンス：

{"results":[{"statement_id":0,"series":[{"name":"mymeas","columns":["time","myfield","mytag1","mytag2"],"values":[["2017-03-01T00:17:18Z",12.4,"12","14"]]}]}]}

例

成功したクエリ：

curl -i -G 'https://<domain-name>:3242/query?db=mydb&u=<username>&p=<password>' \
  --data-urlencode 'q=SELECT * FROM "mymeas"'

HTTP/1.1 200 OK
Content-Type: application/json
X-Influxdb-Version: 1.7.x
Transfer-Encoding: chunked

{"results":[{"statement_id":0,"series":[{"name":"mymeas","columns":["time","myfield","mytag1","mytag2"],"values":[["2017-03-01T00:16:18Z",33.1,null,null],["2017-03-01T00:17:18Z",12.4,"12","14"]]}]}]}

存在しないデータベースを参照するクエリも 200 を返しますが、エラーは JSON ボディに含まれます：

curl -i -G 'https://<domain-name>:3242/query?db=mydb1&u=<username>&p=<password>' \
  --data-urlencode 'q=SELECT * FROM "mymeas"'

HTTP/1.1 200 OK
...
{"results":[{"statement_id":0,"error":"database not found: mydb1"}]}

不正な形式のクエリ：

curl -i -G 'https://<domain-name>:3242/query?db=mydb&u=<username>&p=<password>' \
  --data-urlencode 'q=SELECT *'

HTTP/1.1 400 Bad Request
...
{"error":"error parsing query: found EOF, expected FROM at line 1, char 9"}

無効な認証情報を持つクエリ：

curl -i -XPOST 'https://<domain-name>:3242/query?u=myusername&p=notmypassword' \
  --data-urlencode 'q=CREATE DATABASE "mydb"'

HTTP/1.1 401 Unauthorized
...
{"error":"authorization failed"}

秒精度のタイムスタンプでポイントを書き込む

curl -i -XPOST "https://<domain-name>:3242/write?db=mydb&precision=s&u=<username>&p=<password>" \
  --data-binary 'mymeas,mytag=1 myfield=90 1463683075'

HTTP/1.1 204 No Content

特定の保持ポリシーにポイントを書き込む

curl -i -XPOST "https://<domain-name>:3242/write?db=mydb&rp=myrp&u=<username>&p=<password>" \
  --data-binary 'mymeas,mytag=1 myfield=90'

HTTP/1.1 204 No Content

HTTP 認証 (クエリ文字列) を使用した書き込み

有効な認証情報：

curl -i -XPOST "https://<domain-name>:3242/write?db=mydb&u=myusername&p=mypassword" \
  --data-binary 'mymeas,mytag=1 myfield=91'

HTTP/1.1 204 No Content

無効な認証情報：

curl -i -XPOST "https://<domain-name>:3242/write?db=mydb&u=myusername&p=notmypassword" \
  --data-binary 'mymeas,mytag=1 myfield=91'

HTTP/1.1 401 Unauthorized
...
{"error":"authorization failed"}

基本認証を使用した書き込み

有効な認証情報：

curl -i -XPOST -u myusername:mypassword "https://<domain-name>:3242/write?db=mydb" \
  --data-binary 'mymeas,mytag=1 myfield=91'

HTTP/1.1 204 No Content

無効な認証情報：

curl -i -XPOST -u myusername:notmypassword "https://<domain-name>:3242/write?db=mydb" \
  --data-binary 'mymeas,mytag=1 myfield=91'

HTTP/1.1 401 Unauthorized
...
{"error":"authorization failed"}

ナノ秒タイムスタンプでポイントを書き込む

curl -i -XPOST "https://<domain-name>:3242/write?db=mydb&u=<username>&p=<password>" \
  --data-binary @data.txt

HTTP/1.1 204 No Content

サーバーのタイムスタンプを使用してポイントを書き込む

タイムスタンプを省略すると、サーバーの現在のナノ秒時刻が使用されます：

curl -i -XPOST "https://<domain-name>:3242/write?db=mydb&u=<username>&p=<password>" \
  --data-binary 'mymeas,mytag=1 myfield=90'

HTTP/1.1 204 No Content

1 つのリクエストで複数のポイントを書き込む

curl -i -XPOST "https://<domain-name>:3242/write?db=mydb&u=<username>&p=<password>" \
  --data-binary 'mymeas,mytag=3 myfield=89 1463689152000000000
mymeas,mytag=2 myfield=34 1463689152000000000'

HTTP/1.1 204 No Content

ファイルからポイントを書き込む

curl -i -XPOST "https://<domain-name>:3242/write?db=mydb&u=<username>&p=<password>" \
  --data-binary @data.txt

data.txt の例：

mymeas,mytag1=1 value=21 1463689680000000000
mymeas,mytag1=1 value=34 1463689690000000000
mymeas,mytag2=8 value=78 1463689700000000000
mymeas,mytag3=9 value=89 1463689710000000000

例

成功した書き込み：

HTTP/1.1 204 No Content

無効なタイムスタンプ：

HTTP/1.1 400 Bad Request
{"error":"unable to parse 'mymeas,mytag=1 myfield=91 abc123': bad timestamp"}

フィールド型の競合 (以前に浮動小数点数として保存されたフィールドに整数を書き込む)：

HTTP/1.1 400 Bad Request
{"error":"field type conflict: input field \"myfield\" on measurement \"mymeas\" is type int64, already exists as type float"}

無効な認証情報：

HTTP/1.1 401 Unauthorized
{"error":"authorization failed"}

対象のデータベースが存在しません：

HTTP/1.1 404 Not Found
{"error":"database not found: \"mydb1\""}

対象の保持ポリシーが存在しません：

HTTP/1.1 500 Internal Server Error
{"error":"retention policy not found: myrp"}

InfluxDB® は InfluxData の登録商標です。InfluxData は TSDB for InfluxDB® と提携しておらず、また推奨もしていません。