DataExecCommands--数据库工作台-火山引擎

文档中心

立即注册

导航

DataExecCommands

最近更新时间：2024.01.12 10:38:18首次发布时间：2022.11.18 17:51:28

调用 DataExecCommands 接口执行命令语句。

说明

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

请求类型

同步请求。

请求参数

名称	类型	是否必选	示例值	描述
SessionId	string	是	MTU4MDg1MTE1NzM5ODQ3ODg0OC8xNTgwODUxMTU3NDQ0NjIw****	会话 ID。说明您可以调用 DataConnectInstance 接口，查询会话 ID。
Commands	String	是	Select * from func;	SQL 文本。说明当需要执行多个 SQL 语句时，可使用英文分号（;）进行分割。
DatabaseName	String	否	mysql	数据库名称。指定在某个数据库执行 SQL 命令，不指定时默认在当前数据库执行 SQL 命令。
TimeOutSeconds	Integer	否	5	SQL 命令执行超时时间。单位：秒（s），默认为 300 秒。

返回参数

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

请求示例

POST /?Action=DataExecCommands&Version=2018-01-01 HTTP/1.1
Content-Type: application/json
Host: dbw.volcengineapi.com
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/dbw/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645****

{
      "SessionId": "MTU4MDg1MTE1NzM5ODQ3ODg0OC8xNTgwODUxMTU3NDQ0NjIw****",
      "Commands" : "Select * from func;",
      "DatabaseName": "mysql",
      "TimeOutSeconds": 5
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202309221612539B33ED77F0A06214EB4A",
        "Action": "DataExecCommands",
        "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"
            }
        ]
    }
}

错误码

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