すべてのプロダクト
Search

このプロダクト

    Data Management:ListSQLReviewOriginSQL

    ドキュメントセンター

    Data Management:ListSQLReviewOriginSQL

    最終更新日:Mar 21, 2026

    SQL レビュー チケットに関連付けられた 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:ListSQLReviewOriginSQL

    list

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    OrderId

    integer

    必須

    SQL レビュー チケットの ID です。チケット ID を照会するには、CreateSQLReviewOrder 操作を呼び出します。

    903****
    OrderActionDetail

    object

    任意

    チケットに関連付けられた SQL ステートメントをフィルター処理するために使用するパラメーターです。

    FileId

    integer

    任意

    レビュー対象の SQL ステートメントを含むファイルの ID です。

    85****
    SQLReviewResult

    string

    任意

    SQL ステートメントに対する最適化の提案です。有効な値は以下のとおりです。

    • MUST_IMPROVE：SQL ステートメントを必ず最適化する必要があります。

    • POTENTIAL_ISSUE：SQL ステートメントに潜在的な問題が含まれています。

    • SUGGEST_IMPROVE：SQL ステートメントの最適化を推奨します。

    • USE_DMS_TOOLKIT：テーブルのロックを回避してスキーマを変更することを推奨します。

    • USE_DMS_DML_UNLOCK：テーブルのロックを回避してデータを変更することを推奨します。

    • TABLE_INDEX_SUGGEST：SQL ステートメントに対してインデックスの最適化を推奨します。

    MUST_IMPROVE
    CheckStatusResult

    string

    任意

    SQL ステートメントのレビュー状況です。有効な値は以下のとおりです。

    • new：SQL ステートメントはレビュー待ちです。

    • unknown：SQL ステートメントを解析できません。

    • check_not_pass：SQL ステートメントがレビューを通過できませんでした。

    • check_pass：SQL ステートメントがレビューを通過しました。

    • force_pass：SQL ステートメントが手動レビューを通過しました。

    • force_not_pass：SQL ステートメントが手動レビューを通過できませんでした。

    check_not_pass
    Page

    object

    任意

    ページネーション情報です。

    PageNumber

    integer

    任意

    ページ番号です。

    1
    PageSize

    integer

    任意

    1 ページあたりの表示件数です。

    20
    Tid

    integer

    任意

    テナント ID です。テナント ID を照会するには、GetUserActiveTenant または ListUserTenants 操作を呼び出します。

    233***

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID です。

    0A00863F-6366-5583-9B96-891DC8D8F88A
    ErrorCode

    string

    返されたエラーコードです。

    UnknownError
    ErrorMessage

    string

    リクエストが失敗した場合に返されるエラーメッセージです。

    UnknownError
    Success

    boolean

    リクエストが成功したかどうかを示します。有効な値は以下のとおりです。

    • true

    • false

    true
    TotalCount

    integer

    ファイル内の SQL ステートメントの数です。

    1
    OriginSQLList

    array<object>

    解析済み SQL ステートメントに関する情報です。

    object

    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

    SQL ステートメントのレビュー状況です。有効な値は以下のとおりです。

    • new：SQL ステートメントはレビュー待ちです。

    • unknown：SQL ステートメントを解析できません。

    • check_not_pass：SQL ステートメントがレビューを通過できませんでした。

    • check_pass：SQL ステートメントがレビューを通過しました。

    • force_pass：SQL ステートメントが手動レビューを通過しました。

    • force_not_pass：SQL ステートメントが手動レビューを通過できませんでした。

    check_pass
    StatusDesc

    string

    レビュー状況の説明です。

    检测通过
    CheckedTime

    string

    SQL ステートメントがレビューされた時刻です。

    2021-06-09 21:07:00
    SqlHash

    string

    SQL ステートメントをハッシュアルゴリズムで計算した結果得られる MD5 ハッシュ値です。

    c7992dc1b681c6733894aded7834f423
    ReviewSummary

    string

    SQL ステートメントに対する最適化の提案の統計情報です。値は JSON 文字列です。有効な値は以下のとおりです。

    • MUST_IMPROVE：SQL ステートメントを必ず最適化する必要があります。

    • POTENTIAL_ISSUE：SQL ステートメントに潜在的な問題が含まれています。

    • SUGGEST_IMPROVE：SQL ステートメントの最適化を推奨します。

    • USEDMSTOOLKIT：テーブルのロックを回避してスキーマを変更することを推奨します。

    • USEDMSDML_UNLOCK：テーブルのロックを回避してデータを変更することを推奨します。

    • TABLEINDEXSUGGEST：SQL ステートメントに対してインデックスの最適化を推奨します。

    {\"SUGGEST_IMPROVE\":2,\"POTENTIAL_ISSUE\":1}
    SQLReviewQueryKey

    string

    最適化の提案に関する情報を照会するためのキーです。このキーを指定して、GetSQLReviewOptimizeDetail 操作を呼び出すことで、詳細情報を照会できます。

    6e9a4bc6867a4174a96b23c8b48b****
    SQLName

    string

    SQL ステートメントの名前です。

    getByPk

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

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

    変更履歴

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