警報訂閱端點

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

主題：
查詢

建立對象：

開發人員

Adobe Experience Platform查詢服務可讓您針對臨時和已排程的查詢訂閱警報。警報可透過電子郵件、Platform UI內或兩者來接收。平台內警報和電子郵件警報的通知內容相同。

快速入門

本指南中使用的端點是Adobe Experience Platform 查詢服務API的一部分。繼續之前，請檢閱快速入門手冊以取得您成功呼叫API所需瞭解的重要資訊，包括必要的標頭以及如何讀取範例API呼叫。

IMPORTANT

若要接收電子郵件警示，您必須先在UI中啟用此設定。請參閱檔案，以取得如何啟用電子郵件警示的指示。

警示型別 alert-types

下表說明支援的查詢警示型別：

IMPORTANT

查詢服務API目前不支援delay或查詢執行延遲警示型別。如果排程查詢執行的結果延遲超過指定的臨界值，此警報會通知您。若要使用此警示，您必須設定自訂時間，在查詢執行期間未完成或未失敗時觸發警示。若要瞭解如何在UI中設定此警報，請參閱查詢排程檔案或內嵌查詢動作指南。

警報類型

說明

start

此警報會在排定的查詢執行起始或開始處理時通知您。

success

此警報會在排定的查詢執行成功完成時通知您，表示查詢執行時沒有任何錯誤。

failed

排定的查詢執行發生錯誤或無法成功執行時，就會觸發此警報。它有助於您及時識別並解決問題。

quarantine

當排程的查詢執行進入隔離狀態時，此警報便會啟動。將查詢註冊到隔離功能後，任何連續十次執行失敗的排定查詢都會自動進入隔離狀態。然後需要您的介入才能進行任何進一步的執行。

NOTE

所有非SELECT查詢都支援警報訂閱，您不需要是查詢建立者即可訂閱警報。其他使用者也可以在未建立的查詢上註冊警報。

下列警示套用時不含警示訂閱：

批次查詢工作完成後，使用者會收到通知。
當批次查詢工作的持續時間超過臨界值時，會向排定查詢的人員觸發警報。

NOTE

若已正確設定，可將用於測試的查詢從這些警報中排除。

API呼叫範例

以下小節會逐步解說您可以使用查詢服務API進行的各種API呼叫。每個呼叫都包含一般API格式、顯示必要標題的範例要求以及範例回應。

擷取組織和沙箱的所有警報清單 get-list-of-org-alert-subs

藉由向/alert-subscriptions端點發出GET要求，擷取組織沙箱的所有警示清單。

API格式

GET /alert-subscriptions
GET /alert-subscriptions?{QUERY_PARAMETERS}

屬性

說明

{QUERY_PARAMETERS}

（選用）將引數新增至請求路徑，以設定回應中傳回的結果。可包含多個引數，以&分隔。可用的引數列示如下。

查詢引數

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

參數

說明

orderby

指定結果順序的欄位。支援的欄位是created和updated。在屬性名稱前面加上遞增的+和遞減的-。預設值為-created。請注意，加號(+)必須使用%2B逸出。例如，%2Bcreated是遞增建立順序的值。

pagesize

使用此引數可控制要從每頁API呼叫擷取的記錄數。預設限制設定為每頁最多50筆記錄。

page

指定您要檢視記錄的傳回結果的頁碼。

property

根據所選欄位篩選結果。篩選器必須 HTML逸出。逗號可用來組合多組篩選器。下列屬性允許篩選：

ID
assetId
狀態
警報型別

支援的運運算元為== （等於）。例如，id==6ebd9c2d-494d-425a-aa91-24033f3abeec會傳回具有相符識別碼的警示。

要求

curl -X GET 'https://platform.adobe.io/data/foundation/query/alert-subscriptions' \
  -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}' \
  -H 'Content-Type: application/json' \
  -H 'x-sandbox-id: {SANDBOX_ID}'

回應

成功的回應會傳回HTTP 200狀態以及包含分頁和版本資訊的alerts陣列。 alerts陣列包含組織和特定沙箱之所有警示的詳細資料。每個回應最多有三個警示，回應內文中會包含每個警示型別的一個警示。

NOTE

alerts陣列中的alerts._links物件已截斷，以保持簡潔。在POST要求🔗的回應中可以找到alerts._links物件的完整範例。

{
    "alerts": [
        {
            "assetId": "0ca168f4-e46b-4f7f-be6a-bdc386271b4a",
            "id": "query_service_flow_run_start-dcf7b4be-ccd7-4c73-ae0c-a4bb34a40adada84",
            "status": "enabled",
            "alertType": "start",
            "_links":{
                "self": {…},
                "subscribe": {…},
                "patch_status": {…},
                "get_list_of_subscribers_by_alert_type": {…},
                "delete": {…}
            }
        },
        {
            "assetId": "0ca168f4-e46b-4f7f-be6a-bdc386271b4a",
            "id": "query_service_flow_run_success-dcf7b4be-ccd7-4c73-ae0c-a4bb34a40adada84",
            "status": "enabled",
            "alertType": "success",
            "_links":{
                "self": {…},
                "subscribe": {…},
                "patch_status": {…},
                "get_list_of_subscribers_by_alert_type": {…},
                "delete": {…}
            }
        },
        {
            "assetId": "700d43d9-3b99-4d4c-8dbb-29c911c0e0df",
            "id": "query_service_flow_run_start-75da972a-e859-47a5-934c-629904daa1ef",
            "status": "enabled",
            "alertType": "start",
            "_links":{
                "self": {…},
                "subscribe": {…},
                "patch_status": {…},
                "get_list_of_subscribers_by_alert_type": {…},
                "delete": {…}
            }
        }
    ],
    "_page": {
        "orderby": "-created",
        "page": 1,
        "count": 26,
        "pageSize": 50
    },
    "_links": {
        "next": {
            "href": "https://platform.adobe.io/data/foundation/query/queries/alert-subscriptions?orderby=-created&page=2"
        },
        "prev": {
            "href": "https://platform.adobe.io/data/foundation/query/queries/alert-subscriptions?orderby=-created&page=0"
        }
    },
    "version": 1
}

屬性

說明

alerts.assetId

將警示與特定查詢相關聯的查詢ID。

alerts.id

警示的名稱。此名稱由「警示」服務產生，並用於「警示」儀表板。警示名稱由儲存警示、alertType和流程ID的資料夾組成。有關可用警示的資訊可在平台警示儀表板檔案中找到。

alerts.status

警示有四個狀態值： enabled、enabling、disabled和disabling。警示正在主動接聽事件、暫停以供日後使用，同時保留所有相關訂閱者和設定，或是在這些狀態之間轉換。

alerts.alertType

警示的型別。雖然隨機查詢可用的警示狀態只有四種，但已排程的查詢可用的警示狀態有五種。 quarantine警示僅適用於排定的查詢。此外，您只能從Platform UI設定delay警報。因此，此處未說明delay。可用的警報包括：

start：在查詢執行開始時通知使用者。
success：在查詢完成時通知使用者。
failure：如果查詢失敗，則通知使用者。
quarantine：當排定的查詢執行進入隔離狀態時啟用。

alerts._links

提供可用來擷取、更新、編輯或刪除與此警示ID相關之資訊的可用方法和端點的相關資訊。

_page

物件包含描述順序、大小、總頁數和目前頁面的屬性。

_links

物件包含可用於取得資源的下一頁或上一頁的URI參照。

擷取特定查詢或排程ID的警示訂閱資訊 retrieve-all-alert-subscriptions-by-id

向/alert-subscriptions/{QUERY_ID}或/alert-subscriptions/{SCHEDULE_ID}端點發出GET要求，擷取特定查詢ID或排程ID的警示訂閱資訊。

API格式

GET /alert-subscriptions/{QUERY_ID}
GET /alert-subscriptions/{SCHEDULE_ID}

參數

說明

{QUERY_ID}

您要傳回訂閱資訊的查詢ID。

{SCHEDULE_ID}

您要傳回訂閱資訊之排程查詢的ID。

要求

curl -X GET 'https://platform.adobe.io/data/foundation/query/alert-subscriptions/4422fc69-eaa7-464e-945b-63cfd435d3d1' \
  -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}' \
  -H 'Content-Type: application/json' \
  -H 'x-sandbox-id: {SANDBOX_ID}'

回應

成功的回應傳回HTTP狀態200和alerts陣列，其中包含所提供查詢或排程ID的訂閱資訊。

{
    "alerts": [
        {
            "assetId": "6df22232-f427-4250-a4e1-43cd30990641",
            "id": "query_service_flow_run_failure-5cdc3bbe-750a-4d80-9c43-96e5e09f1a96",
            "status": "enabled",
            "alertType": "failure",
            "subscriptions": {
                "emailNotifications": [
                    "rrunner@adobe.com",
                    "jsnow@adobe.com",
                    "keverdeen@adobe.com"
                ],
                "inContextNotifications": [
                    "rrunner@adobe.com",
                    "jsnow@adobe.com",
                    "keverdeen@adobe.com"
                ]
            },
            "_links": {
                "self": {
                    "href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928",
                    "method": "GET"
                },
                "subscribe": {
                    "href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions",
                    "method": "POST",
                    "body": "{\"assetId\": \"queryId/scheduleId\", \"alertType\": \"start/success/failure\", \"subscriptions\": {\n\"emailIds\": [\"xyz@example.com\", \"abc@example.com\"], \"email\": true, \"inContext\": false}}"
                },
                "patch_status": {
                    "href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928/failure",
                    "method": "PATCH",
                    "body": "{ \"op\": \"replace\", \"path\": \"/status\", \"value\": \"enable/disable\" }"
                },
                "get_list_of_subscribers_by_alert_type": {
                    "href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928/failure",
                    "method": "GET"
                },
                "delete": {
                    "href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928/failure",
                    "method": "DELETE"
                }
            }
        },
        {
            "assetId": "6df22232-f427-4250-a4e1-43cd30990641",
            "id": "query_service_flow_run_start-5cdc3bbe-750a-4d80-9c43-96e5e09f1a96",
            "status": "enabled",
            "alertType": "start",
            "subscriptions": {
                "emailNotifications": [
                    "rrunner@adobe.com"
                ],
                "inContextNotifications": [
                    "rrunner@adobe.com"
                ]
            },
            "_links": {
                "self": {
                    "href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928",
                    "method": "GET"
                },
                "subscribe": {
                    "href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions",
                    "method": "POST",
                    "body": "{\"assetId\": \"queryId/scheduleId\", \"alertType\": \"start/success/failure\", \"subscriptions\": {\n\"emailIds\": [\"xyz@example.com\", \"abc@example.com\"], \"email\": true, \"inContext\": false}}"
                },
                "patch_status": {
                    "href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928/failure",
                    "method": "PATCH",
                    "body": "{ \"op\": \"replace\", \"path\": \"/status\", \"value\": \"enable/disable\" }"
                },
                "get_list_of_subscribers_by_alert_type": {
                    "href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928/failure",
                    "method": "GET"
                },
                "delete": {
                    "href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928/failure",
                    "method": "DELETE"
                }
            }
        }
    ]
}

屬性

說明

assetId

警報與此ID相關聯。 ID可以是查詢ID或排程ID。

id

status

alertType

每個警報可以有三種不同的警報型別。它們是：

start：在查詢執行開始時通知使用者。
success：在查詢完成時通知使用者。
failure：如果查詢失敗，則通知使用者。

subscriptions.emailNotifications

訂閱接收警示電子郵件之使用者的Adobe註冊電子郵件地址陣列。

subscriptions.inContextNotifications

訂閱警示UI通知的使用者之Adobe註冊電子郵件地址陣列。

擷取特定查詢或排程ID和警示型別的警示訂閱資訊 get-alert-info-by-id-and-alert-type

向/alert-subscriptions/{QUERY_ID}/{ALERT_TYPE}端點發出GET要求，擷取特定ID和警示型別的警示訂閱資訊。這同時適用於查詢或排程的查詢ID。

API格式

GET /alert-subscriptions/{QUERY_ID}/{ALERT_TYPE}
GET /alert-subscriptions/{SCHEDULE_ID}/{ALERT_TYPE}

參數

說明

ALERT_TYPE

此屬性說明觸發警示的查詢執行狀態。回應將僅包含此型別警示的警示訂閱資訊。每個警報可以有三種不同的警報型別。它們是：

start：在查詢執行開始時通知使用者。
success：在查詢完成時通知使用者。
failure：如果查詢失敗，則通知使用者。

QUERY_ID

要更新的查詢的唯一識別碼。

SCHEDULE_ID

要更新的排程查詢的唯一識別碼。

要求

curl -X GET 'https://platform.adobe.io/data/foundation/query/alert-subscriptions/4422fc69-eaa7-464e-945b-63cfd435d3d1/start'' \
  -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}' \
  -H 'Content-Type: application/json' \
  -H 'x-sandbox-id: {SANDBOX_ID}'

回應

成功的回應會傳回HTTP狀態200以及訂閱的所有警示。這包括警示ID、警示型別、訂閱者的Adobe註冊電子郵件ID，以及他們偏好的通知通道。

{
    "alerts": [
        {
            "assetId": "6df22232-f427-4250-a4e1-43cd30990641",
            "id": "query_service_flow_run_success-5cdc3bbe-750a-4d80-9c43-96e5e09f1a96",
            "status": "enabled",
            "alertType": "success",
            "subscriptions": {
                "emailNotifications": [
                    "rrunner@adobe.com",
                    "jsnow@adobe.com"
                ],
                "inContextNotifications": [
                    "jsnow@adobe.com"
                ]
            },
            "_links": {
                "self": {
                    "href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928",
                    "method": "GET"
                },
                "subscribe": {
                    "href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions",
                    "method": "POST",
                    "body": "{\"assetId\": \"queryId/scheduleId\", \"alertType\": \"start/success/failure\", \"subscriptions\": {\n\"emailIds\": [\"xyz@example.com\", \"abc@example.com\"], \"email\": true, \"inContext\": false}}"
                },
                "patch_status": {
                    "href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928/failure",
                    "method": "PATCH",
                    "body": "{ \"op\": \"replace\", \"path\": \"/status\", \"value\": \"enable/disable\" }"
                },
                "get_list_of_subscribers_by_alert_type": {
                    "href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928/failure",
                    "method": "GET"
                },
                "delete": {
                    "href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928/failure",
                    "method": "DELETE"
                }
            }
        }
    ]
}

屬性

說明

assetId

將警示與特定查詢相關聯的查詢ID。

alertType

start：在查詢執行開始時通知使用者。
success：在查詢完成時通知使用者。
failure：如果查詢失敗，則通知使用者。
quarantine：當排定的查詢執行進入隔離狀態時啟用。

subscriptions

用來傳遞與警示相關聯之Adobe註冊電子郵件ID的物件，以及使用者接收警示的通道。

subscriptions.inContextNotifications

訂閱警示UI通知的使用者之Adobe註冊電子郵件地址陣列。

subscriptions.emailNotifications

訂閱接收警示電子郵件之使用者的Adobe註冊電子郵件地址陣列。

擷取使用者訂閱的所有警報清單 get-alert-subscription-list

向/alert-subscriptions/user-subscriptions/{EMAIL_ID}端點發出GET要求，擷取使用者已訂閱的所有警報清單。回應包括警示名稱、ID、狀態、警示型別和通知通道。

API格式

GET /alert-subscriptions/user-subscriptions/{EMAIL_ID}

參數

說明

{EMAIL_ID}

註冊到Adobe帳戶的電子郵件地址用於識別訂閱了警報的使用者。

orderby

pagesize

使用此引數可控制要從每頁API呼叫擷取的記錄數。預設限制設定為每頁最多50筆記錄。

page

指定您要檢視記錄的傳回結果的頁碼。

property

根據所選欄位篩選結果。篩選器必須 HTML逸出。逗號可用來組合多組篩選器。下列屬性允許篩選：

ID
assetId
狀態
警報型別

支援的運運算元為== （等於）。例如，id==6ebd9c2d-494d-425a-aa91-24033f3abeec會傳回具有相符識別碼的警示。

要求

curl -X GET 'https://platform.adobe.io/data/foundation/query/alert-subscriptions/user-subscriptions/rrunner@adobe.com' \
  -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}' \
  -H 'Content-Type: application/json' \
  -H 'x-sandbox-id: {SANDBOX_ID}'

回應

成功的回應會傳回HTTP狀態200和items陣列，以及所提供emailId訂閱之警示的詳細資料。

{
    "items": [
        {
            "name": "query_service_flow_run_success-8f057161-b312-4274-b629-f346c7d15c1f",
            "assetId": "39e65373-e47a-4feb-9e5a-dffa2f677bca",
            "status": "enabled",
            "alertType": "success",
            "subscriptions": {
                "inContextNotification": true,
                "emailNotifications": true
            },
            "_links": {
                "self": {
                    "href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928",
                    "method": "GET"
                },
                "subscribe": {
                    "href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions",
                    "method": "POST",
                    "body": "{\"assetId\": \"queryId/scheduleId\", \"alertType\": \"start/success/failure\", \"subscriptions\": {\n\"emailIds\": [\"xyz@example.com\", \"abc@example.com\"], \"email\": true, \"inContext\": false}}"
                },
                "patch_status": {
                    "href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928/failure",
                    "method": "PATCH",
                    "body": "{ \"op\": \"replace\", \"path\": \"/status\", \"value\": \"enable/disable\" }"
                },
                "get_list_of_subscribers_by_alert_type": {
                    "href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928/failure",
                    "method": "GET"
                },
                "delete": {
                    "href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928/failure",
                    "method": "DELETE"
                }
            }
        },
        {
            "name": "query_service_flow_run_start-8f057161-b312-4274-b629-f346c7d15c1f",
            "assetId": "39e65373-e47a-4feb-9e5a-dffa2f677bca",
            "status": "enabled",
            "alertType": "start",
            "subscriptions": {
                "inContextNotification": true,
                "emailNotifications": true
            },
            "_links": {
                "self": {
                    "href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928",
                    "method": "GET"
                },
                "subscribe": {
                    "href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions",
                    "method": "POST",
                    "body": "{\"assetId\": \"queryId/scheduleId\", \"alertType\": \"start/success/failure\", \"subscriptions\": {\n\"emailIds\": [\"xyz@example.com\", \"abc@example.com\"], \"email\": true, \"inContext\": false}}"
                },
                "patch_status": {
                    "href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928/failure",
                    "method": "PATCH",
                    "body": "{ \"op\": \"replace\", \"path\": \"/status\", \"value\": \"enable/disable\" }"
                },
                "get_list_of_subscribers_by_alert_type": {
                    "href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928/failure",
                    "method": "GET"
                },
                "delete": {
                    "href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928/failure",
                    "method": "DELETE"
                }
            }
        }
    ], "_page": {
            "orderby": "-created",
            "page": 1,
            "count": 26,
            "pageSize": 50
        },
    "_links": {
        "next": {
            "href": "https://platform-int.adobe.io/data/foundation/query/queries/alert-subscriptions?orderby=-created&page=2"
        },
        "prev": {
            "href": "https://platform-int.adobe.io/data/foundation/query/queries/alert-subscriptions?orderby=-created&page=0"
        }
    },
    "version": 1
}

屬性

說明

name

assetId

將警示與特定查詢相關聯的查詢ID。

status

alertType

start：在查詢執行開始時通知使用者。
success：在查詢完成時通知使用者。
failure：如果查詢失敗，則通知使用者。
quarantine：當排定的查詢執行進入隔離狀態時啟用。

subscriptions

用來傳遞與警示相關聯之Adobe註冊電子郵件ID的物件，以及使用者接收警示的通道。

subscriptions.inContextNotifications

一個布林值，可判斷使用者接收警報通知的方式。 true值會確認應透過UI提供警示。 false值可確保不會透過該頻道通知使用者。

subscriptions.emailNotifications

一個布林值，可判斷使用者接收警報通知的方式。 true值會確認電子郵件應提供警示。 false值可確保不會透過該頻道通知使用者。

若要建立警示並訂閱使用者以接收警示，請對/alert-subscriptions端點發出POST要求。此請求會使用assetId屬性將查詢與新建立的警示建立關聯，並使用emailIds訂閱使用者該查詢的警示。

IMPORTANT

您最多可以在單一請求中傳遞5個Adobe註冊的電子郵件ID。若要訂閱超過五名使用者警報，必須提出後續請求。

API格式

POST /alert-subscriptions

要求

curl -X POST https://platform.adobe.io/data/foundation/query/alert-subscriptions
  -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 '
    {
    "assetId": "a679dd0e-bcb2-4e69-a610-22d17ba98cac",
    "alertType": "failure",
    "subscriptions": {
        "emailIds": [
            "rrunner@adobe.com",
            "jsnow@adobe.com"
        ],
        "inContextNotifications": true,
        "emailNotifications": true
    }
}'

屬性

說明

assetId

警報與此ID相關聯。 ID可以是查詢ID或排程ID。

alertType

start：在查詢執行開始時通知使用者。
success：在查詢完成時通知使用者。
failure：如果查詢失敗，則通知使用者。
quarantine：當排定的查詢執行進入隔離狀態時啟用。

subscriptions

用來傳遞與警示相關聯之Adobe註冊電子郵件ID的物件，以及使用者接收警示的通道。

subscriptions.emailIds

一系列電子郵件地址，用於識別應接收警報的使用者。電子郵件地址必須已註冊到Adobe帳戶。

subscriptions.inContextNotifications

一個布林值，可判斷使用者接收警報通知的方式。 true值會確認應透過UI提供警示。 false值可確保不會透過該頻道通知使用者。

subscriptions.emailNotifications

一個布林值，可判斷使用者接收警報通知的方式。 true值會確認電子郵件應提供警示。 false值可確保不會透過該頻道通知使用者。

回應

成功的回應會傳回HTTP狀態202 （已接受）以及新建立警報的詳細資料。

{
    "assetId": "c4f67291-1161-4943-bc29-8736469bb928",
    "id": "query_service_flow_run_failure-5f4cb942-b67c-4ea4-a90d-5b6245e60aca",
    "alertType": "failure",
    "subscriptions": {
        "emailIds": [
            "{USER_EMAIL_ID}"
        ],
        "inContextNotifications": false,
        "emailNotifications": true
    },
    "_links": {
        "self": {
            "href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928",
            "method": "GET"
        },
        "subscribe": {
            "href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions",
            "method": "POST",
            "body": "{\"assetId\": \"queryId/scheduleId\", \"alertType\": \"start/success/failure\", \"subscriptions\": {\n\"emailIds\": [\"xyz@example.com\", \"abc@example.com\"], \"email\": true, \"inContext\": false}}"
        },
        "patch_status": {
            "href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928/failure",
            "method": "PATCH",
            "body": "{ \"op\": \"replace\", \"path\": \"/status\", \"value\": \"enable/disable\" }"
        },
        "get_list_of_subscribers_by_alert_type": {
            "href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928/failure",
            "method": "GET"
        },
        "delete": {
            "href": "https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928/failure",
            "method": "DELETE"
        }
    }
}

屬性

說明

id

_links

提供可用來擷取、更新、編輯或刪除與此警示ID相關之資訊的可用方法和端點的相關資訊。

啟用或停用警示 enable-or-disable-alert

此要求使用查詢或排程ID和警示型別來參考特定警示，並將警示狀態更新為enable或disable。您可以對/alert-subscriptions/{queryId}/{alertType}或/alert-subscriptions/{scheduleId}/{alertType}端點發出PATCH要求，以更新警示的狀態。

API格式

PATCH /alert-subscriptions/{QUERY_ID}/{ALERT_TYPE}
PATCH /alert-subscriptions/{SCHEDULE_ID}/{ALERT_TYPE}

參數

說明

ALERT_TYPE

start：在查詢執行開始時通知使用者。
success：在查詢完成時通知使用者。
failure：如果查詢失敗，則通知使用者。
quarantine：當排定的查詢執行進入隔離狀態時啟用。

您必須在端點名稱空間中指定目前的警報型別，才能進行變更。

QUERY_ID

要更新的查詢的唯一識別碼。

SCHEDULE_ID

要更新的排程查詢的唯一識別碼。

要求

curl -X PATCH 'https://platform.adobe.io/data/foundation/query/alert-subscriptions/4422fc69-eaa7-464e-945b-63cfd435d3d1/start'' \
  -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}'
  -H 'Content-Type: application/json' \
  -H 'x-sandbox-id: {SANDBOX_ID}' \
  -d '{
        "op": "replace",
        "path" : "/status",
        "value": "enable"
      }'

屬性

說明

op

要執行的作業。目前唯一接受的值為replace。

path

這個值與端點中的名稱空間有關。目前唯一接受的值為/status。

value

在成功的PATCH要求中，這會變更警示的status值。目前，接受的值為enable或disable。

回應

成功的回應會傳回HTTP狀態200，其中包含警示狀態、型別和ID的詳細資料，以及與其相關的查詢。

{
    "id" : "query_service_flow_run_success-4422fc69-eaa7-464e-945b-63cfd435d3d1",
    "assetId": "4422fc69-eaa7-464e-945b-63cfd435d3d1",
    "alertType": "start",
    "status": "enabled"
}

屬性

說明

id

assetId

警報與此ID相關聯。 ID可以是查詢ID或排程ID。

alertType

每個警報可以有三種不同的警報型別。它們是：

start：在查詢執行開始時通知使用者。
success：在查詢完成時通知使用者。
failure：如果查詢失敗，則通知使用者。

status

刪除特定查詢和警示型別的警示 delete-alert-info-by-id-and-alert-type

向/alert-subscriptions/{QUERY_ID}/{ALERT_TYPE}或/alert-subscriptions/{SCHEDULE_ID}/{ALERT_TYPE}端點發出DELETE要求，以刪除特定查詢或排程ID和警示型別的警示。

DELETE /alert-subscriptions/{QUERY_ID}/{ALERT_TYPE}
DELETE /alert-subscriptions/{SCHEDULE_ID}/{ALERT_TYPE}

參數

說明

ALERT_TYPE

start：在查詢執行開始時通知使用者。
success：在查詢完成時通知使用者。
failure：如果查詢失敗，則通知使用者。
quarantine：當排定的查詢執行進入隔離狀態時啟用。

DELETE要求僅適用於所提供的特定警報型別。

QUERY_ID

要更新的查詢的唯一識別碼。

SCHEDULE_ID

要更新的排程查詢的唯一識別碼。

要求

curl -X DELETE 'https://platform.adobe.io/data/foundation/query/alert-subscriptions/4422fc69-eaa7-464e-945b-63cfd435d3d1/start' \
  -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}' \
  -H 'Content-Type: application/json' \
  -H 'x-sandbox-id: {SANDBOX_ID}'

回應

成功的回應會傳回HTTP 200狀態和確認訊息，其中包含資產識別碼和已刪除警示的警示型別。

{
"message": "Alert Deleted Successfully for assetId: 6df22232-f427-4250-a4e1-43cd30990641 and alertType: success",
"statusCode": 200
}

後續步驟

本指南涵蓋了查詢服務API中/alert-subscriptions端點的使用。閱讀本指南後，您現在已更瞭解如何為查詢建立警報、為使用者訂閱警報、可用的警報型別，以及如何擷取、更新和刪除警報訂閱資訊。

請參閱查詢服務API指南，以進一步瞭解其他可用的功能和作業。

recommendation-more-help

ccf2b369-4031-483f-af63-a93b5ae5e3fb

警報訂閱端點

快速入門

警示型別 alert-types

API呼叫範例

擷取組織和沙箱的所有警報清單 get-list-of-org-alert-subs

擷取特定查詢或排程ID的警示訂閱資訊 retrieve-all-alert-subscriptions-by-id

擷取特定查詢或排程ID和警示型別的警示訂閱資訊 get-alert-info-by-id-and-alert-type

擷取使用者訂閱的所有警報清單 get-alert-subscription-list

建立警報並訂閱使用者 subscribe-users

啟用或停用警示 enable-or-disable-alert

刪除特定查詢和警示型別的警示 delete-alert-info-by-id-and-alert-type

後續步驟