LLM 設定の一覧表示¶
GET /api/v1/llm_cfg/list
概要¶
LLM アプリケーションと集計統計をページングして読み取ります。
呼び出し前の確認と使用手順¶
現在の Key 権限は routine.defaultAccess または llm.llmCfgManage のいずれかに一致する必要があり、現在のワークスペースのみが対象です。組み込み Agent 監視アプリはこのグループ一覧では非表示になり、詳細で対象/組み込み対象が欠けている場合は 404 を返します。これら 6 つのインターフェースで専用の組み込みアプリを管理しないでください。公開インターフェースは appType またはクロススペースパラメータを受け付けず、フロントエンド/AI 入口の追加フィルタと返却プロジェクションをそのまま流用できません。
一覧/詳細は Client Token の平文を返します。これは収集接続の資格情報であり、権限を付与された接続先にのみ渡してください。DF-API-KEY をクライアント収集 Token として扱わないでください。ifTokenExpired は互換性のための状態ヒントにすぎず、同一スペースへの帰属や実際の利用可否を証明できません。レコードがない場合は一覧で false にさえなり得ます。まず現在のスペースの有効な Token と実際の収集を確認してください。
content は {data,declaration} を保持し、pageInfo はトップレベルにあり、data 項目に宣言を再帰的に追加しません。クエリは安定した並び順を指定していないため、組み込み項目の新規作成/名前変更/非表示後にページ数が変わる可能性があります。totalCount と表示件数が完全には一致しない場合があることを許容してください。統計は現在の jsonContent.name によって下流の rollup を照合し、appId では照合しません。名前変更または収集名が異なる場合は一致しないことがあります。デフォルトは直近 24 時間で、JSON 文字列 timeRange により統計ウィンドウを変更できます。統計失敗/データなしの場合はすべて null になり、本インターフェースでクエリエラーが返らないことは 0 を意味しません。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証資格情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| pageIndex | int | 任意。省略時は 1。クライアントは正の整数文字列を渡す必要があります。Query は $type の厳密検証を行わず、不正なテキスト変換は 500 になる可能性があります。null を許可: False デフォルト値: 1 例: 1取得または入力方法: トップレベル pageInfo に従って 1 からページングします。 |
|
| pageSize | int | 任意。省略時は 20。旧説明の最大 100 は $maxValue/コントローラによる切り捨てに対応しておらず、現在は強制上限を保証していません。クライアント側で数量を制限してください。0/負数は渡さないでください。null を許可: False デフォルト値: 20 例: 20取得または入力方法: 呼び出し側でページサイズを制御します。1~100 を推奨します。 |
|
| search | string | 任意。先頭と末尾の空白を除去し、SQL ILIKE によるあいまい一致を行います。%/_ はワイルドカードの意味を保持します。 null を許可: False 例: 支付取得または入力方法: アプリの jsonContent.name で検索します。 |
|
| timeRange | array | 任意。転送形式は [1785340800000,1785427200000] などです。省略/[] の場合はデフォルトで直近 24 時間です。現在、完全な長さ/要素/順序の検証はありません。2 つの整数ミリ秒であり、開始 < 終了であることを自身で確保する必要があります。不正な JSON は事前の 406 ではなく 500 になる可能性があります。同名の Query を複数回指定する形式ではありません。 null を許可: False 例: [1785340800000, 1785427200000]取得または入力方法: 呼び出し側が統計の開始/終了を Unix ミリ秒に変換し、URL エンコードした JSON 配列文字列として渡します。 |
|
| type | string | 任意。完全一致の型。省略時はフィルタしません。公開列挙は Langfuse のみです。 null を許可: False 選択可能値: ['Langfuse'] 例: Langfuse取得または入力方法: 現在公開でフィルタ可能な型は Langfuse です。 |
パラメータ補足説明¶
appId は公開アプリケーション識別子で、uuid はその互換エイリアスです。本ページの実際の Token、統計、エラー境界に従って使用し、フロントエンド/AI インターフェースの追加パラメータをそのまま流用しないでください。
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/llm_cfg/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode pageIndex=1 \
--data-urlencode pageSize=20
レスポンス¶
HTTP 200、application/json。以下の例は直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content | object | ページングオブジェクト。 |
| content.data | array<object> |
本ページのアプリケーション。平文 Token と統計を含みます。 |
| content.data[].id | integer または null | データベース行 ID。パス定位には使用しません。送信前スナップショットでは null の場合があります。 |
| content.data[].uuid | string | 公開互換エイリアス。appId と等しく、内部の実際の LlmCfg UUID ではありません。 |
| content.data[].status | integer | リソース状態。通常は 0。論理削除の 3 はクエリから除外されます。 |
| content.data[].creator | string | 作成主体 UUID。現在の OpenAPI では通常 Key リソースの wsak_ です。 |
| content.data[].updator | string | 最近の更新主体。未更新の場合は空になり得ます。 |
| content.data[].createAt | integer | Unix 秒の作成時刻。 |
| content.data[].updateAt | integer | Unix 秒の更新時刻。未更新の場合は通常 -1。 |
| content.data[].deleteAt | integer | Unix 秒の削除時刻。未削除の場合は通常 -1。 |
| content.data[].workspaceUUID | string | 現在の Key が属するワークスペース。 |
| content.data[].appId | string | 公開アプリケーション ID。デフォルトでは llmcfg_ プレフィックス値が自動生成されます。 |
| content.data[].appType | string | アプリケーション族のマーク。公開作成では通常空です。履歴では llm/agent/obsyTeam などがあり得ますが、この公開入力では appType を許可しません。 |
| content.data[].jsonContent | object | アプリケーションの表示/接続設定。宣言されていない追加のトップレベル子キーを含めて書き込むことはできません。 |
| content.data[].jsonContent.name | string | アプリケーション表示名。統計はこの名前で照合します。 |
| content.data[].jsonContent.type | string | 公開書き込みは Langfuse のみです。履歴の型は異なる場合がありますが、公開で書き戻せることを意味しません。 |
| content.data[].jsonContent.site | string | 任意で保存されるサイトアドレス。サーバーはこのフィールドによってサードパーティプロジェクトを自動作成したり、接続可能であることを検証したりしません。 |
| content.data[].jsonContent.extend | object | 任意の動的拡張オブジェクト。提供されない場合、キーは省略できます。 |
| content.data[].jsonContent.extend.自定义键 | JSON | そのまま保存される JSON 値。追加の実行/認証設定を保証するものではありません。 |
| content.data[].clientToken | string | 一覧/詳細/作成では Client Token の平文です。変更時に省略/空パラメータの場合、内部の wctn_ UUID 互換分岐があります。詳細は該当ページを参照してください。 |
| content.data[].ifTokenExpired | boolean | Token 状態の互換ヒント。一覧: レコードが存在し status3 の場合は true、レコードがない場合はむしろ false です。詳細: 同じ平文の未削除レコードが任意に存在するかで判断します。false は現在のスペースの Token が収集可能または有効化済みであることを保証しません。 |
| content.data[].statisticalInfo | object | 下流の集計統計。jsonContent.name で照合します。データなし、非 LLM アプリ、または集計異常の場合はすべて null であり、0 として扱うべきではありません。 |
| content.data[].statisticalInfo.callCount | number または null | ウィンドウ内の呼び出し数。 |
| content.data[].statisticalInfo.errorCount | number または null | ウィンドウ内のエラー数。 |
| content.data[].statisticalInfo.tokensCount | number または null | ウィンドウ内の Token 総量。 |
| content.data[].statisticalInfo.inputTokens | number または null | ウィンドウ内の入力 Token 量。 |
| content.data[].statisticalInfo.outputTokens | number または null | ウィンドウ内の出力 Token 量。 |
| content.data[].statisticalInfo.p50 | number または null | リクエスト遅延の 50 パーセンタイル。Studio は集計値をそのまま転送し、単位変換は行いません。使用時は収集/集計元の単位と一致させてください。 |
| content.data[].statisticalInfo.p75 | number または null | リクエスト遅延の 75 パーセンタイル。p50 と同じ単位基準です。 |
| pageInfo | object | ページングメタ情報。OpenAPI ではトップレベルにあり、content はオブジェクトを保持します。 |
| pageInfo.count | integer | 本ページの実際の件数。 |
| pageInfo.totalCount | integer | 設定クエリのページング総数。後置で組み込み名項目が非表示になる場合、総数と表示件数が完全には一致しない可能性があります。 |
| pageInfo.pageIndex | integer | ページ番号。1 から開始します。 |
| pageInfo.pageSize | integer | 今回の 1 ページあたりのリクエスト数。 |
| content.declaration | object または null | 現在のワークスペースの共通宣言。content 親オブジェクトにのみ追加し、data 項目に再帰的に追加しません。 |
{
"code": 200,
"content": {
"data": [
{
"id": 7,
"uuid": "payment_llm",
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"workspaceUUID": "wksp_example",
"appId": "payment_llm",
"appType": "",
"jsonContent": {
"name": "支付助手",
"type": "Langfuse",
"site": "https://llm.example.com",
"extend": {
"team": "payment"
}
},
"clientToken": "<LLM-CLIENT-TOKEN>",
"ifTokenExpired": false,
"statisticalInfo": {
"callCount": null,
"errorCount": null,
"tokensCount": null,
"inputTokens": null,
"outputTokens": null,
"p50": null,
"p75": null
}
}
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE",
"pageInfo": {
"count": 1,
"totalCount": 1,
"pageIndex": 1,
"pageSize": 20
}
}
エラー応答¶
認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたは応答説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 宣言されていない Query パラメータを使用した、またはパラメータがルールに違反している | パラメータ解析失敗 | Query パラメータ表と例を確認してください。 |
| 500 | ft.InternalServerError | データベース読み取り、履歴 jsonContent/rollup オブジェクト形式、不正なページング変換、時間範囲 JSON 解析などの未処理例外 | 内部エラー | パラメータと履歴設定を確認し、traceId を保持してバックオフしてください。統計がすべて null の場合も下流が利用不可である可能性があり、呼び出し数 0 と解釈できません。 |