排定的查詢執行端點

API呼叫範例

現在您已瞭解要使用哪些標頭，可以開始對 Query Service API。以下小節會逐步解說您可以使用進行的各種API呼叫 Query Service API。每個呼叫都包含一般API格式、顯示必要標題的範例要求以及範例回應。

擷取指定排程查詢的所有執行清單

您可以擷取特定排程查詢的所有執行清單，不論它們目前是否正在執行或已完成。這可透過向以下網站發出GET請求來完成： /schedules/{SCHEDULE_ID}/runs 端點，其中 {SCHEDULE_ID} 是 id 您要擷取其執行的已排程查詢的值。

API格式

GET /schedules/{SCHEDULE_ID}/runs
GET /schedules/{SCHEDULE_ID}/runs?{QUERY_PARAMETERS}

屬性	說明
`{SCHEDULE_ID}`	此 `id` 您要擷取的排定查詢值。
`{QUERY_PARAMETERS}`	(可選)將引數新增至要求路徑，以設定回應中傳回的結果。可包含多個引數，以&符號(`&`)。可用的引數列示如下。

查詢引數

以下為可用查詢引數清單，列出指定排程查詢的執行。所有這些引數都是選用的。在不使用引數的情況下呼叫此端點將會擷取可用於指定排程查詢的所有執行。

參數	說明
`orderby`	指定排序結果時所依據的欄位。支援的欄位包括 `created` 和 `updated`. 例如， `orderby=created` 將依建立的結果遞增順序來排序結果。新增 `-` 建立前(`orderby=-created`)會依建立的順序遞減排序專案。
`limit`	指定頁面大小限制，以控制頁面中包含的結果數量。 (預設值： 20)
`start`	使用以零為基準的編號來位移回應清單。例如， `start=2` 會傳回從第三個查詢開始的清單。 (預設值： 0)
`property`	根據欄位篩選結果。篩選器必須已逸出HTML。逗號可用來組合多組篩選器。支援的欄位包括 `created`， `state`、和 `externalTrigger`. 支援的運運算元清單包括 `>` （大於）， `<` （小於），和 `==` （等於），和 `!=` （不等於）。例如， `externalTrigger==true,state==SUCCESS,created>2019-04-20T13:37:00Z` 將會傳回在2019年4月20日之後手動建立、成功和建立的所有執行。

要求

以下請求會擷取指定之排程查詢的最後四個執行。

curl -X GET https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm/runs?limit=4
 -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，其中包含指定排程查詢的執行清單，其形式為JSON。下列回應會傳回指定之排程查詢的最後四個執行。

{
    "runsSchedules": [
        {
            "state": "SUCCESS",
            "version": 1,
            "id": "c2NoZWR1bGVkX18yMDIwLTAxLTA4VDEyOjMwOjAwKzAwOjAw",
            "externalTrigger": "false",
            "created": "2020-01-08T12:30:00Z",
            "_links": {
                "self": {
                    "href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm/runs/c2NoZWR1bGVkX18yMDIwLTAxLTA4VDEyOjMwOjAwKzAwOjAw",
                    "method": "GET"
                },
                "cancel": {
                    "href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm/runs/c2NoZWR1bGVkX18yMDIwLTAxLTA4VDEyOjMwOjAwKzAwOjAw",
                    "method": "PATCH",
                    "body": "{ \"op\": \"cancel\" }"
                }
            }
        },
        {
            "state": "SUCCESS",
            "version": 1,
            "id": "c2NoZWR1bGVkX18yMDIwLTAxLTA4VDEzOjMwOjAwKzAwOjAw",
            "externalTrigger": "false",
            "created": "2020-01-08T13:30:00Z",
            "_links": {
                "self": {
                    "href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm/runs/c2NoZWR1bGVkX18yMDIwLTAxLTA4VDEzOjMwOjAwKzAwOjAw",
                    "method": "GET"
                },
                "cancel": {
                    "href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm/runs/c2NoZWR1bGVkX18yMDIwLTAxLTA4VDEzOjMwOjAwKzAwOjAw",
                    "method": "PATCH",
                    "body": "{ \"op\": \"cancel\" }"
                }
            }
        },
        {
            "state": "SUCCESS",
            "version": 1,
            "id": "c2NoZWR1bGVkX18yMDIwLTAxLTA4VDE0OjMwOjAwKzAwOjAw",
            "externalTrigger": "false",
            "created": "2020-01-08T14:30:00Z",
            "_links": {
                "self": {
                    "href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm/runs/c2NoZWR1bGVkX18yMDIwLTAxLTA4VDE0OjMwOjAwKzAwOjAw",
                    "method": "GET"
                },
                "cancel": {
                    "href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm/runs/c2NoZWR1bGVkX18yMDIwLTAxLTA4VDE0OjMwOjAwKzAwOjAw",
                    "method": "PATCH",
                    "body": "{ \"op\": \"cancel\" }"
                }
            }
        },
        {
            "state": "IN_PROGRESS",
            "version": 1,
            "id": "c2NoZWR1bGVkX18yMDIwLTAxLTA4VDE4OjQ1OjAwKzAwOjAw",
            "externalTrigger": "false",
            "created": "2020-01-08T15:30:00Z",
            "_links": {
                "self": {
                    "href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm/runs/c2NoZWR1bGVkX18yMDIwLTAxLTA4VDE4OjQ1OjAwKzAwOjAw",
                    "method": "GET"
                },
                "cancel": {
                    "href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm/runs/c2NoZWR1bGVkX18yMDIwLTAxLTA4VDE4OjQ1OjAwKzAwOjAw",
                    "method": "PATCH",
                    "body": "{ \"op\": \"cancel\" }"
                }
            }
        }
    ],
    "_page": {
        "orderby": "+created",
        "start": "2020-01-08T12:30:00Z",
        "count": 4
    },
    "_links": {},
    "version": 1
}

注意

您可以使用以下專案的值： _links.cancel 至停止執行指定的排程查詢.

立即觸發特定排程查詢的執行

您可以透過向以下專案發出POST要求，立即觸發指定排程查詢的執行： /schedules/{SCHEDULE_ID}/runs 端點，其中 {SCHEDULE_ID} 是 id 您要觸發其執行的已排程查詢的值。

API格式

POST /schedules/{SCHEDULE_ID}/runs

要求

curl -X POST https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm/runs
 -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狀態202 （已接受），並出現以下訊息。

{
    "message": "Request to trigger run of a scheduled query accepted.",
    "statusCode": 202
}

擷取特定排程查詢的執行詳細資料

您可以透過向以下專案發出GET要求，擷取特定排程查詢之執行的相關詳細資訊： /schedules/{SCHEDULE_ID}/runs/{RUN_ID} 端點，並提供排程查詢的ID和請求路徑中的執行。

API格式

GET /schedules/{SCHEDULE_ID}/runs/{RUN_ID}

屬性	說明
`{SCHEDULE_ID}`	此 `id` 您要擷取其詳細資訊之執行已排程查詢的值。
`{RUN_ID}`	此 `id` 要擷取的執行值。

要求

curl -X GET https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm/runs/c2NoZWR1bGVkX18yMDIwLTAxLTA4VDIwOjQ1OjAwKzAwOjAw
 -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以及指定執行的詳細資訊。

{
    "state": "success",
    "taskStatusList": [
        {
            "duration": 303,
            "endDate": "2020-01-08T23:49:02.346318",
            "state": "SUCCESS",
            "message": "Processed Successfully",
            "startDate": "2020-01-08T23:43:58.936269",
            "taskId": "7Omob151BM"
        }
    ],
    "version": 1,
    "id": "c2NoZWR1bGVkX18yMDIwLTAxLTA4VDIwOjQ1OjAwKzAwOjAw",
    "scheduleId": "e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm",
    "externalTrigger": "false",
    "created": "2020-01-08T20:45:00",
    "_links": {
        "self": {
            "href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm/runs/c2NoZWR1bGVkX18yMDIwLTAxLTA4VDIwOjQ1OjAwKzAwOjAw",
            "method": "GET"
        },
        "cancel": {
            "href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm/runs/c2NoZWR1bGVkX18yMDIwLTAxLTA4VDIwOjQ1OjAwKzAwOjAw",
            "method": "PATCH",
            "body": "{ \"op\": \"cancel\" }"
        }
    }
}

立即停止特定排程查詢的執行

您可以透過向發出PATCH要求，立即停止特定排程查詢的執行 /schedules/{SCHEDULE_ID}/runs/{RUN_ID} 端點，並提供排程查詢的ID和請求路徑中的執行。

API格式

PATCH /schedules/{SCHEDULE_ID}/runs/{RUN_ID}

屬性	說明
`{SCHEDULE_ID}`	此 `id` 您要擷取其詳細資訊之執行已排程查詢的值。
`{RUN_ID}`	此 `id` 要擷取的執行值。

要求

此API要求對其裝載使用JSON修補程式語法。如需JSON修補程式運作方式的詳細資訊，請參閱API基礎檔案。

curl -X PATCH https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm/runs/c2NoZWR1bGVkX18yMDIwLTAxLTA4VDIwOjQ1OjAwKzAwOjAw
 -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}'
 -d '{
     "op": "cancel"
 }'

回應

成功的回應會傳回HTTP狀態202 （已接受），並出現以下訊息。

{
    "message": "Request to cancel run of a scheduled query accepted",
    "statusCode": 202
}

Business.Adobe.com 資源

Recommendation Engine Content Intelligence Digital Asset Management Ad Hoc Analysis Web Analytics Advertising

排定的查詢執行端點

API呼叫範例

擷取指定排程查詢的所有執行清單

立即觸發特定排程查詢的執行

擷取特定排程查詢的執行詳細資料

立即停止特定排程查詢的執行

Business.Adobe.com 資源

本頁內容

檢視下一個:

學習

檔案

社群

支援

資源

Adobe帳戶

Adobe