For AI agents: the complete documentation index is available at https://docs.dataplatform.ovh.net/ja/llms.txt, the full documentation bundle is available at https://docs.dataplatform.ovh.net/ja/llms-full.txt, and this page is available as Markdown at https://docs.dataplatform.ovh.net/ja/sdk/api-queries.md.
  • 🇯🇵 日本語
  • クエリを処理する

    Warning

    再作業中、納期未定。 Front App SDK(ReactJS)とFront API SDK(NodeJS)はどちらも置き換えられています。このページは現在のリリースをドキュメント化し、置き換えが出荷されるまで正確であり、維持されます。これに対して書かれたコードは引き続き動作します。

    APIの主要な機能の一つは、外部の世界やアプリケーションからのData Platformデータシステムへのクエリを処理することです。

    クエリにトランスフォーマーを追加して動的に変更したり、新しいクエリエンドポイントを追加したり、Data Platformに渡されるクエリのデータACLを管理したりすることができます。

    外部クエリを転送する APIにクエリトランスフォーマーを追加する APIにクエリエンドポイントを追加する APIにクエリデータACLを追加する

    外部クエリを転送する

    クエリ実行用のWebサービスを設定する

    Webサービスを設定することで、外部のアプライアンス/サービスからクエリを実行できます。返却形式はJSON、CSV、またはXLSXです。

    認証情報を取得する

    デフォルトでは、本番環境ではAPIは他のプロジェクトコンポーネントに対して自己認証されています。しかし、外部の世界から呼び出す場合は、Identity Access Managerを通じて認証する必要があります。

    最良の方法は、ユーザー(またはサービスアカウント)のAPIとシークレットキーを使用して認証トークンを取得するです。

    Webサービスを介してクエリを実行する

    JSON出力

    curl -X POST \
      https://my-project.eu.dataplatform.ovh.net/myapi-api/qb/query?app_id=your_app_id \
      -H 'Content-Type: application/json' \
      -H 'authorization: Bearer your_token' \
      -d '{
        "data": {
          "fields": {
            "date": ["min", "max"]
          }
        }
    }'

    CSV出力

    curl -X POST \
      https://my-project.eu.dataplatform.ovh.net/myapi-api/qb/query.csv?app_id=your_app_id \
      -H 'Content-Type: application/json' \
      -H 'authorization: Bearer your_token' \
      -d '{
        "data": {
          "fields": {
            "date": ["min", "max"]
          }
        }
    }'

    クエリ内のoptionsでCSVの書式設定を制御できます。例えば:

    "options":{
      "collapse": "false", 
      "scales": {
        "x": [
         {"field": "field_name_1", "type":"scale"},
         /*...*/
         {"field": "field_name_n", "type":"scale"}
        ],
        "y": [{"type": "data"}]
      }
    }

    XLSX出力

    curl -X POST \
      https://my-project.eu.dataplatform.ovh.net/myapi-api/qb/query.xlsx?app_id=your_app_id \
      -H 'Content-Type: application/json' \
      -H 'authorization: Bearer your_token' \
      -d '{
        "data": {
          "fields": {
            "date": ["min", "max"]
          }
        }
    }'
    Info

    optionsを使用すると、出力をより良く制御できます。

    Front APIの基本エンドポイントリファレンス

    デフォルトのFront APIに付属する基本エンドポイントのリストです。

    GET /refresh

    キャッシュをフラッシュします。

    レスポンス

    コード説明
    200単純な成功trueメッセージ

    GET /qb/dataset

    Analytics Managerからデータセットを取得します。

    レスポンス

    コード説明
    200Analytics Managerからのデータセット

    POST /qb/query

    Analytics ManagerのJSONリクエストからクエリを実行します。

    レスポンス

    コード説明
    200Analytics Managerからの結果

    GET /webstorage/{key}

    webstorage内のキーに対応する値を取得します。

    パラメータ

    名前位置説明必須スキーマ
    keyパスはい文字列

    レスポンス

    コード説明
    200コンテンツ
    404キーが見つかりません

    PUT /webstorage/{key}

    リクエストボディからの値をwebstorage内のキーに設定します。

    パラメータ

    名前位置説明必須スキーマ
    keyパスはい文字列

    レスポンス

    コード説明
    200新しいコンテンツ

    DELETE /webstorage/{key}

    webstorage内の特定のキーに対応する値を削除します。

    パラメータ

    名前位置説明必須スキーマ
    keyパスはい文字列

    レスポンス

    コード説明
    200前のコンテンツ
    404キーが見つかりません

    さらに詳しく

    当社のソリューションを実装するためのトレーニングや技術サポートが必要な場合は、営業担当者にお問い合わせください、またはこのリンクをクリックして、当社のプロフェッショナルサービスの専門家にプロジェクトのカスタム分析を依頼し、見積もりを受けてください。

    Data Platformを構築するチームと直接質問をし、フィードバックを送信し、相互作用するには、専用のDiscordチャネルにアクセスしてください。

    OVHcloudサービスについてサポートが必要な場合は、ヘルプセンターでリクエストを作成してください。

    ユーザーコミュニティに参加してください。