您可以通过本API完成元数据相关SQL的运行,仅支持DDL和DML,不支持DQL。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
stream:ExecuteSqlStatement |
none |
*全部资源
|
无 | 无 |
请求语法
POST /api/v2/namespaces/{namespace}/sql-statement/execute HTTP/1.1
路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| namespace |
string |
是 |
项目空间名称。 |
default-namespace |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| workspace |
string |
是 |
工作空间 ID。 |
710d6a64d8c34d |
| body | SqlStatementWithContext |
否 |
元数据相关 SQL 语句。 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
响应数据。 |
||
| requestId |
string |
请求 ID。 |
CBC799F0-AS7S-1D30-8A4F-882ED4DD**** |
| success |
boolean |
表示业务请求是否成功。 |
true |
| httpCode |
integer |
业务状态码,统一为 200;使用 success 表示业务请求是否成功。 |
200 |
| errorCode |
string |
|
"" |
| errorMessage |
string |
|
"" |
| data | SqlStatementExecuteResult |
元数据 SQL 执行结果。 |
示例
正常返回示例
JSON格式
{
"requestId": "CBC799F0-AS7S-1D30-8A4F-882ED4DD****",
"success": true,
"httpCode": 200,
"errorCode": "\"\"",
"errorMessage": "\"\"",
"data": {
"executeSuccess": true,
"errorDetails": {
"lineNumber": "3",
"columnNumber": "2",
"endLineNumber": "5",
"endColumnNumber": "11",
"message": "\"\"",
"invalidflinkConf": [
"{\"k:v\"}"
]
},
"statement": "“show create table order”"
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。