文档中心

数据库工作台

SQL 任务

ExecuteSQL

调用 ExecuteSQL 接口执行 SQL 语句。

说明

该接口不支持 OnlineDDL 操作。使用该接口执行 DDL 操作时，有可能导致 DML、DQL 等操作阻塞，需谨慎使用。

该接口不支持 PostgreSQL 和 SQL Server 类型数据库。

请求类型

同步请求。

请求参数

名称	类型	是否必填	示例值	描述
InstanceID	String	是	mysql-bf120f******	数据库实例 ID。说明您可以按需选择以下接口查询实例 ID：您可以调用 DescribeDBInstances 接口查询 MySQL 的实例 ID。调用 DescribeDBInstances 接口查询 veDB MySQL 的实例 ID。
InstanceType	String	是	MySQL	数据库类型，当前支持的数据库如下所示。 MySQL：云数据库 MySQL 版。 VeDBMySQL：云数据库 veDB MySQL 版。 Mongo：文档数据库 MongoDB 版。 Redis：缓存数据库 Redis 版。
Database	String	是	mysql	数据库名称。指定在某个数据库执行 SQL 命令，不指定时默认在当前数据库执行 SQL 命令。
Commands	String	是	select * from func;	SQL 文本。说明当数据库类型是 MySQL 或 veDBMySQL 时，如果需要执行多个 SQL 语句，可使用英文分号（;）进行分割。当数据库类型是 Redis 时，如果需要执行多个 SQL 语句，可使用 \r\n 进行分割。当数据库类型是 MongoDB 时，不支持执行多个 SQL 语句，即 SQL 文本中只能包含一条 SQL 语句。
TimeOutSeconds	Integer	否	300	SQL 命令执行超时时间。单位：秒（s），默认为 300 秒。

返回参数

名称	类型	示例值	描述
Results	Array of ResultObject	ResultObject	执行 SQL 命令的结果。

请求示例

POST /?Action=ExecuteSQL&Version=2018-01-01 HTTP/1.1​
Accept: application/json​
Content-Type: application/json​
Host: dbw.volcengineapi.com​
X-Date: 20210328T100802Z​
Authorization: HMAC-SHA256 Credential=AKLTYmYwNjAzYjFmMjRkNDQwZWI4MzI1MzhjZGYyM******/20210328/cn-beijing/dbw/request, SignedHeaders=x-date, Signature=e1d274292f8b36eb096e1d2fec02822bd2e5cb3435699938adb7341861******​
​
{​
  "InstanceID": "mysql-bf120f******",​
  "InstanceType": "MySQL",​
  "Database": "company",​
  "Commands": "select * from func;"​
}​

返回示例

{​
    "ResponseMetadata": {​
        "RequestId": "202309221612539B33ED77F0A06214EB4A",​
        "Action": "ExecuteSQL",​
        "Version": "2018-01-01",​
        "Service": "dbw",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "Results": [​
            {​
                "ColumnNames": [​
                    "opid",​
                    "opcode",​
                    "opname",​
                    "ophref",​
                    "opseq"​
                ],​
                "CommandStr": "Select * from auth_operation",​
                "ReasonDetail": "",​
                "RowCount": 2,​
                "Rows": [​
                    {​
                        "Cells": [​
                            "87",​
                            "01",​
                            "权限管理",​
                            "/admin/auth",​
                            "1"​
                        ]​
                    },​
                    {​
                        "Cells": [​
                            "98",​
                            "010205",​
                            "角色权限管理页面",​
                            "/admin/role/bindOperPage/{roleid}",​
                            "1"​
                        ]​
                    }​
                ],​
                "RunTime": 1695370373000,​
                "State": "Success"​
            }​
        ]​
    }​
}​

错误码

更多详情，请参见错误码。

最近更新时间：2025.11.28 16:36:58

这个页面对您有帮助吗？

有用

无用