查询端点

API调用示例

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

检索查询列表

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

API格式

GET /queries
GET /queries?{QUERY_PARAMETERS}

{QUERY_PARAMETERS}:(可选)添加到请求路径的参数，用于配置响应中返回的结果。可以包含多个参数，并以与号(&)分隔。以下列出了可用参数。

查询参数

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

参数	描述
`orderby`	指定对结果排序所依据的字段。支持的字段有`created`和`updated`。例如，`orderby=created`将按照创建的升序对结果进行排序。在创建之前添加`-`(`orderby=-created`)将按创建项的降序排序。
`limit`	指定页面大小限制以控制页面中包含的结果数。 (默认值：20)
`start`	使用从零开始的编号来偏移响应列表。例如，`start=2`将返回从第三个列出的查询开始的列表。 (默认值：0)
`property`	根据字段筛选结果。过滤器必须被HTML转义。可使用逗号组合多组过滤器。支持的字段包括`created`、`updated`、`state`和`id`。支持的运算符列表包括：`>`（大于）、`<`（小于）、`>=`（大于或等于）、`<=`（小于或等于）、`==`（等于）、`!=`（不等于）和`~`（包含）。例如， `id==6ebd9c2d-494d-425a-aa91-24033f3abeec`将返回具有指定ID的所有查询。
`excludeSoftDeleted`	指示是否应包含已软删除的查询。例如，`excludeSoftDeleted=false`将包含软删除的查询。 (布尔值，默认值：true)
`excludeHidden`	指示是否应显示非用户驱动的查询。将此值设置为false将include非用户驱动的查询，如CURSOR定义、FETCH或元数据查询。 (布尔值，默认值：true)

请求

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

curl -X GET https://platform.adobe.io/data/foundation/query/queries?limit=1 \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

响应

成功响应会返回HTTP状态200，其中包含指定IMS组织的查询列表(JSON)。以下响应会返回为IMS组织创建的最新查询。

{
    "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

请求

以下请求会创建一个新查询，该查询由有效负载中提供的值配置：

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: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '{
        "dbName": "prod:all",
        "sql": "SELECT * FROM accounts;",
        "name": "Sample Query",
        "description": "Sample Description"
    }

属性	描述
`dbName`	要为其创建SQL查询的数据库的名称。
`sql`	要创建的SQL查询。
`name`	SQL查询的名称。
`description`	SQL查询的描述。

响应

成功响应会返回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\"}"
        }
    }
}

注意

可以使用_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: {IMS_ORG}' \
 -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\"}"
        }
    }
}

注意

可以使用_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: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'
 -d '{
   "op": "cancel"  
 }'

属性	描述
`op`	要取消查询，必须使用值`cancel` 设置op参数。

响应

成功响应会通过以下消息返回HTTP状态202（已接受）：

{
    "message": "Query cancel request received",
    "statusCode": 202
}

adobe.com 上的资源

Asset Collections Customer Journey Data Ingestion Web Analytics Attribution Search Marketing Management

查询端点

API调用示例

检索查询列表

创建查询

按ID检索查询

取消查询

adobe.com 上的资源

在此页面上

查看下一个：

学习

文档

社区

技术支持

资源

Adobe 帐户

Adobe