プッシュメトリクス 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:\ は測定基準データが収集されるリソースです。データタイプ：文字列 |
| source | 測定基準タイプを監視するデータソースです。 データタイプ：文字列 |
| timestamp | 測定基準のエポックタイムスタンプ。 データタイプ：数値 単位：ミリ秒 |
| value | 測定基準の値。 データタイプ：数値 |
ヘッダー
次のリクエストや応答ヘッダーは、この 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://servicenow-instance/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"
}]"