コンテンツにスキップ

一覧



GET /api/v1/outer_function/list

概要

中央 Func サービスで OpenAPI 経由の実行が許可されている関数と、そのパラメータメタデータを一覧表示します。

呼び出し前の確認と使用手順

対象ワークスペースの API Key を使用し、routine.defaultAccess または anonymous.snapshotShared のいずれかのエンドポイント権限が必要です。このエンドポイントは中央 Func サービス内の category=openapi の関数のみを一覧表示し、デフォルトではローカル Func 関数を除外します。宣言されていない isLocalFunction/funcSourceType/funcCategory/targetWorkspaceUUID パラメータで切り替えることはできません。一覧は現在許可されている候補カタログであり、関数がすでに呼び出されたことを意味しません。また、コードアップロードや関数作成のインターフェースでもありません。

まず関数タイトル/スクリプト/タグで絞り込み、次に content[].id を外部関数の実行の funcId として読み取ります。name、scriptId、url ではありません。kwargsJSON/argsJSON/definition はパラメータ定義とデフォルト値を理解するためのものであり、kwargsJSON の定義オブジェクトをそのまま実際のパラメータ値として扱うことはできません。description/関数ドキュメントに従って実際の業務値を入力してください。一覧はページネーションされず、ネイティブ配列を返します。元のフィールドは Func のバージョンに依存し、タイトルと説明はリクエスト言語に応じてローカライズされる場合があります。

中央 Func の一覧/実行前ホワイトリストにおける従来の SDK アダプテーションでは、上流の HTTP ステータスだけで失敗を判断しません。JSON 辞書では ok=false または数値 0 の場合にのみビジネスエラーを発生させ、HTTP が 200 以外でも ok が省略されている/true の場合は引き続き data を取得する可能性があります。辞書でなく、かつ HTTP が 200 以外の場合にのみ、外部関数エラーとして固定的に報告されます。空のカタログは、上流サービスが正常に接続されていることを単独では証明しません。異常時は管理者がサービスログと合わせて確認してください。

関数の詳細については Func ドキュメント を参照してください。

リクエストヘッダー

パラメータ名 型 必須 説明
DF-API-KEY string Y ワークスペースの OpenAPI 認証情報。
例: <DF-API-KEY>
取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。

Query リクエストパラメータ

パラメータ名 型 必須 説明
_fuzzySearch string 任意の文字列。現在のコントローラマッピングでは破棄され、このエンドポイントでは実際の絞り込み効果はありません。
null を許可: False
例: サンプル
取得または入力方法: この履歴フィールドは現在、中央関数の実際の絞り込みには使用されません。funcTitle を使用してください。
funcId string 任意。中央 Func の id のクエリ条件として使用し、スクリプト ID ではありません。例は実際のデプロイに存在するものに限ります。
null を許可: False
例: example__openapi.test
取得または入力方法: このインターフェースの content[].id から実際の関数 ID を取得します。
funcScriptId string 任意の文字列。中央 Func の scriptId にマッピングされ、完全な funcId ではありません。
例: example__openapi
取得または入力方法: 一覧の scriptId から関数スクリプト集合の識別子を取得します。
funcTags commaarray 任意。カンマ区切りリスト形式の文字列で、公開型名の従来の綴りは commaarray です。文字列として中央 Func に渡され、タグの組み合わせのセマンティクスは同サービスが決定します。
null を許可: False
例: tag-a,tag-b
取得または入力方法: 関数メタデータ内のタグに従って名前を選択します。グローバルタグ UUID ではありません。
funcTitle string 任意。title 条件として中央 Func に渡され、マッチング規則は Func サービスが決定します。ローカルデータベースの LIKE と完全に同一であることは保証されません。
null を許可: False
例: サンプル
取得または入力方法: 一覧の title または関数の用途に基づいてキーワードを選択します。

リクエスト例

curl --get 'https://openapi.guance.com/api/v1/outer_function/list' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --data-urlencode funcId=example__openapi.test

レスポンス

HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示しています。

フィールド 型 説明
content array ネイティブな関数メタデータ配列。pageInfo はなく、空の場合があります。
content[].id string 完全な関数識別子。実行時の funcId はこの値を使用します。
content[].name string 関数の短い名前。完全な id の代わりにはなりません。
content[].title string 表示タイトル。言語によって変化する場合があります。
content[].description string 機能およびパラメータの説明。言語によって変化する場合があります。
content[].category string このエンドポイントでは openapi カテゴリに固定して絞り込みます。実際の値は中央 Func から取得されます。
content[].definition string 関数シグネチャとパラメータのデフォルト値の例。
content[].argsJSON JSON 位置パラメータ定義。通常は文字列配列で、実際のメタデータ形式は Func の戻り値に依存します。
content[].kwargsJSON JSON 辞書パラメータのメタデータ/デフォルト値定義。直接実行できるパラメータインスタンスではありません。
content[].scriptId string スクリプト識別子。funcScriptId の絞り込みに使用します。
content[].url string Func サービス内部の実行パス。Studio OpenAPI Endpoint ではなく、直接結合して呼び出すべきではありません。
content[].isLocalFunction boolean このエンドポイントの中央関数は false です。
content[].funcSourceType string 中央関数は centre です。
content[].declaration object または null 共通ワークスペース宣言。直接配列内の空でないオブジェクト行が追加されます。
content[].その他の Func メタデータフィールド JSON スクリプト/統合/タグ/拡張情報は上流の実際の戻り値に従います。宣言されていない部分は Studio の書き込み可能フィールドとして扱えません。
{
  "code": 200,
  "content": [
    {
      "id": "example__openapi.test",
      "name": "test",
      "title": "サンプルの挨拶",
      "description": "Func 呼び出しチェーンを検証するためのサンプル関数。",
      "category": "openapi",
      "definition": "test(workspace_uuid, workspace_token, your_name=\"OpenAPI User\")",
      "argsJSON": [
        "workspace_uuid",
        "workspace_token",
        "your_name"
      ],
      "kwargsJSON": {
        "workspace_uuid": {},
        "workspace_token": {},
        "your_name": {
          "default": "OpenAPI User"
        }
      },
      "scriptId": "example__openapi",
      "url": "/api/v1/func/example__openapi.test",
      "isLocalFunction": false,
      "funcSourceType": "centre",
      "declaration": {}
    }
  ],
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラーレスポンス

認証、レート制限、および共通リクエストエラーについては、共通エラー定義 を参照してください。

中央 Func サービスに依存します。ローカル Func/フロントエンド呼び出し固有のフィールドをこのエンドポイントの契約として扱わないでください。サービスエラーおよびメタデータの追加キーは実際のバージョンに依存します。

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンスの説明 対処方法
406 ft.ParameterValidationFailed 未宣言の Query パラメータの使用、またはパラメータが規則に違反 パラメータ解析失敗 Query パラメータ表と例を確認してください。
400 ft.OuterFuncFailed 中央 Func が JSON 辞書を返し、ok=false または数値 0(特殊な reason は別途マッピング)、または辞書でなく HTTP が 200 以外 外部関数呼び出し失敗 Func サービスの接続と返された message を確認し、traceId を保持してください。空のリストとリクエスト失敗を混同しないでください。
500 ft.InternalServerError 接続タイムアウト/その他のネットワーク例外、無効な JSON、またはメタデータ構造の異常 内部エラー Func サービスのアドレス/可用性を確認し、traceId を保持してください。タイムアウトエラーはこのエンドポイントでは最終的に一律 500 になります。
400 ft.SameSetTraggerExists 中央 Func の一覧/ホワイトリストが ok=false を返し、reason が EBizCondition.DuplicatedCrontabConfig 同じ設定のトリガーがすでに存在します これは共有 SDK 固有のエラーマッピングです。上流の実際のレスポンスと設定を確認し、本ページのリクエストだけで関数が存在しないと判断しないでください。

フィードバック

このページは役に立ちましたか?