getQueries

北美(North America）

GET

https://sellingpartnerapi-na.amazon.com/dataKiosk/2023-11-15/queries

Data Kiosk

返回与指定过滤器匹配的数据自助查询的详细信息。有关查询保留的详细信息，请参见 createQuery 操作。

使用计划：

速率（每秒请求数）	突发
0.0222	10

x-amzn-RateLimit-Limit 响应头返回适用于请求操作的使用计划速率限制（如果可用）。上表指示了此操作的默认速率和突发值。商业需求要求更高吞吐量的销售合作伙伴可能会看到比此处显示更高的速率和突发值。有关更多信息，请参阅销售合作伙伴 API 中的使用计划和速率限制。

请求参数

Query 参数

processingStatuses

array[string]

可选

用于过滤查询的处理状态列表。

>= 1 items

枚举值:

CANCELLEDDONEFATALIN_PROGRESSIN_QUEUE

pageSize

integer

可选

单次调用中返回的最大查询数量。

>= 1<= 100

默认值:

createdSince

string <date-time>

可选

查询的最早创建日期和时间，以ISO 8601日期时间格式表示，包含在响应中。默认值为90天前。

createdUntil

string <date-time>

可选

查询的最新创建日期和时间，以 ISO 8601 日期时间格式包含在响应中。默认值为 getQueries 请求的时间。

paginationToken

string

可选

一个令牌，用于在有多个结果页面可用时获取特定页面的结果。该令牌的值来自GetQueriesResponse对象中返回的pagination.nextToken字段。所有其他参数必须与生成此令牌的请求中提供的相同的值，唯一的例外是pageSize，它可以在对getQueries的调用之间进行修改。在没有此令牌值的情况下，getQueries返回第一页面的结果。

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

成功。

Headers

x-amzn-RateLimit-Limit

string

可选

您对此操作的速率限制（每秒请求数量）。

x-amzn-RequestId

string

可选

唯一请求参考标识符。

Body

`getQueries` 操作的响应。

queries

array[object (Query) {9}]

查询列表。

必需

queryId

string

必需

查询标识符。该标识符仅与销售伙伴账户ID组合时是唯一的。

query

string

提交的查询。

必需

createdTime

string <date-time>

必需

查询创建的日期和时间，采用ISO 8601日期时间格式。

processingStatus

enum<string>

查询的处理状态。

必需

枚举值:

CANCELLEDDONEFATALIN_PROGRESSIN_QUEUE

processingStartTime

string <date-time>

可选

查询处理开始的日期和时间，采用 ISO 8601 日期时间格式。

processingEndTime

string <date-time>

可选

查询处理完成的日期和时间，采用 ISO 8601 日期时间格式。

dataDocumentId

string

可选

数据文档标识符。仅当查询结果中有数据可用时，此标识符才会出现。此标识符仅在与销售伙伴账户ID结合时是唯一的。将此标识符传递到 getDocument 操作中以获取检索数据文档内容所需的信息。

errorDocumentId

string

可选

错误文档标识符。仅在查询处理期间发生错误时，此标识符才会出现。此标识符仅在与销售合作伙伴账户 ID 结合时是唯一的。将此标识符传入 getDocument 操作，以获取检索错误文档内容所需的信息。

pagination

object

可选

当查询产生的结果不包含在数据文档中时，分页会发生。这意味着结果被分成多个页面。要检索下一页，您必须在后续的 createQuery 请求中传递一个 CreateQuerySpecification 对象，其中 paginationToken 设置为该对象的 nextToken，并且 query 设置为该对象的 query。当没有更多页面可以提取时，nextToken 字段将不再出现。

pagination

object

可选

当请求的结果不包括在此响应中时，会发生分页。这意味着结果被分成多个页面。要检索下一页，您必须在后续的 getQueries 请求中将 nextToken 作为 paginationToken 查询参数传递。所有其他参数必须使用与生成该令牌的请求中提供的相同值，pageSize 除外，该参数可以在调用 getQueries 之间进行修改。当没有更多页面可获取时，nextToken 字段将缺失。

nextToken

string

可选

一个可用于获取下一页结果的令牌。

示例

{
  "queries": [
    {
      "queryId": "string",
      "query": "string",
      "createdTime": "2019-08-24T14:15:22Z",
      "processingStatus": "CANCELLED",
      "processingStartTime": "2019-08-24T14:15:22Z",
      "processingEndTime": "2019-08-24T14:15:22Z",
      "dataDocumentId": "string",
      "errorDocumentId": "string",
      "pagination": {
        "nextToken": "string"
      }
    }
  ],
  "pagination": {
    "nextToken": "string"
  }
}

🟠400请求有误

🟠403禁止访问

🟠404记录不存在

🟠413413

🟠415415

🟠429429

🔴500服务器错误

🔴503服务器故障

修改于 2025-03-15 12:28:53

getCatalogItem

createQuery