在指定时间范围内直接执行SQL语句查询内部事件仓数据。时间范围仅约束SQL中引用的内部EventHouse数据,挂载的外部数据源不受影响。返回结构化结果集。
接口说明
执行单条只读 SQL 并返回结构化结果集。BeginTime 和 EndTime 仅约束 SQL 中引用的内部 EventHouse 数据,不影响挂载的外部数据源。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| Query |
string |
是 |
要执行的单条只读 SQL 语句。支持查询内部 EventHouse,也支持与挂载的外部数据源进行联合查询。 |
SELECT * FROM my_catalog.my_namespace.my_table LIMIT 100 |
| BeginTime |
integer |
是 |
查询内部 EventHouse 数据的开始时间,使用 Unix 时间戳,单位为秒。时间区间包含该时刻。 |
1787587200 |
| EndTime |
integer |
是 |
查询内部 EventHouse 数据的结束时间,使用 Unix 时间戳,单位为秒。时间区间不包含该时刻,且必须大于 BeginTime。 |
1787590800 |
| Limit |
integer |
否 |
本次查询允许返回的最大结果行数。 |
100 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| Message |
string |
接口调用成功时返回成功信息,调用失败时返回具体错误信息。 |
success |
| RequestId |
string |
本次请求的唯一标识,可用于问题排查。 |
34AD682D-5B91-5773-8132-AA38C130**** |
| Data |
object |
SQL 查询返回的结构化结果数据。 |
|
| Rows |
array |
本次 SQL 查询返回的结果行列表。 |
|
| Row |
单行查询结果,包含该行各列的名称、类型、值和空值标记。 |
||
| Total |
integer |
本次查询实际返回的结果行数。 |
1 |
| Code |
string |
接口返回码。Success 表示调用成功,其他取值表示具体错误码。 |
Success |
| Success |
boolean |
接口调用是否成功。true 表示成功,false 表示失败。 |
true |
示例
正常返回示例
JSON格式
{
"Message": "success",
"RequestId": "34AD682D-5B91-5773-8132-AA38C130****",
"Data": {
"Rows": [
{
"Columns": [
{
"Name": "index",
"Type": "text",
"Value": "product_info",
"IsNull": false
}
]
}
],
"Total": 1
},
"Code": "Success",
"Success": true
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 403 | ServiceNotEnable | Service not enable |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。