イベント内容の取得¶
GET /api/v1/events/{doc_id}/get
概要¶
イベントドキュメント ID を指定して、現在のワークスペースにある 1 件のイベントの生の内容を取得します。
呼び出し前および使用手順¶
未復旧イベント一覧 の content.data[].__docid から doc_id を取得します。df_event_id や df_monitor_checker_event_ref で代用することはできません。過去のイベントでは、timeRange でイベント時刻を含む時間範囲を指定することを推奨します。成功時は content オブジェクトを返します。レコードが見つからない場合は {} となり、イベント ID によって自動的に 404 が返されることはありません。timeRange を省略した場合、または空文字列を渡した場合は、クエリサービスのデフォルトの時間範囲が使用されます。固定の履歴期間に依存しないでください。この API は現在の API Key が属するワークスペースを使用し、ワークスペースやサイトをまたぐパラメータは宣言されていません。他のワークスペースやサイトの場合は、該当するサイトのエンドポイントと、該当するワークスペースの API Key を使用して個別に呼び出してください。
パスパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| doc_id | string | Y | 単一イベントのドキュメント ID。パスパラメータです。 例: DOC-EXAMPLE取得または入力方法: 未復旧イベント一覧の返却項目の __docid からコピーします。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
クエリリクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| timeRange | string | 任意の時間範囲。形式は [開始ミリ秒,終了ミリ秒] の JSON 配列文字列です。 null を許可: False 例: [1785427200000, 1785430800000]取得または入力方法: 対象イベントの time または date のミリ秒値に基づいて、それを包含する開始時刻と終了時刻を選択し、2 項目の配列を文字列にシリアル化して URL エンコードします。 |
パラメータ補足¶
生のフィールドの意味についてはイベントフィールドリファレンスを参照してください。timeRange は文字列として宣言されており、サーバー側でその中の JSON を解析します。2 項目のミリ秒配列を渡す必要があります。不正な JSON や誤った構造の場合は、一般的な内部エラーが返される可能性があります。一覧で新たに追加された isRecover、alert_time_ranges、Issue および障害関連フィールドは、詳細 API の固定出力ではありません。
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/events/DOC-EXAMPLE/get' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode 'timeRange=[1785427200000,1785430800000]'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content | object | クエリで返されるイベントの生のフィールドオブジェクト。レコードがない場合は {} です。 |
| content.__docid | string | イベントドキュメント ID。イベント詳細のパス doc_id に設定します。df_event_id やイベント関連識別子とは異なります。 |
| content.time | integer | イベントクエリで返される時刻。Unix ミリ秒です。 |
| content.date | integer | 互換性のための時刻フィールド。一覧では time と同じ値で、Unix ミリ秒です。 |
| content.df_title | string | イベントタイトル。 |
| content.df_message | string | イベントの詳細説明。 |
| content.df_status | string | イベントステータス。未復旧イベント一覧では fatal、critical、error、warning、nodata です。詳細ではさらに ok、info、または他のソースで定義された復旧ステータスとなる場合があります。 |
| content.df_source | string | イベントソース。たとえば monitor はモニタリングイベント、custom は本モジュールで作成されたカスタムイベントです。 |
| content.df_event_id | string | イベントの一意な ID。詳細のパス doc_id には使用しません。 |
| content.df_monitor_checker_event_ref | string | 同一のトリガー対象におけるイベント関連識別子。グループ化と復旧に使用され、単一イベントの ID として扱うことはできません。 |
| content.df_dimension_tags | string または null | 検出ディメンションのタグ。多くの場合、JSON オブジェクトをシリアル化した文字列です。値がある場合は解析後に service、host などの実際のディメンションを読み取れます。 |
| content.df_check_range_start | integer | 検出範囲の開始時刻。Unix 秒です。一覧で欠落している場合は 0 が補完されます。 |
| content.df_check_range_end | integer | 検出範囲の終了時刻。Unix 秒です。一覧で欠落している場合は 0 が補完されます。 |
| content.df_fault_start_time | integer または null | 今回の障害開始時刻。Unix 秒です。ソースから提供された場合にのみ返されます。 |
| content.df_fault_id | string または null | 今回の障害 ID。通常、最初の障害イベントの df_event_id です。 |
| content.df_monitor_checker | string または null | 検出関数名。たとえば custom_metric です。 |
| content.df_monitor_checker_name | string または null | モニター名。 |
| content.df_monitor_checker_value | number、string または null | イベント発生時の検出値。単位はモニターのメトリクス設定によって決まり、一律にミリ秒として扱うことはできません。 |
| content.df_monitor_type | string または null | モニター種別。たとえば custom、slo、bot_obs です。インテグレーション収集 integration_collection は、この未復旧イベント一覧の対象外です。 |
| content.df_workspace_uuid | string または null | イベントレコード内のワークスペース識別子。 |
| content.df_meta | string、object または null | ソースから提供される拡張メタデータ。文字列の場合は JSON をシリアル化した値です。構造はイベントソースによって異なります。 |
| content.df_bot_obs_detail | string、object または null | インテリジェントインスペクションイベントの追加詳細。このソース以外では欠落する場合があります。 |
| content.df_event_detail | string、object または null | イベントソースから提供される拡張詳細。フィールドは対応するモニター種別に応じて提供されます。 |
| content.df_is_silent | boolean、number または null | ソースに記録されたミュートフラグ。一覧ではこの元の値を一律に boolean に変換しません。 |
| content.df_sent_target_types | array、string または null | ソースに記録された通知先タイプ。ソースや履歴レコードの形式によって変わる場合があります。 |
| content.df_alert_info | string、object または null | ソースに記録されたアラート情報。構造はイベントタイプによって変わります。 |
| content.df_monitor_checker_id | string | ソースから提供されるモニター UUID。モニター設定の検索に使用できます。 |
| content.df_monitor_id | string | ソースから提供されるアラートポリシー UUID。 |
| content.df_monitor_name | string | ソースから提供されるアラートポリシー名。 |
| content.カスタムフィールド | string、number、boolean、array、object または null | イベントに保存されたその他の生のフィールド(カスタムフィールドを含む)。フィールド名、構造、単位は収集ソースによって異なり、すべてのイベントで同じであるとは限りません。 |
| content.declaration | object または null | 空でない結果に付加されるワークスペースの共通宣言。空オブジェクトの結果には付加されません。 |
{
"code": 200,
"content": {
"__docid": "DOC-EXAMPLE",
"time": 1785430800000,
"date": 1785430800000,
"df_title": "checkout-api 响应时间超过阈值",
"df_message": "最近 5 分钟平均响应时间超过 500 ms。",
"df_status": "critical",
"df_source": "monitor",
"df_event_id": "event-example",
"df_monitor_checker_event_ref": "checkout-prod-latency",
"df_dimension_tags": "{\"service\":\"checkout-api\",\"env\":\"production\"}",
"df_check_range_start": 1785430500,
"df_check_range_end": 1785430800,
"df_fault_start_time": 1785430500,
"df_fault_id": "event-fault-example",
"df_monitor_checker": "custom_metric",
"df_monitor_checker_name": "checkout-api 平均响应时间",
"df_monitor_checker_value": 800,
"df_monitor_type": "custom",
"df_workspace_uuid": "wksp_example",
"df_is_silent": false,
"df_sent_target_types": [
"dingtalk"
],
"df_meta": "{}",
"df_bot_obs_detail": null,
"df_event_detail": null,
"df_alert_info": null,
"df_monitor_checker_id": "rul_example",
"df_monitor_id": "monitor_example",
"df_monitor_name": "生产服务告警",
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
イベントが見つからない場合
{
"code": 200,
"content": {},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。
イベントが見つからない場合は成功時の空オブジェクトです。ワークスペース、サイト、__docid、およびイベント時刻を含む timeRange を確認してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反しています | パラメータ解析に失敗しました | パラメータの位置、フィールド名、型、値を確認してください。 |
| 503 | ft.QueryServiceUnavailable | クエリサービスが一時的に利用できません。実際の上流サービスが 503 を返しています | クエリサービスが一時的に利用できません。しばらくしてから再試行してください | content.retryable=true を確認してバックオフしながら再試行してください。継続して失敗する場合は traceId を提供してください。 |
| 406 | ft.KodoRequestDeadlineExceeded | イベントクエリがバックエンドで許可された実行時間を超えました | データクエリがタイムアウトしました。原因として、データ量の過多、ネットワーク遅延、サーバー負荷の高さが考えられます。次の方法で解決できます: 1. フィルター条件を追加するか、時間範囲を狭めてから再度クエリを実行してください。 2. しばらく待ってから再度クエリを実行してください。 |
timeRange を狭め、doc_id を確認してください。継続して失敗する場合は traceId を提供してください。 |
| 406 | ft.KodoTooManyRows | クエリ対象のデータ量がバックエンドの制限を超えました | クエリ対象のデータ量が最大件数の制限を超えています。フィルター条件を追加するか、時間範囲を狭めてから再度クエリを実行してください。 | timeRange を狭め、doc_id を確認してください。継続して失敗する場合は traceId を提供してください。 |
| 429 | ft.KodoServerOverloaded | クエリサービスが混雑しているか過負荷です | 現在のリクエスト頻度が高すぎます。しばらくしてから再試行してください。 | バックオフして再試行し、同時に発行するリクエストを減らしてください。 |
| 500 | ft.InternalServerError | クエリ接続の失敗、上流サービスの異常、その他の内部エラー | 内部エラー | しばらくしてから再試行してください。継続して失敗する場合は traceId と機密情報を除去したリクエストを提供してください。 |