计划查询端点

API调用示例

既然您了解了要使用的标头,接下来便可以开始调用 Query Service API。 以下部分将介绍您可以使用 Query Service API。 每个调用都包含常规API格式、显示所需标头的示例请求以及示例响应。

检索计划查询列表

您可以通过向 /schedules 端点。

API格式

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

查询参数

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

参数 描述
orderby 指定对结果排序所依据的字段。 支持的字段包括 createdupdated. 例如, orderby=created 将按创建的结果进行升序排序。 添加 - 创建之前(orderby=-created)将按创建的项目进行降序排序。
limit 指定页面大小限制以控制页面中包含的结果数。 (默认值:20)
start 使用从零开始的编号来偏移响应列表。 例如, start=2 将返回从第三个列出的查询开始的列表。 (默认值:0)
property 根据字段筛选结果。 过滤器 必须 HTML转义。 可使用逗号组合多组过滤器。 支持的字段包括 created, templateIduserId. 支持的运算符列表包括 > (大于), < (小于),和 == (等于)。 例如, userId==6ebd9c2d-494d-425a-aa91-24033f3abeec 将返回指定用户ID的所有计划查询。

请求

以下请求可检索为IMS组织创建的最新计划查询。

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,其中包含指定IMS组织的计划查询列表。 以下响应会返回为IMS组织创建的最新计划查询。

{
    "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 端点。 在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表达式格式 文档。 在此示例中,“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 to 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"
        }
    }
}
注意

您可以使用 _links.delete to 删除已创建的计划查询.

指定计划查询的请求详细信息

您可以通过向 /schedules 端点并在请求路径中提供其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"
        }
    }
}
注意

您可以使用 _links.delete to 删除已创建的计划查询.

更新指定计划查询的详细信息

您可以通过向 /schedules 端点,并在请求路径中提供其ID。

PATCH请求支持两种不同的路径: /state/schedule/schedule.

更新计划查询状态

您可以使用 /state 更新选定计划查询的状态 — “已启用”或“已禁用”。 要更新状态,您需要将值设置为 enabledisable.

API格式

PATCH /schedules/{SCHEDULE_ID}
属性 描述
{SCHEDULE_ID} id 要PATCH的计划查询的值。

请求

此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"
         }
     ]
 }'
属性 描述
path 要修补的值的路径。 在这种情况下,由于您正在更新计划查询的状态,因此需要将 path to /state.
value 的更新值 /state. 此值可设置为 enabledisable 启用或禁用计划查询。

响应

成功响应会通过以下消息返回HTTP状态202(已接受)。

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

更新计划查询计划

您可以使用 /schedule/schedule 更新计划查询的cron计划。 有关创建计划的更多信息,请阅读 cron表达式格式 文档。

API格式

PATCH /schedules/{SCHEDULE_ID}
属性 描述
{SCHEDULE_ID} id 要PATCH的计划查询的值。

请求

此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 * * * *"
         }
     ]
 }'
属性 描述
path 要修补的值的路径。 在这种情况下,由于您要更新计划查询的计划,因此需要将 path to /schedule/schedule.
value 的更新值 /schedule. 此值需要采用cron计划的形式。 因此,在本例中,计划查询将在45分钟标记下每小时运行一次。

响应

成功响应会通过以下消息返回HTTP状态202(已接受)。

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

删除指定的计划查询

您可以通过向 /schedules 端点和提供您要在请求路径中删除的计划查询的ID。

注意

计划 必须 禁用。

API格式

DELETE /schedules/{SCHEDULE_ID}
属性 描述
{SCHEDULE_ID} id 要DELETE的计划查询的值。

请求

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
}

在此页面上