この API を呼び出して、ApsaraDB for POLARDB クラスターのスロークエリに関するログ統計を照会できます。

この API を呼び出す場合、指定したクラスターのデータベースエンジンが MySQL 5.6 または 8.0 であることを確認してください。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、各種 SDK 用のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須／任意 例 説明
Action String 任意 DescribeSlowLogs

実行する API ( DescribeSlowLogs) を設定します。

DBClusterId String 必須 pc-bp1w2u4xxxxxxxxxx

照会する ApsaraDB for POLARDB クラスターの ID を設定します。
RegionId String 必須 cn-hangzhou

照会する ApsaraDB for POLARDB クラスターのリージョン ID を設定します。

注 DescribeRegions を呼び出すと、最新のリージョンリストを照会できます。
StartTime String 必須 2019-11-18Z

照会する期間の開始時刻を設定します。 yyyy-MM-ddZ の形で時刻を指定します。

EndTime String 必須 2019-12-18Z

照会する期間の終了時刻を設定します。 終了時刻は開始時刻よりも後の時刻とする必要があります。 指定できる期間は最大で 31 日です。 yyyy-MM-ddZ の形で時刻を指定します。

AccessKeyId String 任意 LTAIfCxxxxxxxxxx

Alibaba Cloud から提供された AccessKey ID を設定します。
DBName String 任意 testdb

データベースの名前 を設定します。
PageSize Integer 任意 30

返される各ページのエントリ数 を設定します。 設定可能な値は以下のとおりです。

  • 30
  • 50
  • 100

デフォルト値は、30 です。

PageNumber Integer 任意 1

返されるページの番号を設定します。 ページは 1 ページ目から始まります。

デフォルト値は、1 です。

レスポンスパラメーター

パラメーター データ型 例 説明
RequestId String A95EC729-3644-4C05-BA29-55CBF1A4504C

リクエストの ID を示します。
DBClusterId String pc-bp1w2u4xxxxxxxxxx

クラスターの ID を示します。
StartTime String 2019-11-18Z

データが照会された期間の開始時刻を示します。
EndTime String 2019-12-18Z

データが照会された期間の終了時刻を示します。
Engine String polardb_mysql

データベースエンジンを示します。
TotalRecordCount Integer 1

照会されたスロークエリの合計数を示します。
PageNumber Integer 1

返されたページのページ番号を示します。
PageRecordCount Integer 1

現在のページのスロークエリの数を示します。
Items Array

スロークエリに関するログ情報を示します。
DBNodeId String pi-bp13oz7xxxxxxxxxx

ノードの ID を示します。
ParseMaxRowCount Long 0

SQL クエリが解析した最大の行数を示します。
TotalLockTimes Long 0

SQL 文の合計ロック時間を示します。 単位: 秒。
DBName String testdb

データベースの名前を示します。
MaxExecutionTime Long 10597

SQL 文の最大実行時間を示します。 単位: 秒。
SQLHASH String 50e94bcxxxxxxxxxxxxxxxx

スロークエリログ統計で SQL 文を識別する ID を示します。 SQL 文のスロークエリログ詳細の照会に使用できます。
SQLText String binlog dump

ログに記録された SQL 文を示します。
CreateTime String 2019-11-27Z

ログが生成された時刻を示します。
TotalExecutionTimes Long 10597

SQL 文の合計実行時間を示します。 単位は秒です。
ReturnTotalRowCounts Long 0

SQL クエリによって返された行数の合計を示します。
TotalExecutionCounts Long 1

SQL 文の合計実行回数を示します。
MaxLockTime Long 0

SQL 文の最大ロック時間を示します。 単位は秒です。
ReturnMaxRowCount Long 0

SQL クエリによって返された最大行数を示します。
ParseTotalRowCounts Long 0

SQL クエリによって解析された行数の合計を示します。

コーディング例

リクエストの例

http(s)://polardb.aliyuncs.com/? Action=DescribeSlowLogs
&DBClusterId=pc-bp1w2u4xxxxxxxxxx
&RegionId=cn-hangzhou
&StartTime=2019-11-18Z
&EndTime=2019-12-18Z
&<共通リクエストパラメーター>

正常なレスポンスの例

JSON 形式 

{
    "Items": {
        "SQLSlowLog": [
            {
                "ParseMaxRowCount": 0,
                "TotalExecutionTimes": 10597,
                "TotalExecutionCounts": 1,
                "SQLText": "binlog dump",
                "MaxLockTime": 0,
                "ReturnTotalRowCounts": 0,
                "TotalLockTimes": 0,
                "MaxExecutionTime": 10597,
                "CreateTime": "2019-11-27Z",
                "ParseTotalRowCounts": 0,
                "DBName": "",
                "SQLHASH": "50e94bcxxxxxxxxxxxxxxxx",
                "ReturnMaxRowCount": 0,
                "DBNodeId": "pi-bp13oz7xxxxxxxxxx"
            }
        ]
    },
    "TotalRecordCount": 1,
    "PageNumber": 1,
    "RequestId": "A95EC729-3644-4C05-BA29-55CBF1A4504C",
    "EndTime": "2019-12-18Z",
    "StartTime": "2019-11-18Z",
    "DBClusterId": "pc-bp1w2u4xxxxxxxxxx",
    "Engine": "polardb_mysql",
    "PageRecordCount": 1
}

XML 形式 

<Items>
    <SQLSlowLog>
        <ParseMaxRowCount>0</ParseMaxRowCount>
        <TotalExecutionTimes>10597</TotalExecutionTimes>
        <TotalExecutionCounts>1</TotalExecutionCounts>
        <SQLText>binlog dump</SQLText>
        <MaxLockTime>0</MaxLockTime>
        <ReturnTotalRowCounts>0</ReturnTotalRowCounts>
        <TotalLockTimes>0</TotalLockTimes>
        <MaxExecutionTime>10597</MaxExecutionTime>
        <CreateTime>2019-11-27Z</CreateTime>
        <ParseTotalRowCounts>0</ParseTotalRowCounts>
        <DBName/>
        <SQLHASH>50e94bcxxxxxxxxxxxxxxxx</SQLHASH>
        <ReturnMaxRowCount>0</ReturnMaxRowCount>
        <DBNodeId>pi-bp13oz7xxxxxxxxxx</DBNodeId>
    </SQLSlowLog>
</Items>
<TotalRecordCount>1</TotalRecordCount>
<PageNumber>1</PageNumber>
<RequestId>A95EC729-3644-4C05-BA29-55CBF1A4504C</RequestId>
<EndTime>2019-12-18Z</EndTime>
<StartTime>2019-11-18Z</StartTime>
<DBClusterId>pc-bp1w2u4xxxxxxxxxx</DBClusterId>
<Engine>polardb_mysql</Engine>
<PageRecordCount>1</PageRecordCount>

エラーコード

エラーコードについては、「API エラーセンター」をご参照ください。