文档

GetSqlStatement - 获取SQL查询详情

更新时间:

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

GET /api/interactive/v1/workspace/{workspaceId}/statement/{statementId}

请求参数

名称类型必填描述示例值
workspaceIdstring

工作空间 ID。

w-d2d82aa09155****
statementIdstring

交互式查询 ID。

st-2dadfhajk11cv****
regionIdstring

地域 ID。

cn-hangzhou

返回参数

名称类型描述示例值
object

Schema of Response

dataobject

返回数据。

statementIdstring

查询 ID。

st-1231311abadfaa
statestring

查询状态。

枚举值:
  • runningrunning
  • availableavailable
  • cancelledcancelled
  • errorerror
  • cancellingcancelling
running
sqlOutputsobject []

SQL 查询结果列表

rowsstring

查询数据,格式为经过 JSON 序列化的字符串。

[{\"values\":[\"test_db\",\"test_table\",false]}
schemastring

Schema 的详细信息,格式为经过 JSON 序列化的字符串。

{\"type\":\"struct\",\"fields\":[{\"name\":\"namespace\",\"type\":\"string\",\"nullable\":false,\"metadata\":{}},{\"name\":\"tableName\",\"type\":\"string\",\"nullable\":false,\"metadata\":{}},{\"name\":\"isTemporary\",\"type\":\"boolean\",\"nullable\":false,\"metadata\":{}}]}
sqlErrorCodestring

SQL 查询错误码。

ERROR-102
sqlErrorMessagestring

SQL 查询错误信息。

error message
executionTimearray

SQL 查询耗时列表。

long

每个 SQL 查询消耗时间,单位毫秒。

1717138731701
requestIdstring

请求 ID。

DD6B1B2A-5837-5237-ABE4-FF0C8944****

示例

正常返回示例

JSON格式

{
  "data": {
    "statementId": "st-1231311abadfaa",
    "state": "running",
    "sqlOutputs": [
      {
        "rows": "[{\\\"values\\\":[\\\"test_db\\\",\\\"test_table\\\",false]}",
        "schema": "{\\\"type\\\":\\\"struct\\\",\\\"fields\\\":[{\\\"name\\\":\\\"namespace\\\",\\\"type\\\":\\\"string\\\",\\\"nullable\\\":false,\\\"metadata\\\":{}},{\\\"name\\\":\\\"tableName\\\",\\\"type\\\":\\\"string\\\",\\\"nullable\\\":false,\\\"metadata\\\":{}},{\\\"name\\\":\\\"isTemporary\\\",\\\"type\\\":\\\"boolean\\\",\\\"nullable\\\":false,\\\"metadata\\\":{}}]}"
      }
    ],
    "sqlErrorCode": "ERROR-102",
    "sqlErrorMessage": "error message",
    "executionTime": [
      1717138731701
    ]
  },
  "requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****"
}

错误码

访问错误中心查看更多错误码。

  • 本页导读 (1)