通過GetSQLReviewOptimizeDetail擷取SQL審核最佳化建議詳情-Data Management-阿里雲

擷取SQL審核最佳化建議的詳情，適用於資料變更工單和SQLReview工單。

介面說明

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

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dms:GetSQLReviewOptimizeDetail

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
SQLReviewQueryKey	string	是	查詢 SQL 審核最佳化建議詳情資訊。您可以調用 ListSQLReviewOriginSQL 介面擷取該參數的值。	a57e54ec5433475ea3082d882fdb****
Tid	integer	否	租戶 ID。您可以調用 GetUserActiveTenant 或 ListUserTenants 介面擷取該參數的值。	1

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
ErrorCode	string	錯誤碼。	UnknownError
ErrorMessage	string	錯誤資訊。	UnknownError
Success	boolean	請求是否成功。	true
OptimizeDetail	object	審核詳情。
QueryKey	string	SQL 審核最佳化建議詳情資訊的查詢 KEY。	a57e54ec5433475ea3082d882fdb****
InstanceId	integer	資料庫所屬執行個體 ID。	123321
DbId	integer	資料庫 ID。	111222
SqlType	string	SQL 類型，如 DELETE、UPDATE、ALTER_TABLE 等。	UPDATE
QualityResult	object	SQL 品質。
ErrorMessage	string	錯誤資訊。	syntax error
Results	array<object>	規則審核結果。
	array<object>	一條規則的審核詳情。
RuleName	string	規則名。請參見 SQL 審核最佳化建議。	SELECT_SUGGEST_ASSIGN_WHERE
Feedback	string	SQL 審核最佳化反饋結果。傳回值如下： MUST_IMPROVE：必須改進。 POTENTIAL_ISSUE：潛在問題。 SUGGEST_IMPROVE：建議改進。 USEDMSTOOLKIT：使用無鎖結構變更。 USEDMSDML_UNLOCK：使用無鎖資料變更。 TABLEINDEXSUGGEST：索引推薦。	MUST_IMPROVE
Comments	string	管理員進行 SQL 審核規則自訂配置時填寫的備忘資訊。詳細操作，請參見 SQL 審核最佳化建議。	xxx業務規定：查詢必須帶where條件
Messages	array	審核資訊列表。
	string	審核資訊。	xxx表不存在
Scripts	array<object>	某些規則附帶產生變更指令碼。
	object	變更指令碼。
OpType	string	執行指令碼的目的。當前支援 AddIndex（增加索引）。	AddIndex
Content	string	指令碼內容。	alter table xxx add index idx_xx(yyy);
TableName	string	表名。	xxx
RuleType	string	SQL 審核規則。傳回值如下： REVIEW：規範審核。 OPTIMIZE：最佳化建議。	REVIEW
OccurError	boolean	是否遇到錯誤。傳回值如下： true：存在錯誤。 false：不存在錯誤。	false

樣本

正常返回樣本

JSON格式

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "OptimizeDetail": {
    "QueryKey": "a57e54ec5433475ea3082d882fdb****",
    "InstanceId": 123321,
    "DbId": 111222,
    "SqlType": "UPDATE",
    "QualityResult": {
      "ErrorMessage": "syntax error",
      "Results": [
        {
          "RuleName": "SELECT_SUGGEST_ASSIGN_WHERE",
          "Feedback": "MUST_IMPROVE",
          "Comments": "xxx業務規定：查詢必須帶where條件",
          "Messages": [
            "xxx表不存在"
          ],
          "Scripts": [
            {
              "OpType": "AddIndex",
              "Content": "alter table xxx add index idx_xx(yyy);",
              "TableName": "xxx"
            }
          ],
          "RuleType": "REVIEW"
        }
      ],
      "OccurError": false
    }
  }
}

錯誤碼

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

變更歷史

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