インシデント AI 自動分析の設定¶
POST /api/v1/incidents/config/ai_analysis/set
概要¶
現在のワークスペースのインシデント AI 自動分析スイッチを設定します。
呼び出し前の前提条件と使用手順¶
現在の Key には incidents.incidentsManage が必要です。現在の Key が属するワークスペースにのみ作用し、workspaceUUID やプラットフォームの一括ワークスペースリストは受け付けません。このスイッチはインシデント AI 自動分析のみを制御するものであり、インシデント集約のスイッチ、AI のグローバル有効化、または分析の即時実行ではありません。実際のタスクではワークスペースの AI 機能/サービスの可用性も確認します。有効化してもすべてのインシデントで返信が生成されることを保証するものではなく、本設定リクエストによって過去のすべてのインシデントが直ちに再分析されることもありません。無効化後、新規タスク/未開始の分析はスイッチを再確認します。保存の成功をもって、実行中の AI リクエストが終了したことや過去の返信が削除されたことを証明することはできません。
JSON の真偽値 enableAIAnalysis を明示的に渡す必要があります。true で有効、false で無効となり、省略時のデフォルト値はなく、null や文字列は受け付けません。設定が存在しない場合は新規作成され、既存の設定はこのスイッチのみを更新し、その他の extend 設定は保持されます。同じ値を繰り返し設定した場合でも、更新日時が変更されたり監査ログが記録されたりする可能性があります。戻り値は保存された値であり、AI タスク ID や分析成功の結果ではありません。失敗/タイムアウト時は、まず読み取りインターフェースで現在の状態を確認してください。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| enableAIAnalysis | boolean | Y | 必須の boolean。true で有効、false で無効。省略/null 時のデフォルトはなく、AI サービスがすでに利用可能であることを示すものではありません。 null の許可: False 例: true取得または入力方法: 現在のワークスペースの管理者がインシデント AI 分析を有効にするかどうかを決定します。 |
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/incidents/config/ai_analysis/set' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"enableAIAnalysis":true}'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要なフィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content.enableAIAnalysis | boolean | 現在のワークスペースのインシデント AI 自動分析設定。有効な設定レコードがない場合は false。 |
| content.declaration | object | 現在のワークスペースの共通宣言。 |
{
"code": 200,
"content": {
"enableAIAnalysis": true,
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラー応答¶
認証、レート制限、共通リクエストのエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたは応答の説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反している | パラメータの解析に失敗しました | パラメータの位置、フィールド名、型、値を確認してください。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効 | リクエスト JSON の形式エラー | content.reason、line、column に従って JSON を修正してください。 |
| 400 | ft.JsonFormatError | JSON のトップレベルがオブジェクトではない | 一部の json ファイルの形式エラー | enableAIAnalysis を含むオブジェクトを送信してください。 |
| 500 | ft.InternalServerError | データベースまたは未処理のシステム例外 | 内部エラー | 読み取りインターフェースはバックオフして再試行できます。書き込みインターフェースは、まず設定を読み戻して保存済みかどうかを確認してから、同じ目標値で再試行してください。 |