Database Autonomy Service:DescribeSqlInsightStatistic

予約済みパラメーター。

データベースインスタンスの ID。

この操作は、SQL Explorer が有効になっている RDS for MySQL、PolarDB for MySQL、PolarDB-X、RDS for PostgreSQL、PolarDB for PostgreSQL、RDS for SQL Server、および Lindorm インスタンスをサポートしています。MongoDB および Redis インスタンスはサポートされていません。サポートされていないインスタンスに対してこの操作を呼び出すと、操作がサポートされていないことを示すエラーが返されます。

インスタンスのノード ID。このパラメーターは、統計の範囲を指定されたノードに絞り込みます。単一のノード ID のみがサポートされています。コンマ区切りで複数のノード ID を指定することはできません。

このパラメーターは、PolarDB-X や Lindorm インスタンスなど、複数のノードで構成されるインスタンスに対してのみ必須です。シングルノードインスタンスの場合は、このパラメーターを無視できます。

統計の集約またはフィルターディメンション。値は大文字と小文字が区別されません。このパラメーターが指定されていない場合、統計はデフォルトで SQL テンプレートごとに集約されます。有効な値:

• FullRequestOrigin: アクセスソースアドレスごとに集約します。

• FullRequestUser: データベースユーザーごとに集約します。

• SQL: SQL テンプレートでフィルター処理します。TemplateId を SQL テンプレート ID として指定する必要もあります。

• OriginHost: アクセスソースでフィルター処理します。TemplateId をソースアドレスとして指定する必要もあります。

• User: データベースユーザーでフィルター処理します。TemplateId をユーザー名として指定する必要もあります。

前述の値以外の値を指定すると、InvalidParams エラーが返されます。

統計オブジェクトの識別子。意味は Type の値によって異なります。有効な値:

• Type が SQL にセットされている場合: SQL テンプレート ID。応答の SqlId に対応します。

• Type が OriginHost にセットされている場合: アクセスソースアドレス。

• Type が User にセットされている場合: データベースのユーザー名。

このパラメーターは、Type が指定されていない場合、または FullRequestOrigin や FullRequestUser にセットされている場合は効果がありません。

Type が SQL にセットされている場合、コンマ区切りで複数のテンプレート ID を指定できます。この場合、Keyword パラメーターは効果がありません。

SQL テンプレートの内容に対するあいまい取得のキーワード。複数のキーワードはスペースで区切ります。システムは最初にキーワード一致を実行して対応する SQL テンプレート (最大 1,000 個のテンプレート) を検索し、次にこれらのテンプレートに基づいて集約統計を実行します。一致するテンプレートがない場合、空のリストが返されます。

このパラメーターは、Type が SQL にセットされており、TemplateId が指定されている場合は効果がありません。

クエリの開始時刻。ミリ秒単位の UNIX タイムスタンプを指定します。システムは最も近い分へと切り捨てます。

値は過去 30 日以内である必要があります。値がインスタンスで SQL Explorer が有効になった時間より前の場合、SQL Explorer が有効になった時間に自動的に調整されます。

クエリの終了時刻。ミリ秒単位の UNIX タイムスタンプを指定します。システムは最も近い分へと切り上げます。

この値と StartTime のスパンは 7 日を超えることはできません。EndTime がインスタンスで SQL Explorer が有効になった時間より前の場合、クエリ時間が使用可能な時間より前であることを示すエラーが返されます。

データの集約には遅延が伴うため、実際の効果値は現在時間の数分前に調整されます。直近数分間のデータは利用できない場合があります。

ソートに使用されるフィールド。このパラメーターが指定されていないか、サポートされていない値が指定されている場合、結果は rt (合計応答時間) でソートされます。有効な値:

• 応答時間: rt、avgRt、maxRt、minRt、rtRate。

• 実行回数: count、countRate、timestamp。

• スキャン行数: rowsExamined、avgRowsExamined。

• 返された行数: rowsReturned、totalRowsReturned、avgRowsReturned、maxRowsReturned、minRowsReturned、maxRowReturned、minRowReturned。

• 論理読み取り: logicalRead、totalLogicalRead、avgLogicalRead、maxLogicalRead、minLogicalRead。

• 物理読み取り: physicalRead、totalPhysicalRead、avgPhysicalRead、maxPhysicalRead、minPhysicalRead。

• 論理書き込み (SQL Server インスタンスに対してのみ有効): writes、totalWrites、avgWrites、maxWrites、minWrites。

• CPU 時間 (SQL Server インスタンスに対してのみ有効): totalCpuTime、avgCpuTime、maxCpuTime、minCpuTime。

• PolarDB-X コンピューティングノードメトリック (Role が polarx_cn にセットされている場合にのみ有効): scnt、avgScnt、rows、avgRows、frows、avgFrows。

• 影響を受けた行数 (Lindorm インスタンスに対してのみ有効): totalAffectRows、avgAffectRows。

timestamp はデータタイムスタンプでソートします。これはミリ秒レベルの UNIX タイムスタンプです。

大文字と小文字が区別されないのは最初の文字のみです。残りの文字は前述の値と完全に一致する必要があります。たとえば、AvgRt は有効ですが、avgrt は無効です。

ソート方向。デフォルト値: false (降順)。有効な値:

• true: 昇順。

• false: 降順。

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

ページあたりの統計エントリ数。デフォルト値: 10。有効な最大値: 2000。

2000 を超える値を指定すると、値が調整される代わりに InvalidParams エラーが返されます。

アクセスソースまたはデータベースユーザーごとに集約する場合 (Type が FullRequestOrigin または FullRequestUser にセットされている場合)、特定の有効な集約ストレージパイプラインでは、100 を超える値が 10 にリセットされる場合があります。

各統計エントリの時系列トレンドデータを生成するかどうかを指定します。これは応答の Trend フィールドに対応します。デフォルト値: true。有効な値:

• true: トレンドデータを生成します。

• false: トレンドデータを生成しません。

このオプションを有効にすると、エントリごとの各タイムスライスに対して追加のクエリがトリガーされ、クエリのオーバーヘッドが大幅に増加します。インスタンスでトレンド補完機能が有効になっていない場合、このパラメーターは効果がありません。

フィルター処理に使用される SQL タイプ。有効な値:

• select

• insert (挿入)

• update

• delete

値は小文字です。特定の集約ストレージパイプラインでは、コンマ区切りで複数の値を指定できます。他のパイプラインでは、単一の値のみがサポートされています。

フィルター処理に使用されるデータベース名。

特定の集約ストレージパイプラインでは、コンマ区切りで複数のデータベース名を指定できます。他のパイプラインでは、単一のデータベース名のみがサポートされています。

インスタンスノードのロール。値は大文字と小文字が区別されません。このパラメーターが指定されていない場合、ロールは InstanceId の呼び出しから自動的に解決されます。有効な値:

• polarx_cn: PolarDB-X コンピューティングノード。

• polarx_dn: PolarDB-X ストレージノード。

この値は、返されるフィールドの範囲に影響します。たとえば、Scnt、Rows、Frows は、値が polarx_cn の場合にのみ返されます。

SQL Explorer データクエリの冪等性 ID。このパラメーターは、通常のクエリでは必須ではありません。