ApsaraDB for Tair (Redis® OSS-Compatible) データベースインスタンスのパフォーマンスモニタリング情報を照会します。
操作説明
この API に対応するコンソール操作については、「パフォーマンスモニタリング」を参照してください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
kvstore:DescribeHistoryMonitorValues |
get |
*DBInstance
|
|
なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| InstanceId |
string |
必須 |
インスタンスの ID。 |
r-bp1zxszhcgatnx****** |
| StartTime |
string |
必須 |
履歴モニタリングデータのクエリの開始時刻。yyyy-MM-ddTHH:mm:ssZ フォーマット (協定世界時 (UTC)) で時間を指定します。 |
2022-11-06T00:00:00Z |
| EndTime |
string |
必須 |
履歴モニタリングデータのクエリの終了時刻。終了時刻は開始時刻より後である必要があります。yyyy-MM-ddTHH:mm:ssZ フォーマット (協定世界時 (UTC)) で時間を指定します。 説明
過去 1 か月分のモニタリングデータを照会でき、最大有効値は 7 日以内です。 |
2022-11-06T00:30:00Z |
| IntervalForHistory |
string |
必須 |
[非推奨] このパラメーターは非推奨であり、固定値 システムは開始時刻と終了時刻に基づいてクエリ間隔を自動的に決定します。たとえば、クエリの時間範囲が 10 分以下の場合、データ集約周波数は 5s となり、クエリ結果は 5s の頻度で返されます。 説明
|
01m |
| MonitorKeys |
string |
任意 |
監視メトリクス。複数の監視メトリクスを指定する場合は、カンマ (,) で区切ります。CpuUsage を例にとると以下のようになります。
その他の監視メトリクスおよび詳細な説明については、MonitorKeys パラメーターの説明を参照してください。 説明
|
CpuUsage |
| NodeId |
string |
任意 |
インスタンス内のノードの ID。特定のノードのモニタリング情報を照会するには、このパラメーターを指定します。 説明
|
r-bp1zxszhcgatnx****-db-0#1679**** |
| NodeRole |
string |
任意 |
クラウドネイティブ読み書き分離アーキテクチャインスタンスの読み取り専用ノードのメトリックをクエリするには、特定の NodeId を指定し、このパラメーターを READONLY にセットします。 説明
それ以外の場合は、このパラメーターを指定する必要はありません (または MASTER を指定します)。 |
READONLY |
| Type |
string |
任意 |
MonitorKeys パラメーターの説明
OpenAPI を呼び出す際は、下表の MonitorKeys 列のパラメーターを指定します。システムはサブメトリックを返します。インスタンスは一般監視メトリクスおよびコマンド統計監視メトリクスをサポートしています。
一般的な監視メトリクス
以下に、一般的な監視メトリクスの使用方法について説明します。CpuUsage を例として使用します。
-
クラスターアーキテクチャまたは読み書き分離アーキテクチャ:
すべてのデータノード (DB) の全体的な CPU 使用率を照会するには、CpuUsage$db を指定します。
すべての Proxy ノードの全体的な CPU 使用率を照会するには、CpuUsage$proxy を指定します。
単一のデータノードまたは Proxy ノードの CPU 使用率を照会するには、CpuUsage を指定し、NodeId パラメーターを DB ノードまたは Proxy ノードに設定します。
-
標準アーキテクチャ (プライマリ/セカンダリ): CpuUsage を指定します。
MonitorKeys | サブメトリック | 単位 | 説明 | サポートされるスコープ |
CpuUsage | CpuUsage | % | CPU 使用率。有効値: 0〜100。 説明 インスタンスが以前に RedisCpuUsage パラメーターを使用していたか、または返していた場合は、引き続き元のパラメーターを使用できます。 |
|
MemoryUsage | memoryUsage | % | メモリ使用率。 |
|
quotaMemory | quotaMemory | バイト | 現在のシャードの合計メモリ。 |
|
UsedMemory | UsedMemory | バイト | データとキャッシュを含む使用済みメモリ。 |
|
Tair_PmemUsage | PmemUsage | % | 永続メモリ使用率、使用済み永続メモリ、および合計永続メモリ。 このメトリックは、永続メモリ最適化インスタンスでのみサポートされています。 |
|
Tair_Pmem | PmemUsed | バイト | ||
PmemQuota | バイト | |||
Redis_DetailedSpaceUsage | ins_size | MB | インスタンスの合計ストレージ容量、データファイル (AOF および RDB ファイルを含む) が使用するディスク容量、およびログファイル (操作ログを含む) が使用するディスク容量。 このメトリックは、クラシックデプロイモード (旧ローカルディスク) のメモリ最適化インスタンスでのみサポートされています。 |
|
data_size | MB | |||
log_size | MB | |||
Redis_Memory_Monitor | used_memory_rss | バイト | プロセスが占有する物理メモリ。これは、オペレーティングシステムによって Tair サービスに割り当てられたメモリです。 |
|
used_memory_lua | バイト | Lua スクリプトによって使用されるメモリ。 | ||
used_memory_startup | バイト | Tair の起動時に消費されるメモリ。 | ||
lazyfree_pending_objects | 個数 | Tair の遅延解放操作中に、実際のメモリ回収を待機しているキーの数。 | ||
used_memory_overhead | バイト | データセットの内部メカニズムを維持するために Tair に必要なメモリオーバーヘッド。これには、すべてのクライアントの出力バッファー、クエリバッファー、および AOF が含まれます。 | ||
used_memory_dataset | バイト | データが占有するメモリ領域。 | ||
CustomerMemoryUsage | CustomerMemoryUsage | % | ユーザーメモリ使用率。有効値: 0〜100。 |
|
UsedQPS | TotalQps | 回/秒 | 読み取りコマンドと書き込みコマンドを含む、1 秒あたりの合計リクエスト数。 |
|
GetQps | 回/秒 | それぞれ 1 秒あたりの読み取りコマンドおよび書き込みコマンドのリクエスト数。インスタンスの互換バージョンは Redis 4.0 以降である必要があります。 | ||
PutQps | 回/秒 | |||
OtherOps | 回/秒 | PING、INFO、SELECT、AUTH など、読み取りまたは書き込み属性を持たないリクエスト。Proxy はリクエストに対して特別な処理を実行するため、インスタンスに Proxy ノードがある場合、OtherOps には一部の INFO リクエストのみが含まれます。 | ||
ConnectionUsage | connectionUsage | % | 接続使用率。計算方法: 使用中の接続数 ÷ インスタンスでサポートされている接続の総数。このメトリックは、クライアントがダイレクト接続アドレスを介して Tair インスタンス (クラスターアーキテクチャ) に接続する場合に役立ちます。 |
|
UsedConnection | ConnCount | 個数 | 使用中の接続数。 | |
IntranetIn | InFlow | KB/s | インバウンドおよびアウトバウンドトラフィックレート。 |
|
IntranetOut | OutFlow | KB/s | ||
IntranetInRatio | intranetInRatio | % | インバウンドおよびアウトバウンドトラフィック使用率。 |
|
IntranetOutRatio | intranetOutRatio | % | ||
Redis_Avg_Rt_Monitor | AvgRt | us | 平均レイテンシ。バックエンドノードがコマンドを受信してからレスポンスを送信するまでの平均時間を示します。
|
|
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| MonitorHistory |
string |
JSON フォーマットで返されるモニタリング情報。詳細については、「モニタリングパラメーターの説明」を参照してください。 説明
データ転送効率を向上させるため、ゼロ以外のモニタリングデータのみが返されます。表示されていない他のすべてのモニタリングデータのデフォルト値は 0 です。 |
"{\"2022-11-06T00:00:00Z\":{\"memoryUsage\":\"6.67\"},\"2022-11-06T00:00:05Z\":{\"memoryUsage\":\"6.67\"},\"2022-11-06T00:00:10Z\":{\"memoryUsage\":\"6.67\"},\"2022-11-06T00:00:15Z\":{\"memoryUsage\":\"6.67\"},\"2022-11-06T00:00:20Z\":{\"memoryUsage\":\"6.67\"},\"2022-11-06T00:00:25Z\":{\"memoryUsage\":\"6.67\"}}" |
| RequestId |
string |
リクエスト ID。 |
F0997EE8-F4C2-4503-9168-85177ED7**** |
| MonitorLegend |
string |
例
成功レスポンス
JSONJSON
{
"MonitorHistory": "\"{\\\"2022-11-06T00:00:00Z\\\":{\\\"memoryUsage\\\":\\\"6.67\\\"},\\\"2022-11-06T00:00:05Z\\\":{\\\"memoryUsage\\\":\\\"6.67\\\"},\\\"2022-11-06T00:00:10Z\\\":{\\\"memoryUsage\\\":\\\"6.67\\\"},\\\"2022-11-06T00:00:15Z\\\":{\\\"memoryUsage\\\":\\\"6.67\\\"},\\\"2022-11-06T00:00:20Z\\\":{\\\"memoryUsage\\\":\\\"6.67\\\"},\\\"2022-11-06T00:00:25Z\\\":{\\\"memoryUsage\\\":\\\"6.67\\\"}}\"",
"RequestId": "F0997EE8-F4C2-4503-9168-85177ED7****",
"MonitorLegend": ""
}エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidStartTime.Malformed | The Specified parameter "StartTime" is not valid. | |
| 400 | InvalidEndTime.Malformed | The Specified parameter "EndTime" is not valid. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。