すべてのプロダクト
Search

このプロダクト

    Database Autonomy Service:GetSqlOptimizeAdvice

    ドキュメントセンター

    Database Autonomy Service:GetSqlOptimizeAdvice

    最終更新日:Aug 25, 2026

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

    操作説明

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

    説明

    この操作は、DAS の自動 SQL 最適化機能によって生成された診断提案をクエリする場合にのみ呼び出しできます。

    開始する前に:

    • データベースの DPI エンジンが RDS MySQL または PolarDB for MySQL であること。

    • China サイト (aliyun.com) または DAS SDK を使用する場合は、最新バージョンを使用してください。

    • SDK を使用して DAS を呼び出す場合は、リージョンを 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

    *すべてのリソース。

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ConsoleContext

    string

    任意

    予約済みパラメーター。

    None
    Engine

    string

    任意

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

    • MySQL: RDS MySQL。

    • PolarDBMySQL: PolarDB for MySQL。

    MySQL
    InstanceIds

    string

    任意

    インスタンスの ID。

    説明

    RDS MySQL および PolarDB for MySQL インスタンスのみがサポートされています。

    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 パラメーターで指定されたリージョンに基づいてデータが取得されます。デフォルトのリージョンは cn-china です。InstanceIds が空でない場合、Region パラメーターが設定されていても、InstanceIds で指定された最初のインスタンスのリージョンに基づいてデータが取得されます。

    説明

    中国本土のリージョンで作成されたインスタンスの場合は、このパラメーターを cn-china に設定してください。

    cn-china

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Code

    string

    返される状態コード。

    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

    タスクが作成された時間。値は UNIX タイムスタンプです。単位: ミリ秒。

    1632303861000
    ExpireTime

    string

    ファイルの有効期限となる時間。値は 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. この操作を実行する権限がありません。

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

    変更履歴

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