ForePaaS APIs

Warning

このページでは、ForePaaS レガシープラットフォームについて説明します。このプラットフォームは、新規登録を受け付けていません。OVHcloud Data Platformをご利用の場合は、Data Platform APIsを参照してください。

グラフィカルユーザーインターフェース（GUI）に加えて、ForePaaS プロジェクトをForePaaS APIのエンドポイントを通じて操作することもできます。これは、ForePaaS プロジェクトの構築と管理に関するGUIの代替手段として、開発者向けのものです。

各コンポーネントのAPIリファレンスを以下に示します。

APIリファレンス	主な使用コンテキスト
Buckets	Lakehouse Managerのバケットと相互作用します。
Query Builder	Query Builderおよびそのメタデータと相互作用します。
Identity Access Manager	通常、認証を管理するためにIdentity Access Manager (IAM)と相互作用します。
ForePaaS Store	通常、アプリケーションのモジュールまたはアプリケーションのテンプレートを管理するためにForePaaS Storeと相互作用します。

一般的な形式

コード	メッセージ	意味
200	OK	非空のコンテンツを含む成功したGETまたはPOSTリクエストのデフォルトレスポンス
400	Bad Request	GETまたはPOSTパラメータの無効な値
401	Unauthorized	無効な資格情報または権限
403	Forbidden	認証エラー
404	Not Found	アクションまたはリクエストが見つかりません
500	Internal Server	サーバーサイドエラーが発生しました

クライアントサイド（HTTPステータスコード4xx）またはサーバーサイド（HTTPステータスコード5xx）のエラーが発生した場合、レスポンスボディにはエラーを説明するJSONオブジェクトが含まれている場合があります。

{
   "error": "Invalid parameter", // code 400, 403, 500
   "warning": "Action not found" // code 404
}

すべてのデータエンドポイントは、提供されたデータに関連付けられたタイムスタンプを返します。

{
    "timestamp": 1435929960
}

すべてのデータエンドポイントは、期間属性を返します。これは、システムがリクエストを実行するのに要した実際の時間を秒単位で表します。

{
    "duration": 0.056
}