DescribeSlowLogTrend API による ClickHouse スロークエリ診断 - ApsaraDB for ClickHouse - Alibaba Cloud - ApsaraDB for ClickHouse

クラスターのスローログトレンドに関する統計情報を照会します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

clickhouse:DescribeSlowLogTrend

get

*DBCluster

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	リージョン ID。 DescribeRegions 操作を呼び出してリージョン ID をクエリできます。	cn-hangzhou
DBClusterId	string	必須	クラスター ID。 DescribeDBClusters 操作を呼び出して、特定のリージョン内のすべてのクラスターの情報（クラスター ID を含む）をクエリできます。	cc-bp11xxl475ui8****
StartTime	string	必須	クエリする時間範囲の開始時刻。`yyyy-MM-dd hh:mm:ss` フォーマットで指定します。時間は協定世界時 (UTC) です。	2022-05-20 16:00:00
EndTime	string	必須	クエリする時間範囲の終了時刻。`yyyy-MM-dd hh:mm:ss` フォーマットで指定します。時間は協定世界時 (UTC) です。説明終了時刻は開始時刻より後である必要があります。時間範囲は 7 日間を超えることはできません。	2022-05-27 16:00:00
QueryDurationMs	integer	任意	スロー SQL クエリの実行時間（ミリ秒単位）。最小値は 1000 です。デフォルト値は 1000 です。この操作は、この持続時間を超えて実行するスロー SQL クエリを返します。	1000

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	The request ID.	7D3ECB0E-98CA-5E08-A9CA-F70C5A1E9BDF
SlowLogTrend	object	The result set of the slow SQL queries.
TableSchema	object
ResultSet	array<object>
	object
Type	string		UInt64
Name	string		query_start_time
Data	object
ResultSet	array<object>
	object
QueryStartTime	string		2022-05-22 20:00:01
MaxQueryDurationMs	string		3000
MinQueryDurationMs	string		1000
Count	string		4000
AvgQueryDurationMs	string		2000
Rows	string	The number of rows in the result set.	1
RowsBeforeLimitAtLeast	string	The minimum number of rows that are returned before the `LIMIT` clause is applied.	1
Statistics	object	The statistics of the query results.
RowsRead	integer		14721
ElapsedTime	number		0.001703578
BytesRead	integer		697899

例

成功レスポンス

JSONJSON

{
  "RequestId": "7D3ECB0E-98CA-5E08-A9CA-F70C5A1E9BDF",
  "SlowLogTrend": {
    "TableSchema": {
      "ResultSet": [
        {
          "Type": "UInt64",
          "Name": "query_start_time"
        }
      ]
    },
    "Data": {
      "ResultSet": [
        {
          "QueryStartTime": "2022-05-22 20:00:01",
          "MaxQueryDurationMs": "3000",
          "MinQueryDurationMs": "1000",
          "Count": "4000",
          "AvgQueryDurationMs": "2000"
        }
      ]
    },
    "Rows": "1",
    "RowsBeforeLimitAtLeast": "1",
    "Statistics": {
      "RowsRead": 14721,
      "ElapsedTime": 0.001703578,
      "BytesRead": 697899
    }
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
500	InternalError	An error occurred while processing your request.	An error occurred while processing your request.
503	ServiceUnavailable	An error occurred while processing your request.	An error occurred while processing your request.

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

変更履歴

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