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

文档中心

立即注册

导航

DataGetCommandSetResult

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

调用 DataGetCommandSetResult 接口查询异步执行命令集的执行结果。

前提条件

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

请求类型

同步请求。

请求参数

名称类型 是否必选 示例值 描述

名称	类型	是否必选	示例值	描述
CommandSetId	string	是	178887541272244****	命令集 ID。说明调用 DataExecCommandSetAsync 接口，获取命令集 ID。
FilterType	String	否	Success	命令集中 SQL 语句的执行状态，取值如下： `Success`：表示查询命令集中执行成功的 SQL 语句。 `Failed`：表示查询命令集中执行失败的 SQL 语句。 `Cancel`：表示查询取消执行的命令集。 `All`：（默认值）表示查询所有的命令集。

CommandSetId

string

是

178887541272244****

命令集 ID。

说明

调用 DataExecCommandSetAsync 接口，获取命令集 ID。

FilterType

String

否

Success

命令集中 SQL 语句的执行状态，取值如下：

Success：表示查询命令集中执行成功的 SQL 语句。
Failed：表示查询命令集中执行失败的 SQL 语句。
Cancel：表示查询取消执行的命令集。
All：（默认值）表示查询所有的命令集。

返回参数

名称类型 示例值 描述

名称	类型	示例值	描述
Results	Array of Result	`[ { "ColumnNames": [ "Database" ], "CommandStr": "show databases;", "ReasonDetail": "", "RowCount": 2, "Rows": [ { "Cells": [ "information_schema" ] }, { "Cells": [ "sys" ] } ], "RunTime": 1715396681000, "State": "Success" } ]`	命令集执行结果的集合。详细信息，请参见 Result。
FilterType	String	Success	过滤命令集中 SQL 语句执行状态的条件，取值如下： `Success`：表示查询的是命令集中执行成功的 SQL 语句。 `Failed`：表示查询的是命令集中执行失败的 SQL 语句。 `Cancel`：表示查询的是命令集中取消执行的 SQL 语句。 `All`：表示查询的是命令集中所有 SQL 语句。

Results

Array of Result

[
    {
        "ColumnNames": [
            "Database"
        ],
        "CommandStr": "show databases;",
        "ReasonDetail": "",
        "RowCount": 2,
        "Rows": [
            {
                "Cells": [
                    "information_schema"
                ]
            },
            {
           "Cells": [
                    "sys"
                ]
            }
        ],
        "RunTime": 1715396681000,
        "State": "Success"
    }
]

命令集执行结果的集合。详细信息，请参见 Result。

FilterType

String

Success

过滤命令集中 SQL 语句执行状态的条件，取值如下：

Success：表示查询的是命令集中执行成功的 SQL 语句。
Failed：表示查询的是命令集中执行失败的 SQL 语句。
Cancel：表示查询的是命令集中取消执行的 SQL 语句。
All：表示查询的是命令集中所有 SQL 语句。

请求示例

POST /?Action=DataGetCommandSetResult&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****

{
     "CommandSetId": "178887541272244****",
     "FilterType": "All"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2024051116125243C401426335B0927AD5-3223f0",
        "Action": "DataGetCommandSetResult",
        "Version": "2018-01-01",
        "Service": "dbw",
        "Region": "cn-beijing"
    },
    "Result": {
        "FilterType": "All",
        "Results": [
            {
                "ColumnNames": [
                    "Database"
                ],
                "CommandStr": "show databases;",
                "ReasonDetail": "",
                "RowCount": 2,
                "Rows": [
                    {
                        "Cells": [
                            "information_schema"
                        ]
                    },
                    {
                        "Cells": [
                            "sys"
                        ]
                    }
                ],
                "RunTime": 1715396681000,
                "State": "Success"
            }
        ]
    }
}

错误码

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