警报订阅端点

Adobe Experience Platform查询服务允许您订阅临时查询和计划查询的警报。 警报可通过电子邮件、在Platform UI中或同时通过两者接收。 平台内警报和电子邮件警报的通知内容相同。 目前,查询警报只能使用 查询服务API.

重要

要接收电子邮件警报,您必须首先在UI中启用此设置。 请参阅相关文档 关于如何启用电子邮件警报的说明.

下表说明了不同类型查询支持的警报类型:

查询类型 支持的警报类型
临时查询 successfailed 执行。
计划查询 start, successfailed 执行。
注意

所有非SELECT查询都支持警报订阅,您无需成为查询创建者即可订阅警报。 其他用户还可以在未创建的查询中注册警报。

以下警报在没有警报订阅的情况下适用:

  • 当完成批处理查询作业时,用户会收到通知。
  • 当批量查询作业的持续时间超过阈值时,系统会向计划查询的人员触发警报。
注意

如果已正确配置,则用于测试的查询可以从这些警报中排除。

API调用示例

以下各节介绍了您可以使用查询服务API进行的各种API调用。 每个调用都包含常规API格式、显示所需标头的示例请求以及示例响应。

检索组织和沙盒的所有警报列表

通过向 /alert-subscriptions 端点。

API格式

GET /alert-subscriptions
GET /alert-subscriptions?{QUERY_PARAMETERS}
属性 描述
{QUERY_PARAMETERS} (可选)添加到请求路径的参数,用于配置响应中返回的结果。 可以包含多个参数,并以与号(&)分隔。 以下列出了可用参数。

查询参数

以下是用于列出查询的可用查询参数列表。 所有这些参数都是可选的。 对此端点进行无参数调用将检索适用于贵组织的所有查询。

参数 描述
orderby 指定结果顺序的字段。 支持的字段包括 createdupdated. 在属性名称前面添加 + 对于升序和 - 按降序排列。 默认值为 -created。请注意,加号(+)必须使用进行转义 %2B. 例如 %2Bcreated 是创建升序顺序的值。
pagesize 使用此参数可控制每页要从API调用中获取的记录数。 默认限制设置为每页最多50条记录。
page 指示要查看其记录的返回结果的页码。
property 根据所选字段筛选结果。 过滤器 必须 HTML转义。 可使用逗号组合多组过滤器。 以下属性允许筛选:
  • id
  • assetId
  • 状态
  • alertType
支持的运算符包括 == (等于)。 例如, id==6ebd9c2d-494d-425a-aa91-24033f3abeec 将返回具有匹配ID的警报。

请求

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 数组包含组织和特定沙盒的所有警报的详细信息。 每个响应最多有三个警报可用,每个警报类型中每个警报都包含一个警报。

注意

alerts._links 对象 alerts 数组已被截断,为简便起见。 的完整示例 alerts._links 对象可在 POST请求的响应.

{
    "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, disableddisabling. 警报是主动监听事件,暂停供将来使用,同时保留所有相关订阅者和设置,或者在这些状态之间进行转换。
alerts.alertType 警报的类型。 警报有三个潜在值,它们是:
  • start:在查询执行开始时通知用户。
  • success:查询完成时通知用户。
  • failure:在查询失败时通知用户。
alerts._links 提供有关可用方法和端点的信息,可用于检索、更新、编辑或删除与此警报ID相关的信息。
_page 对象包含用于描述页面顺序、大小、页面总数和当前页面的属性。
_links 对象包含URI引用,可用于获取资源的下一页或上一页。

检索特定查询或计划ID的警报订阅信息

通过向 /alert-subscriptions/{QUERY_ID}/alert-subscriptions/{SCHEDULE_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或计划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 警报的名称。 此名称由警报服务生成,用在警报功能板中。 警报名称由存储警报的文件夹组成, alertType、和流量ID。 有关可用警报的信息,请参阅 平台警报功能板文档.
status 警报具有四个状态值: enabled, enabling, disableddisabling. 警报是主动监听事件,暂停供将来使用,同时保留所有相关订阅者和设置,或者在这些状态之间进行转换。
alertType 每个警报可以有三种不同的警报类型。 它们是:
  • start:在查询执行开始时通知用户。
  • success:查询完成时通知用户。
  • failure:在查询失败时通知用户。
subscriptions.emailNotifications 为订阅接收警报电子邮件的用户注册的Adobe电子邮件地址数组。
subscriptions.inContextNotifications Adobe注册的电子邮件地址数组,用于订阅警报的UI通知的用户。

检索特定查询或计划ID和警报类型的警报订阅信息

通过向 /alert-subscriptions/{QUERY_ID}/{ALERT_TYPE} 端点。 这适用于查询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:在查询失败时通知用户。
subscriptions 一个对象,用于传递与警报关联的Adobe注册电子邮件ID,以及用户接收警报的渠道。
subscriptions.inContextNotifications Adobe注册的电子邮件地址数组,用于订阅警报的UI通知的用户。
subscriptions.emailNotifications 为订阅接收警报电子邮件的用户注册的Adobe电子邮件地址数组。

检索用户订阅的所有警报的列表

通过向 /alert-subscriptions/user-subscriptions/{EMAIL_ID} 端点。 响应包括警报名称、ID、状态、警报类型和通知渠道。

API格式

GET /alert-subscriptions/user-subscriptions/{EMAIL_ID}
参数 描述
{EMAIL_ID} 注册到Adobe帐户的电子邮件地址用于标识订阅了警报的用户。
orderby 指定结果顺序的字段。 支持的字段包括 createdupdated. 在属性名称前面添加 + 对于升序和 - 按降序排列。 默认值为 -created。请注意,加号(+)必须使用进行转义 %2B. 例如 %2Bcreated 是创建升序顺序的值。
pagesize 使用此参数可控制每页要从API调用中获取的记录数。 默认限制设置为每页最多50条记录。
page 指示要查看其记录的返回结果的页码。
property 根据所选字段筛选结果。 过滤器 必须 HTML转义。 可使用逗号组合多组过滤器。 以下属性允许筛选:
  • id
  • assetId
  • 状态
  • alertType
支持的运算符包括 == (等于)。 例如, id==6ebd9c2d-494d-425a-aa91-24033f3abeec 将返回具有匹配ID的警报。

请求

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 警报的名称。 此名称由警报服务生成,用在警报功能板中。 警报名称由存储警报的文件夹组成, alertType、和流量ID。 有关可用警报的信息,请参阅 平台警报功能板文档.
assetId 将警报与特定查询关联的查询ID。
status 警报具有四个状态值: enabled, enabling, disableddisabling. 警报是主动监听事件,暂停供将来使用,同时保留所有相关订阅者和设置,或者在这些状态之间进行转换。
alertType 警报的类型。 警报有三个潜在值,它们是:
  • start:在查询执行开始时通知用户。
  • success:查询完成时通知用户。
  • failure:在查询失败时通知用户。
subscriptions 一个对象,用于传递与警报关联的Adobe注册电子邮件ID,以及用户接收警报的渠道。
subscriptions.inContextNotifications 一个布尔值,用于确定用户如何接收警报通知。 A true 值确认应通过UI提供警报。 A false 值可确保用户不会通过该渠道收到通知。
subscriptions.emailNotifications 一个布尔值,用于确定用户如何接收警报通知。 A true 值会确认应通过电子邮件提供警报。 A false 值可确保用户不会通过该渠道收到通知。

创建警报并订阅用户

要创建警报并让用户订阅接收该警报,请 POST 请求 /alert-subscriptions 端点。 此请求使用 assetId 属性,并通过使用 emailIds.

重要

在一个请求中,您最多可以传递五个Adobe注册的电子邮件ID。 若要使5个以上的用户订阅警报,必须发出后续请求。

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:在查询失败时通知用户。
subscriptions 一个对象,用于传递与警报关联的Adobe注册电子邮件ID,以及用户接收警报的渠道。
subscriptions.emailIds 用于标识应接收警报的用户的电子邮件地址数组。 电子邮件地址 必须 注册到Adobe帐户。
subscriptions.inContextNotifications 一个布尔值,用于确定用户如何接收警报通知。 A true 值确认应通过UI提供警报。 A false 值可确保用户不会通过该渠道收到通知。
subscriptions.emailNotifications 一个布尔值,用于确定用户如何接收警报通知。 A true 值会确认应通过电子邮件提供警报。 A 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 警报的名称。 此名称由警报服务生成,用在警报功能板中。 警报名称由存储警报的文件夹组成, alertType、和流量ID。 有关可用警报的信息,请参阅 平台警报功能板文档.
_links 提供有关可用方法和端点的信息,可用于检索、更新、编辑或删除与此警报ID相关的信息。

启用或禁用警报

此请求使用查询或计划ID和警报类型引用特定警报,并将警报状态更新为 enabledisable. 您可以通过 PATCH 请求 /alert-subscriptions/{queryId}/{alertType}/alert-subscriptions/{scheduleId}/{alertType} 端点。

API格式

PATCH /alert-subscriptions/{QUERY_ID}/{ALERT_TYPE}
PATCH /alert-subscriptions/{SCHEDULE_ID}/{ALERT_TYPE}
参数 描述
ALERT_TYPE 警报的类型。 警报有三个潜在值,它们是:
  • start:在查询执行开始时通知用户。
  • success:查询完成时通知用户。
  • failure:在查询失败时通知用户。
您必须在端点命名空间中指定当前警报类型才能更改它。
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 警报的值。 目前,接受的值为 enabledisable.

响应

成功响应会返回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 警报的名称。 此名称由警报服务生成,用在警报功能板中。 警报名称由存储警报的文件夹组成, alertType、和流量ID。 有关可用警报的信息,请参阅 平台警报功能板文档.
assetId 警报与此ID关联。 该ID可以是查询ID或计划ID。
alertType 每个警报可以有三种不同的警报类型。 它们是:
  • start:在查询执行开始时通知用户。
  • success:查询完成时通知用户。
  • failure:在查询失败时通知用户。
status 警报具有四个状态值: enabled, enabling, disableddisabling. 警报是主动监听事件,暂停供将来使用,同时保留所有相关订阅者和设置,或者在这些状态之间进行转换。

删除特定查询和警报类型的警报

通过向 /alert-subscriptions/{QUERY_ID}/{ALERT_TYPE}/alert-subscriptions/{SCHEDULE_ID}/{ALERT_TYPE} 端点。

DELETE /alert-subscriptions/{QUERY_ID}/{ALERT_TYPE}
DELETE /alert-subscriptions/{SCHEDULE_ID}/{ALERT_TYPE}
参数 描述
ALERT_TYPE 警报的类型。 警报有三个潜在值,它们是:
  • start:在查询执行开始时通知用户。
  • success:查询完成时通知用户。
  • failure:在查询失败时通知用户。
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状态和确认消息,其中包含资产ID和已删除警报的警报类型。

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

后续步骤

本指南介绍了 /alert-subscriptions 查询服务API中的端点。 阅读本指南后,您现在可以更好地了解如何为查询创建警报、为用户订阅警报、可用警报类型以及如何检索、更新和删除警报订阅信息。

请参阅 查询服务API指南 了解有关其他可用功能和操作的更多信息。

在此页面上