Data Management:ExecuteScript - Data Management

Executes an SQL script.

Operation description

This operation is available only for instances with Secure Managed mode enabled. To learn how to enable this mode, see Security Protection.
This operation is not supported for NoSQL databases.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dms:ExecuteScript

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DbId	integer	Yes	The ID of the database. Note This parameter corresponds to the `DatabaseId` parameter in operations such as SearchDatabase, ListDatabases, and GetDatabase. You can call these operations to obtain the ID.	123
Script	string	Yes	The SQL script to execute. You can include DQL, DDL, or DML statements. The execution of DDL and DML statements is subject to the instance's security rules.	select dt from report_daily
Logic	boolean	Yes	Specifies whether the database is a logical database.	false
Tid	integer	No	The tenant ID. Note You can obtain the tenant ID by hovering over the profile picture in the upper-right corner of the console. For more information, see View tenant information.	234
RealLoginUserUid	string	No

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	FE8EE2F1-4880-46BC-A704-5CF63EAF9A04
Results	array<object>	The execution results for the script. Each item in the array represents the result of a single statement.
	array<object>
ColumnNames	array	The column names in the result set returned by a DQL query.
	string	A column in the result set.	col1
Rows	array<object>	The data rows in the result set returned by a DQL query.
	object	A single data row from the result set.	[{"col1": "value1", "col2":"value2"}]
Success	boolean	Indicates whether the SQL statement that produced this result was executed successfully.	true
Message	string	The error message for a failed execution.	UnknownError
RowCount	integer	The number of rows in the result set.	1
ErrorCode	string	The error code.	UnknownError
ErrorMessage	string	The error message.	UnknownError
Success	boolean	Indicates whether the request was successful.	true

Examples

Success response

JSON format

{
  "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
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.