イベントの手動復旧¶
GET /api/v1/keyevent/restore
概要¶
イベント関連識別子に基づいて、現在のワークスペースのモニタリングイベントを手動で復旧するようリクエストします。
呼び出し前の準備と使用手順¶
まず未復旧イベント一覧から df_source=monitor の対象イベントとその df_monitor_checker_event_ref を取得し、monitorCheckerEventRef として使用します。この API は GET ですが、復旧操作を実行し監査ログを記録します。操作者が明示的に実行するようにし、ページのプリフェッチ、リンクチェック、自動リトライに組み込まないでください。同一の関連識別子で検索されたモニタリングイベントが未復旧の場合、復旧イベントの生成をリクエストします。content=true は処理フローが戻ったことのみを示し、対象が検索されたことや最終的に復旧が保存されたことを意味しません。一致するレコードがない場合や既に復旧済みの場合も true を返すことがあります。その後、未復旧イベント一覧またはイベントレコードを再検索して最終状態を確認してください。復旧中の場合は待機してから再検索してください。df_source=custom のビジネスイベントは、イベントを作成を使用して、同一の関連識別子かつ status=ok のイベントを書き込んでください。この API は現在の API Key が属するワークスペースを使用し、クロスワークスペースやクロスサイトのパラメータは宣言していません。他のワークスペースやサイトについては、それぞれ対応するサイトの Endpoint と対応するワークスペースの API Key を使用して個別に呼び出してください。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得方法または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| monitorCheckerEventRef | string | Y | トリガー対象のイベント関連識別子。__docid、df_event_id、モニター UUID ではありません。 null 許容: False 例: checkout-prod-latency取得方法または入力方法: 未復旧イベント一覧から df_source=monitor のレコードを選択し、df_monitor_checker_event_ref をそのままコピーします。 |
パラメータの補足説明¶
公開 API では monitorCheckerEventRef のみを宣言しており、追加の timeRange、needRecoverIssue、クロスワークスペースパラメータはサポートしていません。復旧クエリはクエリサービスのデフォルト時間範囲を使用するため、true から過去のイベントが復旧されたと断定できません。過去の対象については、まず元のイベントと現在のクエリ結果を照合してください。
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/keyevent/restore' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode monitorCheckerEventRef=checkout-prod-latency
レスポンス¶
HTTP 200、application/json。以下の例は直接読み取れる主要フィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content | boolean | true は今回の復旧処理が戻ったことを示します。一致するイベントが見つからない場合も true になり得るため、最終的なイベント状態を引き続き確認する必要があります。 |
{
"code": 200,
"content": true,
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラー応答¶
認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。
未知の関連識別子に対して 404 を返すことは保証されません。また復旧タスク ID も返しません。下流が未完了の場合は先に true を返すことがあるため、イベント状態の変化を確認の根拠としてください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたは応答の説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反 | パラメータの解析に失敗しました | パラメータの位置、フィールド名、型、値を確認してください。 |
| 406 | ft.EventRepeatRecover | 同一のインシデントに既に復旧リクエストがある、または一括復旧処理中 | イベントは復旧中です。重複して実行しないでください | 直ちに再送信せず、まず待機して復旧済みかどうかを確認してください。 |
| 503 | ft.QueryServiceUnavailable | クエリサービスが一時的に利用不可、実際の上流が 503 を返却 | クエリサービスが一時的に利用できません。しばらくしてから再試行してください | content.retryable=true を確認してからバックオフして再試行してください。継続的に失敗する場合は traceId を提供してください。 |
| 406 | ft.KodoRequestDeadlineExceeded | イベントクエリがバックエンドの許容実行時間を超過 | データクエリがタイムアウトしました。原因として以下が考えられます: データ量が多すぎる、ネットワーク遅延、サーバー負荷が高すぎる。以下の方法で解決できます: 1. フィルタ条件を追加するか時間範囲を縮小して再度クエリを実行してください。 2. しばらく待ってから再度クエリを試してください。 |
現在のワークスペースおよび monitorCheckerEventRef を確認し、しばらくしてから再試行してください。継続的に失敗する場合は traceId を提供してください。 |
| 406 | ft.KodoTooManyRows | クエリデータ量がバックエンドの制限を超過 | クエリされたデータ量が最大数量制限を超えています。フィルタ条件を追加するか時間範囲を縮小して再度クエリを実行してください。 | 現在のワークスペースおよび monitorCheckerEventRef を確認し、しばらくしてから再試行してください。継続的に失敗する場合は traceId を提供してください。 |
| 429 | ft.KodoServerOverloaded | クエリサービスがビジーまたは過負荷 | 現在のリクエストが頻繁すぎます。しばらくしてから再試行してください。 | バックオフして再試行し、同時に発行するリクエストを減らしてください。 |
| 500 | ft.InternalServerError | クエリ接続の失敗、上流サービスの異常、その他の内部エラー | 内部エラー | しばらくしてから再試行してください。継続的に失敗する場合は traceId とマスク済みのリクエストを提供してください。 |