LLM 設定の削除¶
POST /api/v1/llm_cfg/delete
概要¶
LLM アプリを一括でソフト削除し、ダウンストリームに更新を通知します。
呼び出し前と使用手順¶
現在の Key には llm.llmCfgManage が必要です。appIds の値は簡易一覧から公開 appId を取得します。省略または [] の場合は一致するものがなく、{} を返します。現在のワークスペース内の未削除アプリのみを選択し、不明な項目、別ワークスペースの項目、削除済みの項目は無視します。保護された組み込み Agent アプリのいずれかに一致した場合は InvalidAction となり、自動的にスキップされません。
アプリをソフト削除した後、項目ごとに同期的にダウンストリームへ通知します。共有 Client Token の削除/取り消しは行わず、過去の LLM テレメトリも削除しません。失敗時は通知が一部のみ完了し、データベースはすべてコミット済みである可能性があります。まず簡易一覧/詳細で確認し、HTTP エラーに基づいて未削除と判断しないでください。公開された復元 API はありません。削除前に設定を保存してください。再作成しても、過去の統計や Token 権限が自動的に復元されるわけではありません。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| appIds[*] | string | 1 つの appId 文字列。内部 UUID ではなく、uuid は公開エイリアスとして使用できますが、appId と一致している必要があります。 例: payment_llm取得または入力方法: LLM アプリ簡易一覧 から content[].appId を取得します(uuid は同じ公開エイリアスです)。または、ページング一覧の content.data[].appId から取得します。 |
|
| appIds | array | 省略可能な公開 appId 配列。省略または [] の場合は対象がありません。不明な項目は無視され、項目ごとのエラー/カウントは返しません。 null を許可: False 例: ["payment_llm"]取得または入力方法: LLM アプリ簡易一覧 から content[].appId を取得します(uuid は同じ公開エイリアスです)。または、ページング一覧の content.data[].appId から取得します。 |
パラメータの補足説明¶
appId は公開アプリケーション識別子で、uuid はその互換エイリアスです。本ページに記載された実際の Token、統計、エラーの境界に従って使用し、フロントエンド/AI インターフェースの追加パラメータをそのまま流用しないでください。
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/llm_cfg/delete' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"appIds":["payment_llm"]}'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content | object | 実際に削除された appId → 名前のマッピング。一致するものがない場合は {}。 |
| content.アプリケーション識別子 | string | 実際に削除されたいずれかのアプリの表示名。 |
| content.declaration | object または null | 空でないマッピングにのみ共通宣言が自動的に補完されます。appId の命名は declaration の予約キーとの競合を避けてください。 |
{
"code": 200,
"content": {
"payment_llm": "支付助手",
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
{
"code": 200,
"content": {},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、共通リクエストエラーについては、共通エラー定義 を参照してください。
データベース本体は先にコミットされ、その後、設定変更通知が同期的に呼び出されます。ダウンストリームの業務 4xx は、実際の HTTP/errorCode/message に応じて返される場合があります。透過されていない >=500 は一律 500 になります。後続のエラーが発生してもデータベースのロールバックは保証されないため、まず読み戻して確認してください。統計クエリの異常は通常、全項目 null としてフォールトトレラントに処理され、書き込み通知のエラーとは混同されません。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反している | パラメータの解析に失敗しました | パラメータの位置、フィールド名、型、値を確認してください。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効 | リクエスト JSON の形式エラー | content.reason、line、column に従って JSON を修正してください。 |
| 400 | ft.JsonFormatError | JSON のトップレベルがオブジェクトではない | 一部の json ファイルの形式エラー | appIds オブジェクトを送信してください。 |
| 400 | ft.InvalidAction | 保護された Agent モニタリングの組み込みアプリケーションに一致 | Agent monitor builtin applications cannot be modified or deleted | 現在の公開簡易一覧から通常のアプリを選択してください。専用の管理フローを使用してください。 |
| 500 | ft.InternalServerError | データベース/Token/履歴設定、コミット後のダウンストリームへの設定通知、またはレスポンス構築の異常 | 内部エラー | まず appId/名前/Token バインディングとダウンストリームの実際の接続状況を読み戻して確認してください。データベース本体はすでにコミットされている可能性があるため、むやみに再作成/Token の切り替えを繰り返さないでください。traceId を保持して調査してください。 |