查询端点

上次更新: 2024-02-29
  • 主题:
  • Queries
    查看有关此主题的更多信息
  • 创建对象:
  • Developer

API调用示例

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

检索查询列表

您可以向以下网站发出GET请求,以检索贵组织的所有查询列表: /queries 端点。

API格式

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

查询参数

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

参数 描述
orderby 指定排序结果所依据的字段。 支持的字段包括 createdupdated. 例如, 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:00,美国东部标准时间。 可以为时区提供UTC偏移,并在后缀“Z”中表示(2020-01-01T01:01:01Z)。 如果未提供时区,则默认设置为0。
property 根据字段筛选结果。 过滤器 必须 HTML逃跑了。 逗号用于组合多组过滤器。 支持的字段包括 createdupdatedstate、和 id. 支持的运算符列表包括 > (大于), < (小于), >= (大于或等于), <= (小于或等于), == (等于), != (不等于),并且 ~ (包含)。 例如, id==6ebd9c2d-494d-425a-aa91-24033f3abeec 将返回具有指定ID的所有查询。
excludeSoftDeleted 指示是否应包含已软删除的查询。 例如, excludeSoftDeleted=falseinclude 软删除的查询。 (布尔值,默认值: true)
excludeHidden 指示是否应显示非用户驱动的查询。 将此值设置为false将会 include 非用户驱动查询,如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
}

创建查询

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

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中使用参数替换。 将不对这些键值对执行任何值类型检查。
templateId 预先存在的查询的唯一标识符。 您可以提供此语句而不是SQL语句。
insertIntoParameters (可选)如果定义了此属性,则此查询将转换为INSERT INTO查询。
ctasParameters (可选)如果定义了此属性,此查询将转换为CTAS查询。

响应

成功的响应返回HTTP状态202(已接受)以及新创建查询的详细信息。 激活完查询并成功运行后, state 将更改为 SUBMITTEDSUCCESS.

{
    "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检索查询

您可以通过对以下网站发出GET请求,检索有关特定查询的详细信息: /queries 端点并提供查询的 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\"}"
        }
    }
}
注意

您可以使用值 _links.cancel取消您创建的查询.

取消或软删除查询

您可以通过向以下对象发出PATCH请求,请求取消或软删除指定查询: /queries 端点并提供查询的 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 要对资源执行的操作的类型。 接受的值包括 cancelsoft_delete. 要取消查询,必须使用值设置操作参数 cancel . 请注意,软删除操作会阻止在GET请求时返回查询,但不会将其从系统中删除。

响应

成功的响应返回HTTP状态202(已接受),并显示以下消息:

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

在此页面上