执行SQL实例。
接口说明
方法
POST
URI
/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances/{sqlInstanceId}/actions/execution
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
searchengine:ExecuteSqlInstance |
create |
*Instance
|
无 | 无 |
请求语法
POST /openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances/{sqlInstanceId}/actions/execution HTTP/1.1
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
instanceId |
string |
是 |
实例 id |
ha-cn-pl32rf0**** |
database |
string |
是 |
数据库名称 |
general |
sqlInstanceId |
integer |
是 |
sql 实例 id |
1 |
body |
object |
否 |
请求体参数 |
|
content |
string |
是 |
sql 内容 |
select * from test |
kvpair |
object |
否 |
kv 结构体 |
|
any |
否 |
kv 结构体 |
{ "trace": "INFO", "databaseName": "general", "iquan.plan.cache.enable": true, "iquan.plan.prepare.level": "jni.post.optimize", "urlencode_data": false, "formatType": "string", "timeout": 1000 } |
|
dynamicParam |
object |
否 |
动态参数 |
|
any |
否 |
动态扩展参数 |
{ "trace": "INFO", "databaseName": "general", "iquan.plan.cache.enable": true, "iquan.plan.prepare.level": "jni.post.optimize", "urlencode_data": false, "formatType": "string", "timeout": 1000 } |
|
staticParam |
object |
否 |
静态参数 |
|
any |
否 |
静态参数 |
{ "trace": "INFO", "databaseName": "general", "iquan.plan.cache.enable": true, "iquan.plan.prepare.level": "jni.post.optimize", "urlencode_data": false, "formatType": "string", "timeout": 1000 } |
|
domain |
string |
否 |
数据源机房 |
vpc_hz_domain_1 |
params |
object |
否 |
sql 执行参数 |
|
any |
否 |
sql 执行参数 |
{ "trace": "INFO", "databaseName": "general", "iquan.plan.cache.enable": true, "iquan.plan.prepare.level": "jni.post.optimize", "urlencode_data": false, "formatType": "string", "timeout": 1000 } |
|
combineParam |
object |
否 |
组合参数 |
|
any |
否 |
组合参数 |
{ "trace": "INFO", "databaseName": "general", "iquan.plan.cache.enable": true, "iquan.plan.prepare.level": "jni.post.optimize", "urlencode_data": false, "formatType": "string", "timeout": 1000 } |
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
|||
requestId |
string |
请求 ID |
FE03180A-0E29-5474-8A86-33F0683294A4 |
result |
object |
返回结果。 |
|
id |
integer |
主键 id |
22 |
gmtCreate |
string |
创建时间 |
1719221186114 |
gmtModified |
string |
修改时间 |
1719220182844 |
name |
string |
名称 |
test |
parent |
integer |
父任务 id。 |
-1 |
isDir |
integer |
是否为目录。取值:-true:是-false:否 |
true |
type |
string |
table, instance, template, function |
instance |
instanceId |
integer |
实例 id。 |
ha-cn-pl32rf0**** |
templateId |
integer |
模板 ID。 |
1 |
示例
正常返回示例
JSON
格式
{
"requestId": "FE03180A-0E29-5474-8A86-33F0683294A4",
"result": {
"id": 22,
"gmtCreate": "1719221186114",
"gmtModified": "1719220182844",
"name": "test",
"parent": -1,
"isDir": 0,
"type": "instance",
"instanceId": 0,
"templateId": 1
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。