排程端點

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

主題：
查詢

建立對象：

開發人員

API呼叫範例

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

擷取排定的查詢清單

您可以向/schedules端點發出GET要求，以擷取貴組織的所有已排程查詢清單。

API格式

GET /schedules
GET /schedules?{QUERY_PARAMETERS}

屬性

說明

{QUERY_PARAMETERS}

(Optional)將引數新增至要求路徑，以設定回應中傳回的結果。可以包含多個引數，以&符號(&)分隔。可用的引數列示如下。

查詢引數

以下是列出已排程查詢的可用查詢引數清單。所有這些引數都是選用的。在不使用引數的情況下呼叫此端點將會擷取您的組織可用的所有排程查詢。

參數

說明

orderby

指定排序結果時所依據的欄位。支援的欄位是created和updated。例如，orderby=created將依建立的遞增順序來排序結果。在建立之前(orderby=-created)新增-將會依建立的遞減順序排序專案。

limit

指定頁面大小限制，以控制頁面中包含的結果數量。（預設值： 20）

start

指定ISO格式時間戳記來排序結果。如果未指定開始日期，API呼叫會先傳回最舊建立的排程查詢，然後繼續列出最近的結果。
ISO時間戳記允許在日期和時間有不同的詳細程度等級。基本ISO時間戳記採用2020-09-07格式，以表示日期2020年9月7日。更複雜的範例將寫為2022-11-05T08:15:30-05:00，並對應至2022年11月5日美國東部標準時間上午8:15:30。可以為時區提供UTC時差，並在字尾加上「Z」(2020-01-01T01:01:01Z)表示。如果未提供時區，則預設為零。

property

根據欄位篩選結果。篩選器必須 HTML逸出。逗號可用來組合多組篩選器。支援的欄位是created、templateId和userId。支援的運運算元清單為> （大於）、< （小於）和== （等於）。例如，userId==6ebd9c2d-494d-425a-aa91-24033f3abeec會傳回所有已排程的查詢，其中使用者ID是指定的。

要求

以下請求會擷取為您的組織建立的最新排程查詢。

curl -X GET https://platform.adobe.io/data/foundation/query/schedules?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，其中包含指定組織的已排程查詢清單。下列回應會傳回為您組織建立的最新排程查詢。

{
    "schedules": [
        {
            "state": "ENABLED",
            "query": {
                "dbName": "prod:all",
                "sql": "SELECT * FROM accounts;",
                "name": "Sample Scheduled Query",
                "description": "A sample of a scheduled query."
            },
            "updatedUserId": "{USER_ID}",
            "version": 2,
            "id": "e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm",
            "updated": "1578523458919",
            "schedule": {
                "schedule": "30 * * * *",
                "startDate": "2020-01-08T12:30:00.000Z",
                "maxActiveRuns": 1
            },
            "userId": "{USER_ID}",
            "created": "1578523458919",
            "_links": {
                "enable": {
                    "href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm",
                    "method": "PATCH",
                    "body": "{ \"op\": \"enable\" }"
                },
                "runs": {
                    "href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm/runs",
                    "method": "GET"
                },
                "self": {
                    "href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm",
                    "method": "GET"
                },
                "delete": {
                    "href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm",
                    "method": "DELETE"
                },
                "disable": {
                    "href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm",
                    "method": "PATCH",
                    "body": "{ \"op\": \"disable\" }"
                },
                "trigger": {
                    "href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm/runs",
                    "method": "POST"
                }
            }
        }
    ],
    "_page": {
        "orderby": "+created",
        "start": "2020-01-08T22:44:18.919Z",
        "count": 1
    },
    "_links": {},
    "version": 2
}

建立新的排程查詢

您可以對/schedules端點發出POST要求，以建立新的排程查詢。當您在API中建立排程查詢時，也可以在查詢編輯器中看到它。如需UI中已排程查詢的詳細資訊，請參閱查詢編輯器檔案。

API格式

POST /schedules

要求

curl -X POST https://platform.adobe.io/data/foundation/query/schedules
 -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 '
 {
     "query": {
         "dbName": "prod:all",
         "sql": "SELECT * FROM accounts;",
         "name": "Sample Scheduled Query",
         "description": "A sample of a scheduled query."
     },
     "schedule": {
         "schedule": "30 * * * *",
         "startDate": "2020-01-08T12:30:00.000Z"
     }
 }
 '

屬性

說明

query.dbName

您正在建立排定查詢的資料庫名稱。

query.sql

您要建立的SQL查詢。

query.name

排定的查詢名稱。

schedule.schedule

查詢的cron排程。如需cron排程的詳細資訊，請參閱cron運算式格式檔案。在此範例中，「30 * * * *」表示查詢將每小時在30分鐘標籤處執行。

或者，您可以使用下列簡寫運算式：

@once：查詢只執行一次。
@hourly：查詢會在每小時的開頭執行。這相當於cron運算式0 * * * *。
@daily：查詢每天午夜執行一次。這相當於cron運算式0 0 * * *。
@weekly：查詢每週執行一次、星期日、午夜。這相當於cron運算式0 0 * * 0。
@monthly：查詢每個月執行一次，於當月的第一天午夜執行。這相當於cron運算式0 0 1 * *。
@yearly：查詢每年執行一次，於1月1日午夜。這相當於cron運算式1 0 0 1 1 *。

schedule.startDate

您排程查詢的開始日期，以UTC時間戳記寫入。

回應

成功的回應會傳回HTTP狀態202 （已接受）以及您新建立的排程查詢的詳細資料。排定的查詢啟動完成後，state將從REGISTERING變更為ENABLED。

{
    "state": "REGISTERING",
    "query": {
        "dbName": "prod:all",
        "sql": "SELECT * FROM accounts;",
        "name": "Sample Scheduled Query",
        "description": "A sample of a scheduled query."
    },
    "updatedUserId": "{USER_ID}",
    "version": 2,
    "id": "e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm",
    "schedule": {
        "schedule": "30 * * * *",
        "startDate": "2020-01-08T12:30:00.000Z",
        "maxActiveRuns": 1
    },
    "userId": "{USER_ID}",
    "_links": {
        "enable": {
            "href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm",
            "method": "PATCH",
            "body": "{ \"op\": \"enable\" }"
        },
        "runs": {
            "href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm/runs",
            "method": "GET"
        },
        "self": {
            "href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm",
            "method": "GET"
        },
        "delete": {
            "href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm",
            "method": "DELETE"
        },
        "disable": {
            "href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm",
            "method": "PATCH",
            "body": "{ \"op\": \"disable\" }"
        },
        "trigger": {
            "href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm/runs",
            "method": "POST"
        }
    }
}

NOTE

您可以使用_links.delete的值刪除您建立的排程查詢。

要求指定排定查詢的詳細資料

您可以對/schedules端點發出GET要求，並在要求路徑中提供其ID，以擷取特定排程查詢的資訊。

API格式

GET /schedules/{SCHEDULE_ID}

屬性

說明

{SCHEDULE_ID}

您要擷取的排定查詢的id值。

要求

curl -X GET https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm
 -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": "ENABLED",
    "query": {
        "dbName": "prod:all",
        "sql": "SELECT * FROM accounts;",
        "name": "Sample Scheduled Query",
        "description": "A sample of a scheduled query."
    },
    "updatedUserId": "{USER_ID}",
    "version": 2,
    "id": "e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm",
    "updated": "1578523458919",
    "schedule": {
        "schedule": "30 * * * *",
        "startDate": "2020-01-08T12:30:00.000Z",
        "maxActiveRuns": 1
    },
    "userId": "{USER_ID}",
    "created": "1578523458919",
    "_links": {
        "enable": {
            "href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm",
            "method": "PATCH",
            "body": "{ \"op\": \"enable\" }"
        },
        "runs": {
            "href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm/runs",
            "method": "GET"
        },
        "self": {
            "href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm",
            "method": "GET"
        },
        "delete": {
            "href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm",
            "method": "DELETE"
        },
        "disable": {
            "href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm",
            "method": "PATCH",
            "body": "{ \"op\": \"disable\" }"
        },
        "trigger": {
            "href": "https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm/runs",
            "method": "POST"
        }
    }
}

NOTE

您可以使用_links.delete的值刪除您建立的排程查詢。

更新指定排定查詢的詳細資料

您可以對/schedules端點發出PATCH要求，並在要求路徑中提供其ID，以更新指定排程查詢的詳細資料。

PATCH要求支援兩個不同的路徑： /state和/schedule/schedule。

更新排定的查詢狀態

您可以將path屬性設定為/state，並將value屬性設定為enable或disable，以更新所選排程查詢的狀態。

API格式

PATCH /schedules/{SCHEDULE_ID}

屬性

說明

{SCHEDULE_ID}

您要PATCH之排定查詢的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
 -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 '{
     "body": [
         {
             "op": "replace",
             "path": "/state",
             "value": "disable"
         }
     ]
 }'

屬性

說明

op

要對查詢排程執行的作業。接受的值為replace。

path

您要修補的值的路徑。在此情況下，由於您正在更新排定的查詢狀態，因此您需要將path的值設定為/state。

value

/state的更新值。此值可以設為enable或disable以啟用或停用排定的查詢。

回應

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

{
    "message": "Request to patch accepted",
    "statusCode": 202
}

更新排定的查詢排程

您可以在要求內文中將path屬性設定為/schedule/schedule，以更新排程查詢的cron排程。如需cron排程的詳細資訊，請參閱cron運算式格式檔案。

API格式

PATCH /schedules/{SCHEDULE_ID}

屬性

說明

{SCHEDULE_ID}

您要PATCH之排定查詢的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
 -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 '{
     "body": [
         {
             "op": "replace",
             "path": "/schedule/schedule",
             "value": "45 * * * *"
         }
     ]
 }'

屬性

說明

op

要對查詢排程執行的作業。接受的值為replace。

path

您要修補的值的路徑。在此情況下，由於您正在更新排定的查詢排程，因此您需要將path的值設定為/schedule/schedule。

value

/schedule的更新值。此值必須採用cron排程的形式。因此，在此範例中，排定的查詢將每小時在45分鐘標籤處執行。

回應

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

{
    "message": "Request to patch accepted",
    "statusCode": 202
}

刪除指定的排定查詢

您可以向/schedules端點發出DELETE要求，並在要求路徑中提供您要刪除之排程查詢的識別碼，以刪除指定的排程查詢。

NOTE

刪除排程 之前必須 停用。

API格式

DELETE /schedules/{SCHEDULE_ID}

屬性

說明

{SCHEDULE_ID}

您要DELETE之排定查詢的id值。

要求

curl -X DELETE https://platform.adobe.io/data/foundation/query/schedules/e95186d65a28abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm
 -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": "Schedule deleted successfully",
    "statusCode": 202
}

recommendation-more-help

ccf2b369-4031-483f-af63-a93b5ae5e3fb