查詢終結點

示例API調用

以下部分將介紹您可以使用 /queries 端點 Query Service API。每個調用包括一般API格式、顯示所需標頭的示例請求和示例響應。

檢索查詢清單

通過向IMS組織發出GET請求，您可以檢索IMS組織的所有查詢清單 /queries 端點。

API格式

GET /queries
GET /queries?{QUERY_PARAMETERS}

{QUERY_PARAMETERS}:(可選)添加到請求路徑中的參數，該路徑配置在響應中返回的結果。可以包括多個參數，用和符號分隔(&)。下面列出了可用參數。

查詢參數

以下是用於列出查詢的可用查詢參數的清單。所有這些參數都是可選的。在沒有參數的情況下調用此終結點將檢索可用於您的組織的所有查詢。

參數	說明
`orderby`	指定對結果排序依據的欄位。支援的欄位為 `created` 和 `updated`。比如說， `orderby=created` 將按建立結果的升序排序。添加 `-` 之前建立(`orderby=-created`)將按降序順序建立項。
`limit`	指定頁面大小限制以控制頁面中包含的結果數。 (預設值：20)
`start`	使用基於零的編號來偏移響應清單。比如說， `start=2` 將返回從第三個列出的查詢開始的清單。 (預設值：0)
`property`	根據欄位篩選結果。篩選器必須是HTML逃了。使用逗號組合多組篩選器。支援的欄位為 `created`。 `updated`。 `state`, `id`。支援的運算子清單為 `>` （大於）, `<` （小於）, `>=` （大於或等於）, `<=` （小於或等於）, `==` （等於）, `!=` （不等於），和 `~` （包含）。比如說， `id==6ebd9c2d-494d-425a-aa91-24033f3abeec` 將返回具有指定ID的所有查詢。
`excludeSoftDeleted`	指示是否應包括已軟刪除的查詢。比如說， `excludeSoftDeleted=false` 會包括軟刪除的查詢。 (布爾值，預設值：真)
`excludeHidden`	指示是否應顯示非用戶驅動的查詢。將此值設定為false將包括非用戶驅動的查詢，如CURSOR定義、FETCH或元資料查詢。 (布爾值，預設值：真)

要求

以下請求將檢索為IMS組織建立的最新查詢。

curl -X GET https://platform.adobe.io/data/foundation/query/queries?limit=1 \
 -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，其中列出了指定IMS組織的查詢清單(JSON)。以下響應返回為IMS組織建立的最新查詢。

{
    "queries": [
        {
            "isInsertInto": false,
            "request": {
                "dbName": "prod:all",
                "sql": "SELECT *\nFROM\n  accounts\nLIMIT 10\n"
            },
            "state": "SUCCESS",
            "rowCount": 0,
            "errors": [],
            "isCTAS": false,
            "version": 1,
            "id": "9957bd7f-2244-4fd5-91bc-077d7df1d8e5",
            "elapsedTime": 28,
            "updated": "2019-12-06T22:00:17.390Z",
            "client": "Adobe Query Service UI",
            "userId": "{USER_ID}",
            "created": "2019-12-06T22:00:17.362Z",
            "_links": {
                "self": {
                    "href": "https://platform.adobe.io/data/foundation/query/queries/9957bd7f-2244-4fd5-91bc-077d7df1d8e5",
                    "method": "GET"
                },
                "soft_delete": {
                    "href": "https://platform.adobe.io/data/foundation/query/queries/9957bd7f-2244-4fd5-91bc-077d7df1d8e5",
                    "method": "PATCH",
                    "body": "{ \"op\": \"soft_delete\"}"
                },
                "referenced_datasets": [
                    {
                        "id": "5b2bdd32230d4401de87397c",
                        "href": "https://platform.adobe.io/data/foundation/catalog/dataSets/5b2bdd32230d4401de87397c"
                    }
                ]
            }
        }
    ],
    "_page": {
        "orderby": "-created",
        "start": "2019-12-06T22:00:17.362Z",
        "next": "2019-08-01T00:14:21.748Z",
        "count": 1
    },
    "_links": {
        "next": {
            "href": "https://platform.adobe.io/data/foundation/query/queries?orderby=-created&start=2019-08-01T00:14:21.748Z"
        },
        "prev": {
            "href": "https://platform.adobe.io/data/foundation/query/queries?orderby=-created&start=2019-12-06T22:00:17.362Z&isPrevLink=true"
        }
    },
    "version": 1
}

建立查詢

可以通過向POST /queries 端點。

API格式

POST /queries

要求

以下請求將建立一個新查詢，該查詢由負載中提供的值配置：

curl -X POST https://platform.adobe.io/data/foundation/query/queries \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '{
        "dbName": "prod:all",
        "sql": "SELECT * FROM accounts;",
        "name": "Sample Query",
        "description": "Sample Description"
    }

屬性	說明
`dbName`	要為其建立SQL查詢的資料庫的名稱。
`sql`	要建立的SQL查詢。
`name`	SQL查詢的名稱。
`description`	SQL查詢的說明。

回應

成功的響應返回HTTP狀態202（已接受），並返回新建立的查詢的詳細資訊。激活完查詢並成功運行後， state 將從 SUBMITTED 至 SUCCESS。

{
    "isInsertInto": false,
    "request": {
        "dbName": "prod:all",
        "sql": "SELECT * FROM accounts;",
        "name": "Sample Query",
        "description": "Sample Description"
    },
    "state": "SUBMITTED",
    "rowCount": 0,
    "errors": [],
    "isCTAS": false,
    "version": 1,
    "id": "4d64cd49-cf8f-463a-a182-54bccb9954fc",
    "elapsedTime": 0,
    "updated": "2020-01-08T21:47:46.865Z",
    "client": "API",
    "userId": "{USER_ID}",
    "created": "2020-01-08T21:47:46.865Z",
    "_links": {
        "self": {
            "href": "https://platform.adobe.io/data/foundation/query/queries/4d64cd49-cf8f-463a-a182-54bccb9954fc",
            "method": "GET"
        },
        "soft_delete": {
            "href": "https://platform.adobe.io/data/foundation/query/queries/4d64cd49-cf8f-463a-a182-54bccb9954fc",
            "method": "PATCH",
            "body": "{ \"op\": \"soft_delete\"}"
        },
        "cancel": {
            "href": "https://platform.adobe.io/data/foundation/query/queries/4d64cd49-cf8f-463a-a182-54bccb9954fc",
            "method": "PATCH",
            "body": "{ \"op\": \"cancel\"}"
        }
    }
}

注意

可以使用 _links.cancel 至取消已建立的查詢。

按ID檢索查詢

可通過向GET請求來檢索有關特定查詢的詳細資訊 /queries 終結點和提供查詢 id 值。

API格式

GET /queries/{QUERY_ID}

屬性	說明
`{QUERY_ID}`	的 `id` 要檢索的查詢的值。

要求

curl -X GET https://platform.adobe.io/data/foundation/query/queries/4d64cd49-cf8f-463a-a182-54bccb9954fc \
 -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，其中包含有關指定查詢的詳細資訊。

{
    "isInsertInto": false,
    "request": {
        "dbName": "prod:all",
        "sql": "SELECT * FROM accounts;",
        "name": "Sample Query",
        "description": "Sample Description"
    },
    "state": "SUBMITTED",
    "rowCount": 0,
    "errors": [],
    "isCTAS": false,
    "version": 1,
    "id": "4d64cd49-cf8f-463a-a182-54bccb9954fc",
    "elapsedTime": 0,
    "updated": "2020-01-08T21:47:46.865Z",
    "client": "API",
    "userId": "{USER_ID}",
    "created": "2020-01-08T21:47:46.865Z",
    "_links": {
        "self": {
            "href": "https://platform.adobe.io/data/foundation/query/queries/4d64cd49-cf8f-463a-a182-54bccb9954fc",
            "method": "GET"
        },
        "soft_delete": {
            "href": "https://platform.adobe.io/data/foundation/query/queries/4d64cd49-cf8f-463a-a182-54bccb9954fc",
            "method": "PATCH",
            "body": "{ \"op\": \"soft_delete\"}"
        },
        "cancel": {
            "href": "https://platform.adobe.io/data/foundation/query/queries/4d64cd49-cf8f-463a-a182-54bccb9954fc",
            "method": "PATCH",
            "body": "{ \"op\": \"cancel\"}"
        }
    }
}

注意

可以使用 _links.cancel 至取消已建立的查詢。

取消查詢

您可以請求刪除指定的查詢，方法是向 /queries 終結點和提供查詢 id 值。

API格式

PATCH /queries/{QUERY_ID}

屬性	說明
`{QUERY_ID}`	的 `id` 要取消的查詢的值。

要求

此API請求使用JSON修補程式語法作為其負載。有關JSON修補程式如何工作的詳細資訊，請閱讀API基礎文檔。

curl -X PATCH https://platform.adobe.io/data/foundation/query/queries/4d64cd49-cf8f-463a-a182-54bccb9954fc \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json',
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'
 -d '{
   "op": "cancel"
 }'

屬性	說明
`op`	要取消查詢，必須使用值設定op參數 `cancel` 。

回應

成功的響應返回HTTP狀態202（已接受），並顯示以下消息：

{
    "message": "Query cancel request received",
    "statusCode": 202
}

Business.Adobe.com 資源

Asset Collections Customer Journey Data Ingestion Web Analytics Attribution Search Marketing Management

全新的改善搜尋

查詢終結點

示例API調用

檢索查詢清單

建立查詢

按ID檢索查詢

取消查詢

Business.Adobe.com 資源

本頁內容

檢視下一個:

學習

說明文件

社群

技術支援

資源

Adobe 帳戶

Adobe