GetSQLReviewOptimizeDetail API の説明 - Data Management (DMS)

最適化の提案に関する詳細情報を照会します。この操作は、データ変更および SQL レビューのチケットにのみ適用されます。

操作説明

SQL レビュー機能の詳細については、「SQL レビュー」をご参照ください。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dms:GetSQLReviewOptimizeDetail

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
SQLReviewQueryKey	string	必須	最適化の提案に関する詳細情報を照会するためのキーです。このキーは、ListSQLReviewOriginSQL 操作を呼び出して取得できます。	a57e54ec5433475ea3082d882fdb****
Tid	integer	任意	テナントの ID です。この ID は、GetUserActiveTenant または ListUserTenants 操作を呼び出して取得できます。	1

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストの ID です。	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
ErrorCode	string	返されたエラーコードです。	UnknownError
ErrorMessage	string	返されたエラーメッセージです。	UnknownError
Success	boolean	リクエストが成功したかどうかを示します。	true
OptimizeDetail	object	SQL ステートメントに対する最適化の提案の詳細情報です。
QueryKey	string	最適化の提案に関する詳細情報を照会するためのキーです。	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：SQL ステートメントを必ず改善する必要があります。 POTENTIAL_ISSUE：SQL ステートメントには潜在的な問題が含まれています。 SUGGEST_IMPROVE：SQL ステートメントの改善を推奨します。 USEDMSTOOLKIT：テーブルのロックを回避してスキーマを変更することを推奨します。 USEDMSDML_UNLOCK：テーブルのロックを回避してデータを変更することを推奨します。 TABLEINDEXSUGGEST：インデックスを利用する SQL ステートメントを使用することを推奨します。	MUST_IMPROVE
Comments	string	SQL レビューのルールを作成時に指定したコメントです。詳細については、「SQL レビューの最適化」をご参照ください。	xxx业务规定：查询必须带where条件
Messages	array	レビュー結果です。
	string	監査情報です。	xxx表不存在
Scripts	array<object>	データ変更用の SQL スクリプトです。
	object
OpType	string	SQL スクリプトの目的です。値は AddIndex に設定されます。	AddIndex
Content	string	SQL スクリプトの内容です。	alter table xxx add index idx_xx(yyy);
TableName	string	テーブル名です。	xxx
RuleType	string	SQL レビューのルールの種類です。有効な値： REVIEW：標準に基づいて SQL ステートメントをレビューするルール。 OPTIMIZE：最適化の提案を提供するルール。	REVIEW
OccurError	boolean	エラーが発生したかどうかを示します。有効な値： true：エラーが発生しました。 false：エラーは発生しませんでした。	false

例

成功レスポンス

JSONJSON

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

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。