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

エンドポイント

  • エンドポイントは、exaBase Studioで構築したアプリケーションをデプロイした際に、実際のWebブラウザからアクセスできるURIの設定をすることが可能です。

    例：https://xxxx.xx/test の /test 部分のことを指します。

エンドポイントのアクセスURL​

  • エンドポイントには２つの形式のアクセスURLが提供されます。exaBase Studioドメインとワークスペースドメインです。

    • exaBase Studioのドメイン：サブディレクトリとしてネームスペースIDとワークスペースIDがつきます。 　https://studio.{env-id}.studio.exabase.ai/{namespace-id}/{workspace-id}/{endpoint-uri}/

    • ワークスペースドメイン：ネームスペースIDとワークスペースIDで生成されたハッシュを含まれており、各ワークスペース独自のドメインになります。サブディレクトリはエンドポイントに定義したURI以外つきません。 https://{workspace-hash}.circuits.{env-id}.studio.exabase.ai/{endpoint-uri}/

備考

exaBase Studioのドメインまたはワークスペースドメインに合わせて開発されたアプリケーションはもう一つのアクセスURLで動作しない場合があります。

endpoint-config

Endpointと接続可能なノード​

ノードタイプ想定される用途
EntityEntityに値を書き込んだり、Entityの値を読み込んだりできます。詳細は API を参照してください
SideAppSideAppにCircuit外部からアクセスするためのインターフェースを作成できます。接続先サービスのポート番号を指定できます
PipelinePipelineを直接実行するエンドポイントを作成できます。メソッドはPipelineに接続したEndpointを参照してください

URIの指定​

  • 任意のURIを指定することができます。
  • 入力の最初に / が必要です
  • /のみの入力も可能です

読み取り・書き込みの設定​

  • Entityに接続されているEndpointを選択するとオプションが表示され、読み取り専用、書き込み専用、読み取り・書き込みの設定を切り替えることが可能です。

接続先サービスのポート番号の指定​

  • SideAppと接続した際にEndpointノードを選択すると、接続先サービスのポート番号と、EndpointからSideAppへのアクセス時の Path を指定することができます。Path を設定しない場合、Blueprint上では / として扱われます。
    (Path はエンドポイントURLに影響を与えません。)

Pipelineに接続したEndpoint​

  • PipelineノードにEndpointを接続することでAPIを通じたPipelineの操作が可能となります

Pipelineを実行する​

  • 空のJSONをEndpointURLにPOSTするとPipelineを実行できます
  • Content-type を application/json を指定してください

サンプルコマンド​

curl -X POST https://studio.{env-id}.studio.exabase.ai/{namespace-id}/{workspace-id}/{endpoint-uri}/ -H "Content-Type: application/json" -d "{}"

LayerIDを指定してPipelineを実行する​

  • JSONのkeyに"layerid"、valueにlayerid自体を入力してEndpointURLにポストすることでLayeredのPipelineを実行できます
  • Content-type を application/json を指定してください
curl -X POST https://studio.{env-id}.studio.exabase.ai/{namespace-id}/{workspace-id}/{endpoint-uri}/ -H "Content-Type: application/json" -d "{"layerid": "value"}"