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

文档中心

立即注册

导航

DataExecCommandSetAsync

最近更新时间：2024.07.30 20:46:17首次发布时间：2024.05.16 22:12:37

调用 DataExecCommandSetAsync 接口异步执行命令集。

注意事项

调用 DataExecCommandSetAsync 接口是一个同步请求，它只能获取一个请求 ID（即命令集 ID）。如果您想要获取命令集的执行结果，那么您需要调用 DataGetCommandSetResult 接口进行查询。

请求类型

同步请求。

请求参数

名称	类型	是否必选	示例值	描述
SessionId	String	是	MTc4ODg3NTA1Mjg1NTM0NTE1Mi8xNzg4ODc1MDUyODYz*******	会话 ID。说明您可以调用 DataConnectInstance 接口，查询会话 ID。
CommandSetContent	String	是	show databases;show processlist	命令集内容。当命令集中存在多个命令时，需使用英文分号（;）隔开。
DatabaseName	String	否	sys	数据库名称，命令集会在制定的数据库中执行。若不指定，则默认在当前数据库执行 SQL 命令。
AutoOnlineDDL	Bool	否	true	是否开启转换命令集中的 DDL 为 OnlineDDL，取值如下： `false`：（默认值）表示不开启。 `true`：表示开启。
Force	Boolen	否	true	在命令集中存在 DDL 语句并且不支持转换成 OnlineDDL 时 DDL 的执行方式，取值如下： `false`：（默认值）在命令集中存在的 DDL 语句不支持转换成 OnlineDDL 时，系统将拒绝执行该 SQL 语句，并提示您该语句中存在 OnlineDDL 不支持的 DDL 语句。 `true`：在命令集存在的 DDL 语句不支持转换成 OnlineDDL 时，仍会按照普通的 DDL 继续执行。说明当调用 DataExecCommandSetAsync 异步执行云数据库 MySQL 版实例的命令集时，可配置该参数。仅在 `AutoOnlineDDL` 设置为 `true` 时，该参数才会生效。

返回参数

名称	类型	示例值	描述
CommandSetId	String	178887541272244****	命令集 ID。

请求示例

POST /?Action=DataExecCommandSetAsync&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": "MTc4ODg3NTA1Mjg1NTM0NTE1Mi8xNzg4ODc1MDUyODYz********",
     "CommandSetContent": "show databases;show processlist",
     "AutoOnlineDDL":true,
     "Force":true
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202405101815074D6C61C22FD7E479870C-e62012",
        "Action": "DataExecCommandSetAsync",
        "Version": "2018-01-01",
        "Service": "dbw",
        "Region": "cn-beijing"
    },
    "Result": {
        "CommandSetId": "178887541272244****"
    }
}

错误码

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