調用GetSqlInstance API擷取SQL執行個體資訊-智能OpenSearch OpenSearch-阿里雲 - OpenSearch

取得 SQL 執行個體資訊。

介面說明

方法

GET

URI

/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances/{sqlInstanceId}
```。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

searchengine:GetSqlInstance

get

*Instance

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

無

請求文法

GET /openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances/{sqlInstanceId} HTTP/1.1

路徑參數

名稱	類型	必填	描述	樣本值
instanceId	string	是	執行個體 id。	ha-cn-pl32rf0****
database	string	是	資料庫名稱。	general
sqlInstanceId	integer	是	sql 執行個體 id。	5978

請求參數

名稱	類型	必填	描述	樣本值
version	integer	否	執行個體版本。	1

返回參數

名稱	類型	描述	樣本值
	object
requestId	string	請求 ID。	10D5E615-69F7-5F49-B850-00169ADE513C
result	object	返回結果。
gmtCreate	string	建立時間。	1719220182844
gmtModified	string	修改時間。	1719221186114
instanceId	integer	執行個體 id。	ha-cn-pl32rf0****
version	integer	版本號。	1
comment	string	備註。	init version
relatedTemplateId	integer	範本 id。	1
content	string	sql 內容。	select * from test
kvpairs	string	kv 包解析結果。	{\"trace\":\"INFO\",\"databaseName\":\"general\",\"iquan.plan.cache.enable\":true,\"iquan.plan.prepare.level\":\"jni.post.optimize\",\"urlencode_data\":false,\"formatType\":\"string\",\"timeout\":1000}
dynamicParams	string	動態擴展參數。	{\"trace\":\"INFO\",\"databaseName\":\"general\",\"iquan.plan.cache.enable\":true,\"iquan.plan.prepare.level\":\"jni.post.optimize\",\"urlencode_data\":false,\"formatType\":\"string\",\"timeout\":1000}
templateParams	string	範本參數。	{\"trace\":\"INFO\",\"databaseName\":\"general\",\"iquan.plan.cache.enable\":true,\"iquan.plan.prepare.level\":\"jni.post.optimize\",\"urlencode_data\":false,\"formatType\":\"string\",\"timeout\":1000}
staticParams	string	靜態參數。	{\"trace\":\"INFO\",\"databaseName\":\"general\",\"iquan.plan.cache.enable\":true,\"iquan.plan.prepare.level\":\"jni.post.optimize\",\"urlencode_data\":false,\"formatType\":\"string\",\"timeout\":1000}
combineParams	string	組合參數。	{\"trace\":\"INFO\",\"databaseName\":\"general\",\"iquan.plan.cache.enable\":true,\"iquan.plan.prepare.level\":\"jni.post.optimize\",\"urlencode_data\":false,\"formatType\":\"string\",\"timeout\":1000}

樣本

正常返回樣本

JSON格式

{
  "requestId": "10D5E615-69F7-5F49-B850-00169ADE513C",
  "result": {
    "gmtCreate": "1719220182844",
    "gmtModified": "1719221186114",
    "instanceId": 0,
    "version": 1,
    "comment": "init version",
    "relatedTemplateId": 1,
    "content": "select * from test",
    "kvpairs": "{\\\"trace\\\":\\\"INFO\\\",\\\"databaseName\\\":\\\"general\\\",\\\"iquan.plan.cache.enable\\\":true,\\\"iquan.plan.prepare.level\\\":\\\"jni.post.optimize\\\",\\\"urlencode_data\\\":false,\\\"formatType\\\":\\\"string\\\",\\\"timeout\\\":1000}",
    "dynamicParams": "{\\\"trace\\\":\\\"INFO\\\",\\\"databaseName\\\":\\\"general\\\",\\\"iquan.plan.cache.enable\\\":true,\\\"iquan.plan.prepare.level\\\":\\\"jni.post.optimize\\\",\\\"urlencode_data\\\":false,\\\"formatType\\\":\\\"string\\\",\\\"timeout\\\":1000}",
    "templateParams": "{\\\"trace\\\":\\\"INFO\\\",\\\"databaseName\\\":\\\"general\\\",\\\"iquan.plan.cache.enable\\\":true,\\\"iquan.plan.prepare.level\\\":\\\"jni.post.optimize\\\",\\\"urlencode_data\\\":false,\\\"formatType\\\":\\\"string\\\",\\\"timeout\\\":1000}",
    "staticParams": "{\\\"trace\\\":\\\"INFO\\\",\\\"databaseName\\\":\\\"general\\\",\\\"iquan.plan.cache.enable\\\":true,\\\"iquan.plan.prepare.level\\\":\\\"jni.post.optimize\\\",\\\"urlencode_data\\\":false,\\\"formatType\\\":\\\"string\\\",\\\"timeout\\\":1000}",
    "combineParams": "{\\\"trace\\\":\\\"INFO\\\",\\\"databaseName\\\":\\\"general\\\",\\\"iquan.plan.cache.enable\\\":true,\\\"iquan.plan.prepare.level\\\":\\\"jni.post.optimize\\\",\\\"urlencode_data\\\":false,\\\"formatType\\\":\\\"string\\\",\\\"timeout\\\":1000}"
  }
}

錯誤碼

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

變更歷史

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