インシデント AI 自動分析設定を取得¶
GET /api/v1/incidents/config/ai_analysis/get
概要¶
現在のワークスペースにおけるインシデント AI 自動分析スイッチを読み取ります。
呼び出し前の準備と使用手順¶
Key の権限は routine.defaultAccess または incidents.incidentsManage のいずれかに一致する必要があります。現在の Key が属するワークスペースにのみ作用し、workspaceUUID やプラットフォームの一括ワークスペースリストは受け付けません。このスイッチはインシデント AI 自動分析のみを制御するものであり、インシデント集約スイッチ、AI の全体有効化、または分析の即時実行ではありません。実際のタスクでは、ワークスペースの AI 機能/サービスの可用性も確認されます。有効化しても、すべてのインシデントで応答が生成されることを保証するものではなく、本設定リクエストによってすべての過去インシデントが直ちに再分析されることもありません。無効化後、新規タスクおよび未開始の分析はスイッチを再確認します。保存が成功したからといって、実行中の AI リクエストが中断されたことや、過去の応答が削除されたことを証明することはできません。
enableAIAnalysis のブール値のみを読み取り、集約スイッチ、モデル設定、認証情報は返しません。有効な設定が存在しない場合は false を返し、読み取りリクエストによってレコードが作成されることはありません。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/incidents/config/ai_analysis/get' \
-H 'DF-API-KEY: <DF-API-KEY>'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取ることができる主要なフィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content.enableAIAnalysis | boolean | 現在のワークスペースのインシデント AI 自動分析設定。有効な設定レコードがない場合は false。 |
| content.declaration | object | 現在のワークスペースの共通宣言。 |
{
"code": 200,
"content": {
"enableAIAnalysis": false,
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラー応答¶
認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたは応答の説明 | 対処方法 |
|---|---|---|---|---|
| 500 | ft.InternalServerError | データベースの読み取りまたは過去の設定形式の異常 | 内部エラー | traceId を保持してバックオフしながら再試行してください。失敗が継続する場合は、管理者が設定とサービスログを確認してください。 |