調用ExecuteScript API執行SQL指令碼-Data Management-阿里雲 - Data Management

調用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。	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
}

錯誤碼

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

變更歷史

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