調用ListSQLReviewOriginSQL擷取SQL審核工單的SQL詳情-Data Management-阿里雲

擷取SQL審核工單的SQL詳情結果。

介面說明

SQL 審核功能的更多資訊，請參見 SQL 審核。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dms:ListSQLReviewOriginSQL

list

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
OrderId	integer	是	SQL 審核工單號。您可以調用 CreateSQLReviewOrder 介面擷取該參數。	903****
OrderActionDetail	object	否	工單參數（過濾條件）。
FileId	integer	否	審核檔案 ID。	85****
SQLReviewResult	string	否	SQL 審核最佳化建議。取值如下： MUST_IMPROVE：必須改進。 POTENTIAL_ISSUE：潛在問題。 SUGGEST_IMPROVE：建議改進。 USE_DMS_TOOLKIT：使用無鎖結構變更。 USE_DMS_DML_UNLOCK：使用無鎖資料變更。 TABLE_INDEX_SUGGEST：索引推薦。	MUST_IMPROVE
CheckStatusResult	string	否	檢測結果。取值及說明如下： new：等待分析。 unknown：解析異常。 check_not_pass：檢測不通過。 check_pass：檢測通過。 force_pass：人工通過。 force_not_pass：人工不通過。	check_not_pass
Page	object	否	分頁參數。
PageNumber	integer	否	從第幾頁開始。	1
PageSize	integer	否	每頁資料量。	20
Tid	integer	否	租戶 ID。您可以調用 GetUserActiveTenant 或 ListUserTenants 介面擷取該參數。	233***

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID，用於定位日誌，排查問題。	0A00863F-6366-5583-9B96-891DC8D8F88A
ErrorCode	string	錯誤碼。	UnknownError
ErrorMessage	string	調用 API 失敗時，返回的錯誤資訊。	UnknownError
Success	boolean	請求是否成功。傳回值及說明如下： true：請求成功。 false：請求失敗。	true
TotalCount	integer	檔案中所包含的 SQL 條數。	1
OriginSQLList	array<object>	解析的 SQL 列表。
	object	單條 SQL 詳情。
SQLId	integer	SQL 陳述式 ID。	1111
FileId	integer	檔案 ID。	858***
FileName	string	檔案名稱。	test.sql
SQLContent	string	檔案中的 SQL 內容。	CREATE TABLE `test_sql_review_table` ( `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT, `gmt_create` datetime NOT NULL, `name` varchar(256) DEFAULT NULL ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
CheckStatus	string	檢測結果。傳回值及說明如下： new：等待分析。 unknown：解析異常。 check_not_pass：檢測不通過。 check_pass：檢測通過。 force_pass：人工通過。 force_not_pass：人工不通過。	check_pass
StatusDesc	string	檢測結果描述。	檢測通過
CheckedTime	string	SQL 檢測時間。	2021-06-09 21:07:00
SqlHash	string	對 SQL 內容進行 MD5 散列演算法後得到的值。	c7992dc1b681c6733894aded7834f423
ReviewSummary	string	SQL 審核最佳化建議的統計資訊（JSON 字串）。傳回值及說明如下： MUST_IMPROVE：必須改進。 POTENTIAL_ISSUE：潛在問題。 SUGGEST_IMPROVE：建議改進。 USEDMSTOOLKIT：使用無鎖結構變更。 USEDMSDML_UNLOCK：使用無鎖資料變更。 TABLEINDEXSUGGEST：索引推薦。	{\"SUGGEST_IMPROVE\":2,\"POTENTIAL_ISSUE\":1}
SQLReviewQueryKey	string	查詢 SQL 審核最佳化建議資訊的 Key。根據此 Key 調用 GetSQLReviewOptimizeDetail 介面擷取詳情。	6e9a4bc6867a4174a96b23c8b48b****
SQLName	string	SQL 名稱。	getByPk

樣本

正常返回樣本

JSON格式

{
  "RequestId": "0A00863F-6366-5583-9B96-891DC8D8F88A",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "TotalCount": 1,
  "OriginSQLList": [
    {
      "SQLId": 1111,
      "FileId": 0,
      "FileName": "test.sql",
      "SQLContent": "CREATE TABLE `test_sql_review_table` (\n  `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,\n  `gmt_create` datetime NOT NULL,\n  `name` varchar(256) DEFAULT NULL\n) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;",
      "CheckStatus": "check_pass",
      "StatusDesc": "檢測通過",
      "CheckedTime": "2021-06-09 21:07:00",
      "SqlHash": "c7992dc1b681c6733894aded7834f423",
      "ReviewSummary": "{\\\"SUGGEST_IMPROVE\\\":2,\\\"POTENTIAL_ISSUE\\\":1}",
      "SQLReviewQueryKey": "6e9a4bc6867a4174a96b23c8b48b****",
      "SQLName": "getByPk"
    }
  ]
}

錯誤碼

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

變更歷史

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