调用ExecuteScript接口执行SQL脚本-数据管理 DMS-阿里云-数据管理 DMS-阿里云帮助中心

调用ExecuteScript执行SQL脚本。

接口说明

目前仅支持开启安全托管的实例调用该 API。开启安全托管操作，请参见安全托管。
目前不支持 NoSQL 类型的数据库调用此 API。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dms:ExecuteScript

update

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
DbId	integer	是	数据库 ID。说明该参数对应为 SearchDatabase 、 ListDatabases 、 GetDatabase 等接口中的 DatabaseId 参数，您可以调用这些接口获取。	123
Script	string	是	要执行的具体 SQL 脚本。包括 DQL、DDL 和 DML，其中 DDL 和 DML 是否允许依赖于实例的安全管控配置。	select dt from report_daily
Logic	boolean	是	是否逻辑库。	false
Tid	integer	否	租户 ID。说明取自系统右上角头像处悬停展示的租户 ID 信息，详情请参见查看租户信息。	234
RealLoginUserUid	string	否	实际调用 API 的用户的阿里云账号 UID。更多信息，请参见指定 API 调用者。	21400447956867****

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	FE8EE2F1-4880-46BC-A704-5CF63EAF9A04
Results	array<object>	脚本执行返回结果列表，列表中每一项对应一个脚本执行结果。
	array<object>
ColumnNames	array	执行查询脚本时，返回的结果集字段列表。
	string	结果集字段。	col1
Rows	array<object>	执行查询脚本时，返回的结果数据行。
	object	执行查询脚本时，返回的结果数据。	[{"col1": "value1", "col2":"value2"}]
Success	boolean	单个脚本执行是否成功。	true
Message	string	执行失败时，返回的错误信息。	UnknownError
RowCount	integer	返回的结果记录数。	1
ErrorCode	string	错误码。	UnknownError
ErrorMessage	string	错误信息。	UnknownError
Success	boolean	请求是否成功。	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
}

错误码

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

变更历史

更多信息，参考变更详情。