メインコンテンツまでスキップ

ファンクションAPI エンドポイント

1. ファンクション作成エンドポイント

  • メソッド: POST

  • パラメータ:

    • functionName: ファンクション名。
    • sdkVersion: ファンクションで使用されている SDK のバージョン(例:0.45.3)。
    • templateLanguageTag: ファンクションのコードテンプレート(例:Qiskit、CUDA など)。
    • description: ファンクションの説明(オプション)。
  • レスポンス:

    成功: 200 OK ステータスを返し、作成されたファンクションの詳細を返却します。内容は以下のとおりです:

    • functionId: ファンクションの一意な識別子。

    • functionName: ファンクション名。

    • templateLanguageTag: 使用されるコードテンプレート(例:Qiskit、CUDA)。

    • description: ファンクションの任意の説明。

    • templateFiles: ファンクション初期化時に使用されるテンプレートファイルの一覧。以下の情報を含みます。

      • ファイル名
      • 言語
      • コンテンツ
    • functionVersion: ファンクションバージョンの詳細(任意)。

      • id: ファンクションバージョン ID。
      • version: バージョン番号。
      • inDeployed: デプロイ状態。
      • createdDate: 作成日時。
      • files: ストレージメタデータ(id、versionId、key、size、status)を含むアップロード済みファイル。

2. ファンクションバージョンを作成します

  • メソッド: POST

  • パラメータ:

    • function_id: 編集するファンクションの ID。

    • description: 更新後の説明部分(任意入力)。

    • templateFiles: ファンクション初期化時に使用されるテンプレートファイルの一覧。以下の情報を含みます。

      • ファイル名
      • 言語
      • コンテンツ
  • レスポンス:

成功時:200 OK ステータスを返し、作成されたファンクションバージョンの詳細を返却します。内容は以下のとおりです。

  • id: ファンクションバージョン ID。
  • version: バージョン番号。
  • inDeployed: デプロイ状態。
  • createdDate: 作成日時。
  • files: ストレージメタデータ(id、versionId、key、size、status)を含むアップロード済みファイル。

3. ファンクション詳細表示エンドポイント

  • メソッド: GET

  • パラメータ:

    • function_id: 詳細を表示するファンクションの ID。
  • レスポンス:

    • 成功: 200 OK ステータスを返し、ファンクションの詳細情報を返却します。内容には、関数名、SDK、SDK バージョン、ソースコード、バージョン、バージョン一覧、ステータス、デプロイ情報、およびログが含まれます。

4. ファンクション削除エンドポイント

  • メソッド: DELETE

  • パラメータ:

    • function_id: 削除するファンクションの ID。
  • レスポンス:

    • 成功: 200 OK ステータスを返し、削除の成功を確認します。