外部イベントモニターイベント受信¶

POST /api/v1/push-events/{secret}/{subUri}

概要¶

外部イベントを受信し、そのイベントに基づいて対応するイベントデータを生成します。注意：secret および subUri の情報がモニターに記録されている情報と一致しない場合、このイベントは無視されます。

ルートパラメータ¶

パラメータ名	タイプ	必須	説明
secret	string	Y	外部イベントモニターの secret（モニター作成時の `secret` フィールドに対応します。この値がモニター設定と一致しない場合、このイベントは無視されます）
subUri	string	Y	外部イベントモニターの subUri（モニター作成時の `jsonScript`.`subUri` フィールドに対応します。この値がモニター設定と一致しない場合、このイベントは無視されます）

Body リクエストパラメータ¶

パラメータ名	タイプ	必須	説明
event	json	Y	イベントデータ空の値を許可：False
extraData	json		追加データ。最終的にイベントの df_meta.extra_data フィールドに追加されます空の値を許可：False $required: False

パラメータ補足説明¶

パラメータ説明：

body リクエストパラメータの主要構造説明

パラメータ名	パラメータタイプ	必須	パラメータ説明
event	json	はい	イベントデータ
extraData	json	いいえ	追加データ。最終的にイベントの df_meta.extra_data フィールドに追加されます。key:value 形式で指定します

event リクエストパラメータの主要構造説明

パラメータ名	パラメータタイプ	必須	パラメータ説明
date	int	いいえ	イベント時間（単位：秒）
status	string	はい	イベントステータス。選択肢：fatal、critical、error、warning、info、ok
title	string	いいえ	イベントタイトル
message	string	いいえ	イベント内容
dimension_tags	json	いいえ	ディメンションタグ。例：{ "host": "WebServer" }
check_value	float	いいえ	チェック値
ユーザー定義フィールド	str	いいえ	2024-09-04 ユーザー定義フィールド。イベントのトップレベルフィールドとして扱われ、制限条件を満たす必要があります

event.{ユーザー定義フィールド} 制限条件説明

同名フィールドに異なるタイプの値が報告され、後続の問題が発生するのを防ぐため、ユーザー定義フィールドは以下の制限条件を満たす必要があります：

フィールド値は文字列型である必要があります（例："abc"、"123"）
フィールド名はアンダースコア_ または df_ で始めてはなりません
フィールド名は dimension_tags の分解後のフィールド名、labels の分解後のフィールド名と同じであってはなりません
フィールド名は以下の予約フィールドを使用してはなりません（カスタムフィールドは、すべて独自に定義したプレフィックス（例：ext_xxx、biz_xxx など）を先頭に付けて区別することを推奨します）：
- date
- status
- source
- title
- message
- dimension_tags
- check_value
- time
- time_us
- timestamp
- workspace_uuid
- workspace_name
- extra_data
- create_time

リクエスト例¶

curl 'https://openapi.guance.com/api/v1/push-events/<secret>/<subUri>' \
  -H 'DF-API-KEY:  <DF-API-KEY>' \
  -H 'Content-Type: application/json;charset=UTF-8' \
  --data-raw '{"event":{"status":"warning","title":"title1","message":"message1","dimension_tags":{"heros":"caiwenji"},"check_value":20},"extraData":{"name":"xxxxxxxx"}}' \
  --compressed

レスポンス¶

{
    "code": 200,
    "content": {
        "data": {},
        "error": 200,
        "message": "",
        "ok": true,
        "reqCost": 458,
        "reqTime": "2023-10-19T07:26:30.743Z",
        "respTime": "2023-10-19T07:26:31.201Z",
        "traceId": "7390361544936022329"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "7390361544936022329"
}