プッシュメトリクス API
プッシュメトリクス API には、生のメトリックインテリジェンスデータを外部ソースから MID サーバー にプッシュできるエンドポイントが用意されています。
この API は、生データを外部ソースから MID サーバー にプッシュするクライアントサイドツールに基づいています。メトリックインテリジェンス 拡張は、[REST リスナーを有効にする] オプションを有効にして構成する必要があります。MID サーバーの設定の詳細については、「メトリックインテリジェンスの開始」を参照してください。
認証要件の詳細については、「 MID Web サーバー拡張の構成」を参照してください。
プッシュメトリクス:POST /mid/sa/metrics
生の メトリックインテリジェンス データを外部ソースから MID サーバーにプッシュします。
URL 形式
デフォルト URL: /api/mid/sa/metrics
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| なし |
| 名前 | 説明 |
|---|---|
| なし |
| 名前 | 説明 |
|---|---|
| ci2metric_id | 構成アイテム (CI) を識別するために使用するキーと値のペアのリスト。以前は ci_identifierとして知られていました。スクリプトは引き続き ci_identifierを受け付けます。 データタイプ: オブジェクト |
| metric_type | メトリクスの名前。 データタイプ：文字列 |
| node | IP アドレス、FQDN、CI の名前、またはホスト。次の例では、ディスクがインストールされている Linux サーバーの名前です。 データタイプ：文字列 |
| resource_path | メトリクスデータが収集されているリソースのパス。以下の例では、 C:\ がメトリクスデータが収集されるリソースです。データタイプ：文字列 |
| ソース | 評価指標タイプをモニタリングするデータソース。 データタイプ：文字列 |
| timestamp | メトリクスのエポックタイムスタンプ。 データタイプ：数値 単位：ミリ秒 |
| 単位 | ソースのメトリクスタイプに関連付けられているユニットタイプ。 表: モニタリングシステムのメトリクスタイプ [sa_source_metric_type] データタイプ：文字列 |
| 値 | メトリクスの値。 データタイプ：数値 |
ヘッダー
次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| Content-Type | 要求本文のデータ形式。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json |
| ヘッダー | 説明 |
|---|---|
| なし |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 200 | 成功。要求が正常に処理されました。 |
| 401 | 権限がありません。ユーザー認証情報が正しくないか、渡されていません。 |
| 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 |
応答本文のパラメーター (JSON または XML)
| 名前 | 説明 |
|---|---|
| なし |
cURL 要求
この例に示すように、要求本体は角かっこで囲む必要があります。
curl -X POST "https://<mid-server-host>/api/mid/sa/metrics"
-H "Content-Type: application/json"
-U "username":"password"
-d "[{
"metric_type": "Disk C: % Free Space",
"resource_path": "C:\\",
"node": "lnux100",
"value": 50,
"timestamp": 1473183012000,
"ci2metric_id": {
"node": "lnux100"
},
"source": "Splunk"
}]"