ExecuteSqlInstance - OpenSearch - Alibaba Cloud Documentation Center

Executes an SQL instance.

Operation description

Method

POST

URI

/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances/{sqlInstanceId}/actions/execution

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

searchengine:ExecuteSqlInstance

create

*Instance

acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}

None

Request syntax

POST /openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances/{sqlInstanceId}/actions/execution HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	ha-cn-pl32rf0****
database	string	Yes	The database name.	general
sqlInstanceId	integer	Yes	The SQL instance ID.	1
body	object	No	The request body.
content	string	Yes	The SQL content.	select * from test
kvpair	object	No	The key-value (KV) struct.
	any	No	The KV struct.	{ "trace": "INFO", "databaseName": "general", "iquan.plan.cache.enable": true, "iquan.plan.prepare.level": "jni.post.optimize", "urlencode_data": false, "formatType": "string", "timeout": 1000 }
dynamicParam	object	No	The dynamic parameters.
	any	No	The dynamic extension parameters.	{ "trace": "INFO", "databaseName": "general", "iquan.plan.cache.enable": true, "iquan.plan.prepare.level": "jni.post.optimize", "urlencode_data": false, "formatType": "string", "timeout": 1000 }
staticParam	object	No	The static parameters.
	any	No	The static parameters.	{ "trace": "INFO", "databaseName": "general", "iquan.plan.cache.enable": true, "iquan.plan.prepare.level": "jni.post.optimize", "urlencode_data": false, "formatType": "string", "timeout": 1000 }
domain	string	No	The data center of the data source.	vpc_hz_domain_1
params	object	No	The SQL runtime parameters.
	any	No	The SQL runtime parameters.	{ "trace": "INFO", "databaseName": "general", "iquan.plan.cache.enable": true, "iquan.plan.prepare.level": "jni.post.optimize", "urlencode_data": false, "formatType": "string", "timeout": 1000 }
combineParam	object	No	The combined parameters.
	any	No	The combined parameters.	{ "trace": "INFO", "databaseName": "general", "iquan.plan.cache.enable": true, "iquan.plan.prepare.level": "jni.post.optimize", "urlencode_data": false, "formatType": "string", "timeout": 1000 }

Response elements

Element	Type	Description	Example
	object
requestId	string	The request ID.	FE03180A-0E29-5474-8A86-33F0683294A4
result	object	The returned result.
id	integer	The primary key ID.	22
gmtCreate	string	The time when the instance was created.	1719221186114
gmtModified	string	The time when the instance was last modified.	1719220182844
name	string	The name.	test
parent	integer	The parent task ID.	-1
isDir	integer	Specifies whether the item is a folder. A value of 0 indicates that it is not a folder. A value of 1 indicates that it is a folder.	true
type	string	The type. Valid values: `table`, `instance`, `template`, and `function`.	instance
instanceId	integer	The instance ID.	ha-cn-pl32rf0****
templateId	integer	The template ID.	1

Examples

Success response

JSON format

{
  "requestId": "FE03180A-0E29-5474-8A86-33F0683294A4",
  "result": {
    "id": 22,
    "gmtCreate": "1719221186114",
    "gmtModified": "1719220182844",
    "name": "test",
    "parent": -1,
    "isDir": 0,
    "type": "instance",
    "instanceId": 0,
    "templateId": 1
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.