调用ExecuteScript执行SQL脚本。

目前仅支持管控模式为安全协同的实例调用该API。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

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

系统规定参数。取值:ExecuteScript

DbId Integer 123

数据库ID。

说明 该参数对应为 SearchDatabaseListDatabasesGetDatabase等接口中的DatabaseId参数,您可以调用这些接口获取。
Logic Boolean false

是否逻辑库。

Script String select dt from report_daily

要执行的具体SQL脚本。包括DQL、DDL和DML,其中DDL和DML是否允许依赖于实例的安全管控配置。

Tid Long 234

租户ID。

说明 取自系统右上角头像处悬停展示的租户ID信息,详情请参见 查看租户信息
RegionId String cn-hangzhou

Region化调用参数。

返回数据

名称 类型 示例值 描述
ErrorCode String UnknownError

错误码。

ErrorMessage String UnknownError

错误信息。

RequestId String FE8EE2F1-4880-46BC-A704-5CF63EAF9A04

请求ID。

Results Array of Result

脚本执行返回结果列表,列表中每一项对应一个脚本执行结果。

ColumnNames List ["col1", "col2"]

执行查询脚本时,返回的结果集字段列表。

Message String UnknownError

执行失败时,返回的错误信息。

RowCount Long 1

返回的结果记录数。

Rows List [{"col1": "value1", "col2":"value2"}]

执行查询脚本时,返回的结果数据。

Success Boolean true

单个脚本执行是否成功。

Success Boolean true

请求是否成功。

示例

请求示例

http(s)://[Endpoint]/?Action=ExecuteScript
&DbId=123
&Logic=false
&Script=select dt from report_daily
&<公共请求参数>

正常返回示例

XML 格式

<RequestId>FE8EE2F1-4880-46BC-A704-5CF63EAF9A04</RequestId>
<Results>
    <Message>UnknownError</Message>
    <RowCount>1</RowCount>
    <Success>true</Success>
</Results>
<Results>
    <ColumnNames>["col1", "col2"]</ColumnNames>
    <Rows>[{"col1": "value1", "col2":"value2"}]</Rows>
</Results>
<ErrorCode>UnknownError</ErrorCode>
<ErrorMessage>UnknownError</ErrorMessage>
<Success>true</Success>

JSON 格式

{"RequestId":"FE8EE2F1-4880-46BC-A704-5CF63EAF9A04","Results":[{"Message":"UnknownError","RowCount":"1","Success":"true"},{"ColumnNames":"[\"col1\", \"col2\"]","Rows":"[{\"col1\": \"value1\", \"col2\":\"value2\"}]"}],"ErrorCode":"UnknownError","ErrorMessage":"UnknownError","Success":"true"}

错误码

访问错误中心查看更多错误码。