5.11.3　トレンドデータ書き込み

機能

トレンドデータをトレンドデータ管理DBに書き込みます。

書き込むデータはJSON形式で指定します。

実行権限

なし

APIのバージョン

形式

リクエスト行

POST /im/api/v1/trendData/write HTTP/1.1

リクエストヘッダー

ヘッダー名	設定値
Authorization	設定しないでください。

リクエストのメッセージボディーがJSON形式の場合，ほかのリクエストヘッダーは，APIの共通仕様と同じです。APIの共通仕様のリクエストヘッダーについては，「5.2.3　リクエスト形式」の，リクエストヘッダーの説明を参照してください。

リクエストのメッセージボディー

次に示すJSON形式で送信できます。

{
    "labels":{"__name__": "メトリクス名", "ラベル名":"ラベル値", ...},
    "samples":[
        [時刻, 値],
        ...
    ]
}
{
    "labels":{"__name__": "メトリクス名", "ラベル名":"ラベル値", ...},
    "samples":[
        [時刻, 値],
        ...
    ]
}
...

レスポンスのメッセージボディー

なし

パラメーター

リクエストのメッセージボディーに指定するパラメーターを次に示します。

項番	パラメーター	データ型	説明
1	labels	配列	時系列データのラベルを配列で指定します。
2	__name__	string	時系列データのメトリクス名を指定します。指定は必須です。
3	ラベル名	string	時系列データのラベル名を指定します。
4	ラベル値	string	時系列データのラベル値を指定します
5	samples	配列	時系列データを配列で指定します。
6	時刻	数値	性能データの時刻（UTC時刻における1970年1月1日午前0時0分0秒（UNIXエポック）からの経過ミリ秒数）を指定します。1970年1月1日午前0時0分0秒以前の時刻（マイナス値）は指定できません。
7	値	数値	性能データの値を指定します。

ステータスコード

リクエストに対するレスポンスとして返却されるステータスコードを，次の表に示します。

ステータスコード	メッセージ	説明
200	なし	APIの処理が成功しました。
500	KAJY62001-E	トレンドデータ管理サービスからエラーが返却されました。
	KAJY62000-E	トレンドデータ管理サービスとの通信に失敗しました。
	KAJY62004-E	トレンドデータ管理サービスのポート番号の取得に失敗しました。

使用例

OSSのcurlコマンドを利用して，このAPIを実行した場合の使用例を，次に示します。

>curl -i --header "Content-Type: application/json" --request POST --data @c:\\work\\trenddata.json "http://localhost:20703/im/api/v1/trendData/write"

trenddata.json

{
    "labels":{"__name__":"foo","job":"hoge"},
    "samples":[
        [1617436800000,100]
    ]
}

レスポンス例

HTTP/1.1 200
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Content-Length: 0
Date: Fri, 25 Feb 2022 05:59:58 GMT

ページの先頭へ

5.11.3 トレンドデータ書き込み

5.11.3　トレンドデータ書き込み