調用ExecuteSqlInstance API執行SQL執行個體-智能OpenSearch OpenSearch-阿里雲

執行SQL執行個體。

介面說明

方法

POST

URI

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

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

searchengine:ExecuteSqlInstance

create

*Instance

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

無

請求文法

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

請求參數

名稱	類型	必填	描述	樣本值
instanceId	string	是	執行個體 id	ha-cn-pl32rf0****
database	string	是	資料庫名稱	general
sqlInstanceId	integer	是	sql 執行個體 id	1
body	object	否	請求體參數
content	string	是	sql 內容	select * from test
kvpair	object	否	kv 結構體
	any	否	kv 結構體	{ "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	否	動態參數
	any	否	動態擴充參數	{ "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	否	靜態參數
	any	否	靜態參數	{ "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	否	資料來源機房	vpc_hz_domain_1
params	object	否	sql 執行參數
	any	否	sql 執行參數	{ "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	否	組合參數
	any	否	組合參數	{ "trace": "INFO", "databaseName": "general", "iquan.plan.cache.enable": true, "iquan.plan.prepare.level": "jni.post.optimize", "urlencode_data": false, "formatType": "string", "timeout": 1000 }

返回參數

名稱	類型	描述	樣本值
	object
requestId	string	請求 ID	FE03180A-0E29-5474-8A86-33F0683294A4
result	object	返回結果。
id	integer	主鍵 id	22
gmtCreate	string	建立時間	1719221186114
gmtModified	string	修改時間	1719220182844
name	string	名稱	test
parent	integer	父任務 id。	-1
isDir	integer	是否為目錄。取值：-true：是-false：否	true
type	string	table, instance, template, function	instance
instanceId	integer	執行個體 id。	ha-cn-pl32rf0****
templateId	integer	模板 ID。	1

樣本

正常返回樣本

JSON格式

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

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。