文档

ExecuteScript - 执行SQL脚本

更新时间:

调用ExecuteScript执行SQL脚本。

接口说明

  • 目前仅支持开启安全托管的实例调用该 API。开启安全托管操作,请参见安全托管

  • 目前不支持 NoSQL 类型的数据库调用此 API。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dms:ExecuteScriptWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
DbIdinteger

数据库 ID。

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

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

select dt from report_daily
Logicboolean

是否逻辑库。

false
Tidlong

租户 ID。

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

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

FE8EE2F1-4880-46BC-A704-5CF63EAF9A04
Resultsobject []

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

ColumnNamesarray

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

string

结果集字段。

col1
Rowsobject []

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

object

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

[{"col1": "value1", "col2":"value2"}]
Successboolean

单个脚本执行是否成功。

true
Messagestring

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

UnknownError
RowCountlong

返回的结果记录数。

1
ErrorCodestring

错误码。

UnknownError
ErrorMessagestring

错误信息。

UnknownError
Successboolean

请求是否成功。

true

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈