すべてのプロダクト
Search

このプロダクト

    :GetQueryOptimizeDataStats

    ドキュメントセンター

    :GetQueryOptimizeDataStats

    最終更新日:Dec 19, 2025

    クエリガバナンスデータに基づいて SQL テンプレートに関する情報を照会します。

    操作説明

    • Alibaba Cloud SDK を使用する場合、aliyun-sdk-core のバージョンが V2.1.8 以降であることを確認してください。 最新バージョンを使用することを推奨します。

    • Database Autonomy Service (DAS) SDK のバージョンは V2.1.8 以降である必要があります。

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

    • この操作は、次のデータベースエンジンをサポートしています：

      • ApsaraDB RDS for MySQL

      • PolarDB for MySQL

      • ApsaraDB RDS for PostgreSQL

    今すぐお試しください

    この 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:GetQueryOptimizeDataStats

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Engine

    string

    必須

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

    • MySQL

    • PolarDBMySQL

    • PostgreSQL

    MySQL
    InstanceIds

    string

    任意

    インスタンス ID。 複数の ID はコンマ (,) で区切ります。

    rm-2ze8g2am97624****
    TagNames

    string

    任意

    予約済みパラメーター。

    None
    Keywords

    string

    任意

    SQL テンプレートのキーワード。 複数のキーワードはスペースで区切ります。

    select update
    LogicalOperator

    string

    任意

    複数のキーワード間の論理関係。 有効な値：

    • or

    • and

    or
    Rules

    string

    任意

    SQL テンプレートのフィルターに使用されるタグ。 複数のタグはコンマ (,) で区切ります。 詳細については、「クエリガバナンス」をご参照ください。

    DAS_NOT_IMPORTANT
    DbNames

    string

    任意

    照会するデータベースの名前。

    testdb01
    Time

    string

    必須

    照会する時間範囲。 UNIX タイムスタンプ形式で時間を指定します。 単位：ミリ秒。

    1642953600000
    PageSize

    string

    任意

    1 ページあたりのエントリ数。 デフォルト値：10。

    10
    PageNo

    string

    任意

    ページ番号。 ページは 1 から始まります。 デフォルト値：1。

    1
    OrderBy

    string

    任意

    返されるエントリの並べ替えに使用するフィールド。 デフォルト値：count。 有効な値：

    • count：実行回数。

    • maxQueryTime：最長実行時間。

    • avgQueryTime：平均実行時間。

    • maxLockTime：最長ロック待ち時間。

    • avgLockTime：平均ロック待ち時間。

    • maxRowsExamined：最大スキャン行数。

    • avgRowsExamined：平均スキャン行数。

    • maxRowsSent：最大返却行数。

    • avgRowsSent：平均返却行数。

    count
    Asc

    string

    任意

    返されるエントリを昇順で並べ替えるかどうかを指定します。 デフォルト値：true。 有効な値：

    • true：返されるエントリを昇順で並べ替えます。

    • false：返されるエントリを昇順で並べ替えません。

    true
    OnlyOptimizedSql

    string

    任意

    最適化が必要な SQL テンプレートのみを照会するかどうかを指定します。 デフォルト値：false。 有効な値：

    • true：最適化が必要な SQL テンプレートのみを照会します。

    • false：最適化が必要な SQL 文のみを照会しません。

    false
    SqlIds

    string

    任意

    SQL テンプレート ID。 GetQueryOptimizeExecErrorStats 操作を呼び出すことで、テンプレートの ID を照会できます。

    2e8147b5ca2dfc640dfd5e43d96a****
    Region

    string

    任意

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

    • cn-china：中国本土

    • cn-hongkong：中国 (香港)

    • ap-southeast-1：シンガポール

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

    説明

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

    cn-china
    User

    string

    任意

    照会するデータベースのアカウント。

    testUser

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Code

    string

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

    200
    Message

    string

    返されたメッセージ。

    Successful
    Data

    object

    返されたデータ。

    Total

    integer

    返されたエントリの総数。

    10
    PageNo

    integer

    予約済みパラメーター。

    None
    PageSize

    integer

    予約済みパラメーター。

    None
    Extra

    string

    予約済みパラメーター。

    None
    List

    array<object>

    SQL テンプレートに関する情報。

    array<object>

    InstanceId

    string

    インスタンス ID。

    rm-2ze8g2am97624****
    Dbname

    string

    SQL テンプレートが属するデータベースの名前。

    testdb01
    SqlId

    string

    SQL テンプレート ID。

    2e8147b5ca2dfc640dfd5e43d96a****
    SqlType

    string

    SQL 文のタイプ。

    INSERT
    Psql

    string

    SQL テンプレート。

    select 1
    SqlSample

    string

    実行に最も時間がかかったサンプルクエリ。

    select 2
    Count

    integer

    SQL テンプレートが実行された回数。

    100
    MaxQueryTime

    number

    最長クエリ実行時間。 単位：秒。

    1.1
    AvgQueryTime

    number

    平均クエリ実行時間。 単位：秒。

    1.1
    MaxLockTime

    number

    最長ロック待ち時間。 単位：秒。

    0.1
    AvgLockTime

    number

    平均ロック待ち時間。 単位：秒。

    0.1
    MaxRowsExamined

    integer

    最大スキャン行数。

    100000
    AvgRowsExamined

    number

    平均スキャン行数。

    100.1
    MaxRowsSent

    integer

    最大返却行数。

    10000
    AvgRowsSent

    number

    平均返却行数。

    100.1
    MaxRowsAffected

    integer

    SQL テンプレートが影響を与えた最大行数。

    説明

    -1 の値は、このパラメーターが収集されないことを示します。

    10000
    AvgRowsAffected

    number

    SQL 文が影響を与えた平均行数。

    説明

    -1 の値は、このパラメーターが収集されないことを示します。

    100.1
    RuleList

    array<object>

    ルールに関する情報。

    object

    Name

    string

    ルール名。

    DAS_NOT_IMPORTANT
    Type

    string

    ルールのタイプ。 有効な値：

    • Predefined

    • UserDefined

    Predefined
    User

    string

    データベースのアカウント。

    testUser
    RequestId

    string

    リクエスト ID。

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

    string

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

    • true：リクエストは成功しました。

    • false：リクエストは失敗しました。

    true

    例

    成功レスポンス

    JSONJSON

    {
  "Code": "200",
  "Message": "Successful",
  "Data": {
    "Total": 10,
    "PageNo": 0,
    "PageSize": 0,
    "Extra": "None",
    "List": [
      {
        "InstanceId": "rm-2ze8g2am97624****",
        "Dbname": "testdb01",
        "SqlId": "2e8147b5ca2dfc640dfd5e43d96a****",
        "SqlType": "INSERT",
        "Psql": "select 1",
        "SqlSample": "select 2",
        "Count": 100,
        "MaxQueryTime": 1.1,
        "AvgQueryTime": 1.1,
        "MaxLockTime": 0.1,
        "AvgLockTime": 0.1,
        "MaxRowsExamined": 100000,
        "AvgRowsExamined": 100.1,
        "MaxRowsSent": 10000,
        "AvgRowsSent": 100.1,
        "MaxRowsAffected": 10000,
        "AvgRowsAffected": 100.1,
        "RuleList": [
          {
            "Name": "DAS_NOT_IMPORTANT",
            "Type": "Predefined"
          }
        ],
        "User": "testUser"
      }
    ]
  },
  "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.

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

    変更履歴

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