ExecuteQuery - AWS IoT TwinMaker

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

ExecuteQuery

运行查询,访问个人工作区中实体知识图谱中的信息。

注意

该 ExecuteQuery 操作仅适用AWS于 Java SDK2。 ExecuteQuery 不适用于任何 AWS Java SDK 版本小于 2.x。

请求语法

POST /queries/execution HTTP/1.1 Content-type: application/json { "maxResults": number, "nextToken": "string", "queryStatement": "string", "workspaceId": "string" }

URI 请求参数

该请求不使用任何 URI 参数。

请求体

请求接受采用 JSON 格式的以下数据。

maxResults

一次性返回的最大结果数。默认值为 50。

类型:整数

有效范围:最小值为 1。最大值为 100。

必需:否

nextToken

指定下一页结果的字符串。

类型:字符串

长度限制:长度下限为 0。最大长度为 17880。

模式:.*

必需:否

queryStatement

查询语句

类型:字符串

长度限制:最小长度为 1。最大长度为 1000。

模式:[\s\S]+

必需:是

workspaceId

工作区的 ID。

类型:字符串

长度限制:长度下限为 1。长度上限为 128。

模式:[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+

必需:是

响应语法

HTTP/1.1 200 Content-type: application/json { "columnDescriptions": [ { "name": "string", "type": "string" } ], "nextToken": "string", "rows": [ { "rowData": [ JSON value ] } ] }

响应元素

如果此操作成功,则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

columnDescriptions

ColumnDescription 对象列表。

类型:ColumnDescription 对象数组

nextToken

指定下一页结果的字符串。

类型:字符串

长度限制:长度下限为 0。最大长度为 17880。

模式:.*

rows

代表查询结果中的一行。

类型:Row 对象数组

错误

有关所有操作返回的常见错误的信息,请参阅 常见错误

AccessDeniedException

访问被拒绝。

HTTP 状态代码:403

InternalServerException

出现意外错误。

HTTP 状态代码:500

QueryTimeoutException

查询超时异常。

HTTP 状态代码:400

ServiceQuotaExceededException

已超出服务限额。

HTTP 状态代码:402

ThrottlingException

速率超过限制。

HTTP 状态代码:429

ValidationException

失败

HTTP 状态代码:400

另请参阅

有关在特定语言的 AWS SDK 中使用此 API 的更多信息,请参阅以下内容: