すべてのプロダクト
Search
ドキュメントセンター

AnalyticDB:DescribeDiagnosisRecords

最終更新日:Feb 26, 2026

AnalyticDB for MySQL クラスター内で条件に合致する 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

adb:DescribeDiagnosisRecords

get

DBCluster

acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

DBClusterId

string

必須

クラスター ID。

説明

地域内のすべての AnalyticDB for MySQL クラスター(クラスター ID を含む)の情報を照会するには、「DescribeDBClusters」操作を呼び出します。

am-bp1r053byu48p****

StartTime

string

必須

照会対象の時間範囲の開始時刻。1970 年 1 月 1 日 00:00:00 UTC を基準とした、経過ミリ秒数を表す UNIX タイムスタンプを指定します。

説明

過去 14 日以内のデータのみ照会可能です。

1632931200000

EndTime

string

必須

照会対象の時間範囲の終了時刻。1970 年 1 月 1 日 00:00:00 UTC を基準とした、経過ミリ秒数を表す UNIX タイムスタンプを指定します。

説明
  • 終了時刻は開始時刻より後である必要があります。

  • 指定可能な最大時間範囲は 24 時間です。

1633017540000

RegionId

string

必須

クラスターのリージョン ID。

説明

最新のリージョン一覧を照会するには、「DescribeRegions」操作を呼び出します。

cn-hangzhou

QueryCondition

string

必須

SQL 文に対する照会条件。JSON 形式で指定し、Type、Value、および Min または Max フィールドを含めることができます。Type は照会ディメンションを指定します。Type の有効値: maxCoststatuscostValueMin、または Max は、該当ディメンションの照会範囲を指定します。有効な例:

  • {"Type":"maxCost","Value":"100"}:実行時間が最も長い上位 100 件の SQL 文を照会します。Value を 100 に設定します。

  • {"Type":"status","Value":"finished"}:実行済みの SQL 文を照会します。Valuerunning に設定すると、実行中の SQL 文を照会できます。Valuefailed に設定すると、実行に失敗した SQL 文を照会できます。

  • {"Type":"cost","Min":"10","Max":"200"}:実行時間が 10 ~ 200 ミリ秒の範囲にある SQL 文を照会します。最小・最大実行時間は任意にカスタマイズ可能です。

{"Type":"status","Value":"finished"}

Keyword

string

任意

照会キーワード。

select

MinPeakMemory

integer

任意

SQL 文のピークメモリの最小値。単位:バイト。

0

MaxPeakMemory

integer

任意

SQL 文のピークメモリの最大値。単位:バイト。

89000000

MinScanSize

integer

任意

SQL 文のスキャンサイズの最小値。単位:バイト。

0

MaxScanSize

integer

任意

SQL 文のスキャンサイズの最大値。単位:バイト。

104428198

ResourceGroup

string

任意

SQL 文が属するリソースグループ。

説明

照会対象の SQL 文のリソースグループ、データベース名、ユーザー名、およびソース IP アドレスを照会するには、「DescribeDiagnosisDimensions」操作を呼び出します。

user_default

UserName

string

任意

SQL 文を実行するユーザー名。

説明

照会対象の SQL 文のリソースグループ、データベース名、ユーザー名、およびソース IP アドレスを照会するには、「DescribeDiagnosisDimensions」操作を呼び出します。

test_user

Database

string

任意

SQL 文が実行されるデータベース。

説明

照会対象の SQL 文のリソースグループ、データベース名、ユーザー名、およびソース IP アドレスを照会するには、「DescribeDiagnosisDimensions」操作を呼び出します。

adb_demo

ClientIp

string

任意

ソース IP アドレス。

説明

照会対象の SQL 文のリソースグループ、データベース名、ユーザー名、およびソース IP アドレスを照会するには、「DescribeDiagnosisDimensions」操作を呼び出します。

59.82.xx.xx

Order

string

任意

取得された SQL 文を並べ替えるフィールド順序。JSON 形式で指定します。値は入力配列の順序を保持した配列であり、Field および Type フィールドを含みます。例:[{"Field":"StartTime", "Type": "desc" }]。フィールドの説明:

  • Field:取得された SQL 文を並べ替えるために使用するフィールド。有効値:

    • StartTime:実行開始時刻。

    • Status:実行状態。

    • UserName:ユーザー名。

    • Cost:実行時間。

    • PeakMemory:ピークメモリ。

    • ScanSize:スキャン対象データ量。

    • Database:データベース名。

    • ClientIp:ソース IP アドレス。

    • ResourceGroup:リソースグループ名。

    • QueueTime:キュー待ち時間。

    • OutputRows:出力行数。

    • OutputDataSize:出力データ量。

    • ResourceCostRank:SQL 文で使用されるオペレーターの実行時間順位。このフィールドは、QueryCondition{"Type":"status","Value":"running"} に設定されている場合にのみ有効です。

  • Type:並べ替え順序。有効値(大文字小文字を区別しない):

    • Desc:降順。

    • Asc:昇順。

[{"Field":"StartTime", "Type": "desc" }]

PageNumber

integer

任意

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

1

PageSize

integer

任意

1 ページあたりの表示件数。有効値: 3050100。デフォルト値: 30。

30

Lang

string

任意

ファイルタイトルおよびエラーメッセージの言語。有効値:

  • zh(デフォルト):簡体字中国語。

  • en:英語。

  • ja:日本語。

  • zh-tw:繁体字中国語。

zh

PatternId

string

任意

SQL パターン ID。

説明

AnalyticDB for MySQL クラスター内の特定の時間範囲におけるすべての SQL パターン(SQL パターン ID を含む)の情報を照会するには、「DescribeSQLPatterns」操作を呼び出します。

5575924945138******

レスポンスフィールド

フィールド

説明

object

レスポンスパラメーター。

PageNumber

integer

ページ番号。

1

PageSize

integer

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

30

TotalCount

integer

返された合計件数。

1

Querys

array<object>

照会された SQL 文。

array<object>

照会された SQL 文。

SQL

string

SQL 文。

説明

パフォーマンス上の理由により、SQL 文の長さは 5,120 文字を超えることができません。超えた場合は、SQL 文が切り捨てられます。AnalyticDB for MySQL クラスター内で条件に合致する SQL 文の診断情報を(完全な SQL 文を含む)ダウンロードするには、「DownloadDiagnosisRecords」操作を呼び出します。

SELECT count(*)\nFROM nation

SQLTruncatedThreshold

integer

SQL 文の最大長。5120 が返されます。単位:文字。この制限を超える SQL 文は切り捨てられます。

5120

Status

string

SQL 文の状態。有効値:

  • running

  • finished

  • failed

finished

OutputDataSize

integer

返されたデータ量。単位:バイト。

9

Cost

integer

合計実行時間。単位:ミリ秒。

説明

この値は、QueuedTimeTotalPlanningTime、および ExecutionTime パラメーターの累積値です。

10

OutputRows

integer

返された行数。

1

RcHost

string

SQL 文が実行される AnalyticDB for MySQL フロントノードの IP アドレスおよびポート番号。

10.0.xx.xx:3004

ScanSize

integer

スキャンされたデータ量。単位:バイト。

9

ProcessId

string

クエリ ID。

2021093000414401000000023503151******

StartTime

integer

SQL 文の実行期間の開始時刻。1970 年 1 月 1 日 00:00:00 UTC を基準とした、経過ミリ秒数を表す UNIX タイムスタンプです。

1632933704000

SQLTruncated

boolean

SQL 文が切り捨てられたかどうかを示します。有効値:

  • true

  • false

false

Database

string

SQL 文が実行されるデータベース名。

adb_demo

ScanRows

integer

スキャンされたエントリ数。

1

ResourceCostRank

integer

SQL 文で使用されるオペレーターの実行時間順位。

説明

このフィールドは、Status パラメーターが running に設定されている SQL 文に対してのみ返されます。

1

ClientIp

string

ソース IP アドレス。

59.82.xx.xx

PeakMemory

integer

ピークメモリ。単位:バイト。

16648

QueueTime

integer

キュー待ち時間。単位:ミリ秒。

0

ResourceGroup

string

SQL 文が属するリソースグループ。

user_default

UserName

string

SQL 文を実行するユーザー名。

test_user

ExecutionTime

integer

実行時間。単位:ミリ秒。

6

TotalPlanningTime

integer

実行計画の生成に要した時間。単位:ミリ秒。

4

EtlWriteRows

integer

抽出・変換・書き出し (ETL) タスクによってテーブルに書き込まれた行数。

0

TotalStages

integer

生成されたステージの総数。

2

QueryProperties

array<object>

クエリプロパティ。

object

クエリプロパティ。

Name

string

クエリプロパティの名前。

ff

Value

string

クエリプロパティの値。

40

PatternId

string

SQL パターン ID。

説明

指定された時間範囲内における SQL パターンのパフォーマンスメトリックを照会するには、「DescribePatternPerformance」操作を呼び出します。

-5575924945138******

RequestId

string

リクエスト ID。

109462AF-B5FA-3D5A-9377-B27E5B******

成功レスポンス

JSONJSON

{
  "PageNumber": 1,
  "PageSize": 30,
  "TotalCount": 1,
  "Querys": [
    {
      "SQL": "SELECT count(*)\\nFROM nation",
      "SQLTruncatedThreshold": 5120,
      "Status": "finished",
      "OutputDataSize": 9,
      "Cost": 10,
      "OutputRows": 1,
      "RcHost": "10.0.xx.xx:3004",
      "ScanSize": 9,
      "ProcessId": "2021093000414401000000023503151******",
      "StartTime": 1632933704000,
      "SQLTruncated": false,
      "Database": "adb_demo",
      "ScanRows": 1,
      "ResourceCostRank": 1,
      "ClientIp": "59.82.xx.xx",
      "PeakMemory": 16648,
      "QueueTime": 0,
      "ResourceGroup": "user_default",
      "UserName": "test_user",
      "ExecutionTime": 6,
      "TotalPlanningTime": 4,
      "EtlWriteRows": 0,
      "TotalStages": 2,
      "QueryProperties": [
        {
          "Name": "ff",
          "Value": "40"
        }
      ],
      "PatternId": "-5575924945138******"
    }
  ],
  "RequestId": "109462AF-B5FA-3D5A-9377-B27E5B******"
}

エラーコード

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

変更履歴

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