:マルチ値データポイントの書き込み

リクエスト

エンドポイント

POST /api/mput

クエリパラメーター

応答フォーマットを制御するために、これらのパラメーターを URL に追加します。型指定のないパラメーターは、値に関係なく存在するだけで true とみなされます。

リクエストボディ

各要素がデータポイントである JSON 配列を渡します。各データポイントには、以下のフィールドを含める必要があります。

リクエストの例

POST /api/mput
Content-Type: application/json

[
  {
    "metric": "wind",
    "fields": {
      "speed": 20.8,
      "level": 4,
      "direction": "East",
      "description": "Fresh breeze"
    },
    "tags": {
      "sensor": "IOTE_8859_0001",
      "city": "hangzhou",
      "province": "zhejiang",
      "country": "china"
    },
    "timestamp": 1346846400
  },
  {
    "metric": "wind",
    "fields": {
      "speed": 40.2,
      "level": 6,
      "direction": "South",
      "description": "Fresh breeze"
    },
    "tags": {
      "sensor": "IOTE_8859_0002",
      "city": "hangzhou",
      "province": "zhejiang",
      "country": "china"
    },
    "timestamp": 1346846401
  }
]

タイムスタンプのルール

TSDB は、数値の大きさに基づいてタイムスタンプの単位を判別します。このルールは、/api/put、/api/mput、/api/query、および /api/mquery に適用されます。

シンプルモード

クエリパラメーターは不要です。成功時は HTTP 204 を返します。失敗時はエラーコードおよびエラーメッセージを返します。

書き込みエラーが発生しないことが想定される一般的なモニタリングデータや、リトライ処理が外部で実装される場合にこのモードを使用します。

統計情報付きモード

リクエスト URL に ?summary を追加します。書き込みの成否に関わらず、success および failed のカウントを返します。

{
  "success": 20,
  "failed": 0
}

統計情報付きモードでは、単一の api/mput リクエスト内のすべてのデータポイントが、成功または失敗のいずれか一方にまとめて判定されます。いずれかのデータポイントが失敗した場合、failed にはリクエスト内のデータポイント総数が反映されます。

書き込みスループットの統計情報を追跡する場合にこのモードを使用します。

詳細情報付きモード

リクエスト URL に ?details を追加します。統計情報付きモードを拡張し、応答に最初の書き込み失敗情報を含めます。

詳細情報付きモードでは、リクエスト内のすべてのデータポイントが成功または失敗のいずれか一方にまとめて判定されます。errors 配列には最初の失敗情報のみが含まれます。失敗総数については、failed をご確認ください。

書き込み失敗の原因を特定する必要がある場合にこのモードを使用します。

フォールトトレラントモード

リクエスト URL に ?ignoreErrors を追加します。各データポイントを独立して書き込み、1 つのデータポイントの失敗が他のデータポイントの書き込みをブロックしません。

1 つ以上のデータポイントが書き込まれた場合は HTTP 200 を返します。すべてのデータポイントがストレージ障害などの重大なエラーにより失敗した場合にのみ、200 以外のステータスコードを返します。

リクエストに有効および無効なデータポイントが混在する可能性があり、可能な限り多くのデータポイントを正常に書き込む必要がある場合にこのモードを使用します。