文档Experience Platform查询服务指南

查询端点

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

创建对象：

  • 开发人员

API调用示例

以下部分介绍了您可以在Query Service API中使用/queries端点进行的调用。 每个调用包括常规API格式、显示所需标头的示例请求以及示例响应。

检索查询列表

您可以通过向/queries端点发出GET请求来检索贵组织的所有查询列表。

API格式

GET /queries
GET /queries?{QUERY_PARAMETERS}
  • {QUERY_PARAMETERS}： （可选）参数已添加到请求路径，用于配置响应中返回的结果。 可以包含多个参数，以&符号(&)分隔。 下面列出了可用的参数。

查询参数

以下是列出查询的可用查询参数列表。 所有这些参数都是可选的。 在不使用参数的情况下对此端点进行调用将检索对您的组织可用的所有查询。

参数
描述
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)表示。 如果未提供时区，则默认设置为0。
property
根据字段筛选结果。 筛选器​ 必须 ​进行HTML转义。 逗号用于组合多组过滤器。 支持的字段为created、updated、state和id。 支持的运算符列表为： > （大于）、< （小于）、>= （大于或等于）、<= （小于或等于）、== （等于）、!= （不等于）和~ （包含）。 例如，id==6ebd9c2d-494d-425a-aa91-24033f3abeec将返回具有指定ID的所有查询。
excludeSoftDeleted
指示是否应包含已软删除的查询。 例如，excludeSoftDeleted=false将​ 包括 ​软删除的查询。 （布尔值，默认值： true）
excludeHidden
指示是否应显示非用户驱动的查询。 将此值设置为false将​ 包括 ​非用户驱动的查询，如CURSOR定义、FETCH或元数据查询。 （布尔值，默认值： true）
isPrevLink
isPrevLink查询参数用于分页。 API调用的结果使用其created时间戳和orderby属性排序。 在结果页面中导航时，向后分页时，isPrevLink设置为true。 这会使查询的顺序相反。 请参阅“下一个”和“上一个”链接作为示例。

请求

以下请求检索为您的组织创建的最新查询。

curl -X GET https://platform.adobe.io/data/foundation/query/queries?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，其中包含以JSON格式表示的指定组织的查询列表。 以下响应返回为您的组织创建的最新查询。

{
    "queries": [
        {
            "isInsertInto": false,
            "request": {
                "dbName": "prod:all",
                "sql": "SELECT *\nFROM\n  accounts\nLIMIT 10\n"
            },
            "state": "SUCCESS",
            "rowCount": 0,
            "errors": [],
            "isCTAS": false,
            "version": 1,
            "id": "9957bd7f-2244-4fd5-91bc-077d7df1d8e5",
            "elapsedTime": 28,
            "updated": "2019-12-06T22:00:17.390Z",
            "client": "Adobe Query Service UI",
            "userId": "{USER_ID}",
            "created": "2019-12-06T22:00:17.362Z",
            "_links": {
                "self": {
                    "href": "https://platform.adobe.io/data/foundation/query/queries/9957bd7f-2244-4fd5-91bc-077d7df1d8e5",
                    "method": "GET"
                },
                "soft_delete": {
                    "href": "https://platform.adobe.io/data/foundation/query/queries/9957bd7f-2244-4fd5-91bc-077d7df1d8e5",
                    "method": "PATCH",
                    "body": "{ \"op\": \"soft_delete\"}"
                },
                "referenced_datasets": [
                    {
                        "id": "5b2bdd32230d4401de87397c",
                        "href": "https://platform.adobe.io/data/foundation/catalog/dataSets/5b2bdd32230d4401de87397c"
                    }
                ]
            }
        }
    ],
    "_page": {
        "orderby": "-created",
        "start": "2019-12-06T22:00:17.362Z",
        "next": "2019-08-01T00:14:21.748Z",
        "count": 1
    },
    "_links": {
        "next": {
            "href": "https://platform.adobe.io/data/foundation/query/queries?orderby=-created&start=2019-08-01T00:14:21.748Z"
        },
        "prev": {
            "href": "https://platform.adobe.io/data/foundation/query/queries?orderby=-created&start=2019-12-06T22:00:17.362Z&isPrevLink=true"
        }
    },
    "version": 1
}

创建查询

您可以通过向/queries端点发出POST请求来创建新查询。

API格式

POST /queries

请求

以下请求使用有效负载中提供的SQL语句创建新查询：

curl -X POST https://platform.adobe.io/data/foundation/query/queries \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '{
        "dbName": "prod:all",
        "sql": "SELECT account_balance FROM user_data WHERE user_id='$user_id';",
        "queryParameters": {
            user_id : {USER_ID}
            }
        "name": "Sample Query",
        "description": "Sample Description"
    }

下面的请求示例使用现有查询模板ID创建新查询。

curl -X POST https://platform.adobe.io/data/foundation/query/queries \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '{
        "dbName": "prod:all",
        "templateID": "f7cb5155-29da-4b95-8131-8c5deadfbe7f",
        "name": "Sample Query",
        "description": "Sample Description"
    }
属性
描述
dbName
正在为其创建SQL查询的数据库名称。
sql
要创建的SQL查询。
name
SQL查询的名称。
description
SQL查询的说明。
queryParameters
键值配对，用于替换SQL语句中的任何参数化值。 只有在您提供的SQL中使用参数替换​ if ​时才需要。 将不对这些键值对执行任何值类型检查。
templateId
预先存在的查询的唯一标识符。 您可以提供此语句而不是SQL语句。
insertIntoParameters
（可选）如果定义了此属性，则此查询将转换为INSERT INTO查询。
ctasParameters
（可选）如果定义了此属性，此查询将转换为CTAS查询。

响应

成功的响应返回HTTP状态202（已接受）以及新创建查询的详细信息。 一旦查询完成激活并成功运行，state将从SUBMITTED更改为SUCCESS。

{
    "isInsertInto": false,
    "request": {
        "dbName": "prod:all",
        "sql": "SELECT * FROM accounts;",
        "name": "Sample Query",
        "description": "Sample Description"
    },
    "state": "SUBMITTED",
    "rowCount": 0,
    "errors": [],
    "isCTAS": false,
    "version": 1,
    "id": "4d64cd49-cf8f-463a-a182-54bccb9954fc",
    "elapsedTime": 0,
    "updated": "2020-01-08T21:47:46.865Z",
    "client": "API",
    "userId": "{USER_ID}",
    "created": "2020-01-08T21:47:46.865Z",
    "_links": {
        "self": {
            "href": "https://platform.adobe.io/data/foundation/query/queries/4d64cd49-cf8f-463a-a182-54bccb9954fc",
            "method": "GET"
        },
        "soft_delete": {
            "href": "https://platform.adobe.io/data/foundation/query/queries/4d64cd49-cf8f-463a-a182-54bccb9954fc",
            "method": "PATCH",
            "body": "{ \"op\": \"soft_delete\"}"
        },
        "cancel": {
            "href": "https://platform.adobe.io/data/foundation/query/queries/4d64cd49-cf8f-463a-a182-54bccb9954fc",
            "method": "PATCH",
            "body": "{ \"op\": \"cancel\"}"
        }
    }
}
NOTE
您可以使用_links.cancel的值来取消您创建的查询。

按ID检索查询

您可以通过向/queries端点发出GET请求并在请求路径中提供查询的id值来检索有关特定查询的详细信息。

API格式

GET /queries/{QUERY_ID}
属性
描述
{QUERY_ID}
要检索的查询的id值。

请求

curl -X GET https://platform.adobe.io/data/foundation/query/queries/4d64cd49-cf8f-463a-a182-54bccb9954fc \
 -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，其中包含有关指定查询的详细信息。

{
    "isInsertInto": false,
    "request": {
        "dbName": "prod:all",
        "sql": "SELECT * FROM accounts;",
        "name": "Sample Query",
        "description": "Sample Description"
    },
    "state": "SUBMITTED",
    "rowCount": 0,
    "errors": [],
    "isCTAS": false,
    "version": 1,
    "id": "4d64cd49-cf8f-463a-a182-54bccb9954fc",
    "elapsedTime": 0,
    "updated": "2020-01-08T21:47:46.865Z",
    "client": "API",
    "userId": "{USER_ID}",
    "created": "2020-01-08T21:47:46.865Z",
    "_links": {
        "self": {
            "href": "https://platform.adobe.io/data/foundation/query/queries/4d64cd49-cf8f-463a-a182-54bccb9954fc",
            "method": "GET"
        },
        "soft_delete": {
            "href": "https://platform.adobe.io/data/foundation/query/queries/4d64cd49-cf8f-463a-a182-54bccb9954fc",
            "method": "PATCH",
            "body": "{ \"op\": \"soft_delete\"}"
        },
        "cancel": {
            "href": "https://platform.adobe.io/data/foundation/query/queries/4d64cd49-cf8f-463a-a182-54bccb9954fc",
            "method": "PATCH",
            "body": "{ \"op\": \"cancel\"}"
        }
    }
}
NOTE
您可以使用_links.cancel的值来取消您创建的查询。

取消或软删除查询

您可以通过向/queries端点发出PATCH请求并在请求路径中提供查询的id值，来请求取消或软删除指定的查询。

API格式

PATCH /queries/{QUERY_ID}
参数
描述
{QUERY_ID}
要对其执行操作的查询的id值。

请求

此API请求对其有效负载使用JSON修补程序语法。 有关JSON修补程序如何工作的更多信息，请阅读API基础知识文档。

curl -X PATCH https://platform.adobe.io/data/foundation/query/queries/4d64cd49-cf8f-463a-a182-54bccb9954fc \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json',
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'
 -d '{
   "op": "cancel"
 }'
属性
描述
op
要对资源执行的操作的类型。 接受的值为cancel和soft_delete。 要取消查询，您必须使用值cancel 设置op参数。 请注意，软删除操作会阻止在GET请求时返回查询，但不会将其从系统中删除。

响应

成功的响应返回HTTP状态202（已接受），并显示以下消息：

{
    "message": "Query cancel request received",
    "statusCode": 202
}
recommendation-more-help
ccf2b369-4031-483f-af63-a93b5ae5e3fb