すべてのプロダクト
Search

このプロダクト

    :GetSqlOptimizeAdvice

    ドキュメントセンター

    :GetSqlOptimizeAdvice

    最終更新日:Dec 19, 2025

    Database Autonomy Service (DAS) の SQL 診断機能によって生成された最適化の提案を照会します。

    操作説明

    SQL 診断機能は、診断結果に基づいてインスタンスの最適化の提案を提供します。 最適化の提案を使用して、インスタンスのインデックスを最適化できます。 詳細については、「自動 SQL 最適化」をご参照ください。

    説明

    この操作を呼び出して、SQL 診断機能によって自動的に生成された最適化の提案のみを照会できます。

    この操作を呼び出す前に、次の点にご注意ください：

    • この操作は、ApsaraDB RDS for MySQL インスタンスおよび PolarDB for MySQL クラスターに適用されます。

    • Alibaba Cloud SDK または DAS SDK を使用してこの操作を呼び出す場合は、最新バージョンの SDK を使用することを推奨します。

    • SDK を使用して DAS の操作を呼び出す場合は、リージョン ID を cn-shanghai に設定する必要があります。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    hdm:GetSqlOptimizeAdvice

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ConsoleContext

    string

    任意

    予約済みのパラメーター。

    None
    Engine

    string

    任意

    データベースエンジン。 有効な値：

    • MySQL: ApsaraDB RDS for MySQL。

    • PolarDBMySQL: PolarDB for MySQL。

    MySQL
    InstanceIds

    string

    任意

    インスタンス ID。

    説明

    データベースインスタンスが ApsaraDB RDS for MySQL インスタンスまたは PolarDB for MySQL クラスターである場合にのみ、インスタンス ID を指定する必要があります。

    rm-2ze1jdv45i7l6****
    StartDt

    string

    任意

    照会する期間の開始日。 yyyyMMdd 形式で日付を指定します。 時刻は UTC である必要があります。

    • このパラメーターのデフォルト値は、現在の日付の前日です。

    • 値は現在の日付より前である必要があります。

    20210916
    EndDt

    string

    任意

    照会する期間の終了日。 yyyyMMdd 形式で日付を指定します。 時刻は UTC である必要があります。

    • このパラメーターのデフォルト値は、現在の日付の前日です。

    • 値は現在の日付より前である必要があります。 開始日と終了日の間隔は 30 日を超えることはできません。

    20210917
    Region

    string

    任意

    インスタンスが存在するリージョン。 有効な値：

    • cn-china: 中国本土。

    • cn-hongkong: 中国 (香港)。

    • ap-southeast-1: シンガポール。

    このパラメーターは、InstanceIds が空の場合にのみ有効になります。 InstanceIds を空のままにした場合、システムは Region で指定されたリージョンからデータを取得します。 デフォルトでは、Region は cn-china に設定されています。 InstanceIds を指定した場合、Region は有効にならず、システムは最初に指定されたインスタンスが存在するリージョンからデータを取得します。****

    説明

    インスタンスが中国本土内のリージョンにある場合は、このパラメーターを cn-china に設定します。

    cn-china

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Code

    string

    返される HTTP ステータスコード。

    200
    Message

    string

    返されたメッセージ。

    説明

    リクエストが成功した場合は、Successful が返されます。 リクエストが失敗した場合は、エラーコードなどのエラーメッセージが返されます。

    Successful
    Data

    object

    エラーコードや返されるエントリ数などの詳細情報。

    Status

    string

    タスクのステータス。 有効な値：

    • INIT: タスクは初期化中です。

    • RUNNING: タスクは実行中です。

    • FINISH: タスクは完了しました。

    • FAILED: タスクは失敗しました。

    FINISH
    StatusCode

    string

    タスクの状態コード。 有効な値：

    • NO_DATA: データは返されません。

    • INTERNAL_ERROR: 内部エラーが発生しました。

    • SUCCESS: タスクは成功しました。

    SUCCESS
    DownloadUrl

    string

    ファイルのダウンロードに使用される URL。

    https://das-sql-optimize.oss-cn-shanghai.aliyuncs.com/adb/oss_sql_optimize_advice/1083*******
    CreateTime

    string

    タスクが作成された時刻。 値は、協定世界時 (UTC) 1970年1月1日 00:00:00 から経過したミリ秒単位の UNIX タイムスタンプです。

    1632303861000
    ExpireTime

    string

    ファイルの有効期限が切れる時刻。 値は、協定世界時 (UTC) 1970年1月1日 00:00:00 から経過したミリ秒単位の UNIX タイムスタンプです。

    説明

    ファイルはタスク作成から 3 日後に有効期限が切れます。

    1632563061000
    TaskId

    string

    タスク ID。

    2021091710461519216****
    RequestId

    string

    リクエスト ID。

    B6D17591-B48B-4D31-9CD6-9B9796B2****
    Success

    string

    リクエストが成功したかどうかを示します。 有効な値：

    • true

    • false

    true

    例

    成功レスポンス

    JSONJSON

    {
  "Code": "200",
  "Message": "Successful",
  "Data": {
    "Status": "FINISH",
    "StatusCode": "SUCCESS",
    "DownloadUrl": "https://das-sql-optimize.oss-cn-shanghai.aliyuncs.com/adb/oss_sql_optimize_advice/1083*******",
    "CreateTime": "1632303861000",
    "ExpireTime": "1632563061000",
    "TaskId": "2021091710461519216****"
  },
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": "true"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidParams The request parameters are invalid.
    403 NoPermission You are not authorized to do this action.

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

    変更履歴

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