接続パラメーターエンドポイント

API呼び出しの例

次の節では、Query Service APIを使用して実行できるAPI呼び出しについて説明します。 呼び出しには、一般的なAPI形式、必要なヘッダーを示すサンプルリクエスト、およびサンプル応答が含まれます。

リクエスト接続パラメーター

接続パラメーターを取得するには、/connection_parameters エンドポイントに対してGET リクエストを実行します。 インタラクティブサービスを介した接続に接続パラメーターを使用するクライアントについては、クエリサービスクライアントに関するドキュメントを参照してください。

API 形式

GET /connection_parameters

リクエスト

curl -X GET https://platform.adobe.io/data/foundation/query/connection_parameters
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

応答

リクエストが成功した場合、HTTP ステータス 200 と接続パラメーターが返されます。

{
    "username": "{USERNAME}",
    "dbName": "prod:all",
    "host": "{HOSTNAME}",
    "version": 1,
    "port": 80,
    "token": "{TOKEN}",
    "compressedToken": "{COMPRESSED_TOKEN}",
    "websocketHost": "{WEBSOCKET_HOSTNAME}"
}