DescribeHistoryMonitorValues - Tair (Redis® OSS-Compatible) - Alibaba Cloud ドキュメントセンター

操作説明

コンソールでの同等の操作は、パフォーマンスモニタリングをご参照ください。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

kvstore:DescribeHistoryMonitorValues

get

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

kvstore:ResourceTag
kvstore:ResourceTag
kvstore:ResourceTag
kvstore:ResourceTag

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
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	必須	このパラメーターは非推奨で、値は `01m` に固定されています。システムは、指定された開始時刻と終了時刻に基づいて、クエリ間隔を自動的に決定します。たとえば、指定した時間範囲が 10 分以下の場合、データは 5 秒ごとに集約され、クエリ結果は 5 秒間隔で返されます。説明指定した `StartTime` がデータ集約ポイントでない場合、システムが返す最初の時刻ポイントは、直前の最も近いデータ集約ポイントになります。たとえば、`StartTime` を `2022-01-20T12:01:48Z` に設定すると、最初に返される時刻ポイントは `2022-01-20T12:01:45Z` になります。インスタンスに 32 以上のデータシャードがある場合、最小のデータ集約頻度は 1 分です。	01m
MonitorKeys	string	任意	クエリする監視メトリクス (`CpuUsage` など)。複数のメトリクスを指定する場合は、カンマ (,) で区切ります。クラスターアーキテクチャまたは読み書き分離アーキテクチャを使用するインスタンスの場合：すべてのデータノードの全体的な CPU 使用率をクエリするには、このパラメーターを CpuUsage$db に設定します。単一のデータノードの CPU 使用率をクエリするには、このパラメーターを CpuUsage に設定し、`NodeId` パラメーターでノードを指定します。標準アーキテクチャ (プライマリ/スタンバイ) を使用するインスタンスの場合は、このパラメーターを CpuUsage に設定します。監視メトリクスの詳細については、以下の MonitorKeys パラメーターの追加情報をご参照ください。説明このパラメーターを指定しない場合、`UsedMemory` メトリクスと `quotaMemory` メトリクスがデフォルトで返されます。クエリ効率を確保するため、単一ノードに対して指定する監視メトリクスは最大 5 個、1 回のクエリで指定する集約監視メトリクスは最大 1 個にすることを推奨します。	CpuUsage
NodeId	string	任意	インスタンス内のノードの ID。このパラメーターを使用して、特定のノードのモニタリングデータをクエリできます。説明このパラメーターは、読み書き分離アーキテクチャまたはクラスターアーキテクチャを使用するインスタンスでのみ使用できます。ノード ID をクエリするには、DescribeLogicInstanceTopology API を呼び出します。	r-bp1zxszhcgatnx**-db-0#1679**
NodeRole	string	任意	読み書き分離アーキテクチャを使用するクラウドネイティブインスタンスで読み取り専用ノードのメトリクスをクエリする場合は、NodeId を指定し、このパラメーターを READONLY に設定する必要があります。説明それ以外の場合、このパラメーターを指定する必要はありません。MASTER に設定することもできます。	READONLY
Type	string	任意

MonitorKeys パラメーター

API を呼び出す際、以下の表の MonitorKeys 列からパラメーターを渡します。API は対応するサブメトリクスを返します。インスタンスは、汎用メトリクスとコマンド統計メトリクスの両方をサポートしています。

汎用メトリクス

このセクションでは、CpuUsage を例に、汎用メトリクスの使用方法を説明します。

クラスターまたは読み書き分離アーキテクチャを使用するインスタンスの場合：
- すべてのデータノード (DB) の全体の CPU 使用率をクエリするには、CpuUsage$db を渡します。
- すべてのプロキシノードの全体の CPU 使用率をクエリするには、CpuUsage$proxy を渡します。
- 単一のデータノードまたはプロキシノードの CPU 使用率をクエリするには、CpuUsage を渡し、NodeId パラメーターをデータノードまたはプロキシノードの ID に設定します。
標準アーキテクチャ (プライマリ/スタンバイ) を使用するインスタンスの場合は、CpuUsage を渡します。

MonitorKeys	サブメトリクス	単位	説明	サポート範囲
CpuUsage	CpuUsage	%	CPU 使用率です。値の範囲は 0～100 です。説明インスタンスで以前に `RedisCpuUsage` パラメーターを使用していた場合は、引き続き使用できます。	DB DB 集計プロキシプロキシ集計
MemoryUsage	memoryUsage	%	メモリ使用率です。	DB DB 集計
quotaMemory	quotaMemory	バイト	現在のシャードの合計メモリです。	DB DB 集計
UsedMemory	UsedMemory	バイト	データとキャッシュを含む、使用済みメモリです。	DB DB 集計
Tair_PmemUsage	PmemUsage	%	これらのメトリクスは、それぞれ永続メモリ使用率、使用済み永続メモリ、および合計永続メモリを表します。永続メモリインスタンスでのみサポートされています。	DB DB 集計
Tair_Pmem	PmemUsed	バイト
Tair_Pmem	PmemQuota	バイト
Redis_DetailedSpaceUsage	ins_size	MB	これらのメトリクスは、それぞれインスタンスが占有する合計ディスク容量、データファイル (AOF および RDB ファイルを含む) が占有するディスク容量、およびログファイル (ランタイムログを含む) が占有するディスク容量を表します。クラシックデプロイモード (ローカルディスク) を使用するメモリ最適化インスタンスでのみサポートされています。	DB DB 集計
	data_size	MB
	log_size	MB
Redis_Memory_Monitor	used_memory_rss	バイト	オペレーティングシステムが Tair プロセスに割り当てる物理メモリです。	DB
	used_memory_lua	バイト	Lua スクリプトが使用するメモリ量です。
	used_memory_startup	バイト	Tair の起動時に消費されるメモリです。
	lazyfree_pending_objects	カウント	Tair がレイジーフリー操作を実行する際に解放を待機しているキーの数です。
	used_memory_overhead	バイト	Tair が内部データ構造を維持するために必要なメモリオーバーヘッドです。これには、すべてのクライアントの出力バッファ、クエリバッファ、および AOF が含まれます。
	used_memory_dataset	バイト	データが占有するメモリ容量です。
CustomerMemoryUsage	CustomerMemoryUsage	%	ユーザーメモリ使用率です。値の範囲は 0～100 です。	DB DB 集計
UsedQPS	TotalQps	カウント/秒	読み取りコマンドと書き込みコマンドを含む、1 秒あたりの合計リクエスト数です。	DB DB 集計プロキシプロキシ集計
	GetQps	カウント/秒	それぞれ、1 秒あたりの読み取りリクエスト数と書き込みリクエスト数です。インスタンスが Redis 4.0 以降に対応している必要があります。
	PutQps	カウント/秒
	OtherOps	カウント/秒	`PING`、`INFO`、`SELECT`、`AUTH` など、読み取りまたは書き込み属性を持たないリクエストの数です。プロキシノードはリクエストを特別に処理するため、インスタンスにプロキシノードがある場合、このメトリクスには一部の `INFO` リクエストのみが含まれます。
ConnectionUsage	connectionUsage	%	接続使用率は、次の式を使用して計算されます：確立された接続数 ÷ インスタンスでサポートされている総接続数。このメトリックは、クライアントが直接接続アドレスを使用してTair インスタンス (クラスターアーキテクチャ) に接続する際の参考として役立ちます。	DB DB 集計
UsedConnection	ConnCount	カウント	使用中の接続数です。	DB DB 集計
IntranetIn	InFlow	KB/秒	インバウンドおよびアウトバウンドトラフィックのレートです。	DB DB 集計プロキシプロキシ集計
IntranetOut	OutFlow	KB/秒	インバウンドおよびアウトバウンドトラフィックのレートです。	DB DB 集計プロキシプロキシ集計
IntranetInRatio	intranetInRatio	%	インバウンドおよびアウトバウンドトラフィック帯域幅の使用率です。	DB DB 集計
IntranetOutRatio	intranetOutRatio	%	インバウンドおよびアウトバウンドトラフィック帯域幅の使用率です。	DB DB 集計
Redis_Avg_Rt_Monitor	AvgRt	us	平均レイテンシー。バックエンドノードがコマンドを受信してから応答するまでにかかる平均時間です。データノードの場合、このメトリクスにはプロキシノードと負荷分散のレイテンシーは含まれません。プロキシノードの場合、このメトリクスにはデータノードとプロキシノードのレイテンシーが含まれますが、負荷分散のレイテンシーは含まれません。	DB DB 集計プロキシプロキシ集計
Redis_Max_Rt_Monitor	MaxRt	us	最大レイテンシー。ノードがコマンドを受信してから応答するまでにかかる最大時間です。データノードの場合、このメトリクスにはプロキシノードと負荷分散のレイテンシーは含まれません。プロキシノードの場合、このメトリクスにはデータノードとプロキシノードのレイテンシーが含まれますが、負荷分散のレイテンシーは含まれません。	DB DB 集計プロキシプロキシ集計
Redis_Basic_Monitor	Keys	カウント	インスタンスに保存されているトップレベルキーの総数です。	DB DB 集計
	Expires	カウント	有効期限が設定されているキーの数です。これは収集時に測定された瞬時値です。
	ExpiredKeys	カウント	期限切れキーの累計数です。
	EvictedKeys	カウント	エビクションされたキーの累計数です。
	ExpiredKeysPerSecond	カウント/秒	1 秒あたりに期限切れになるキーの数です。
	EvictedKeysPerSecond	カウント/秒	1 秒あたりにエビクションされるキーの数です。
	inmem_keys	カウント	これらのメトリクスは、ハイブリッドストレージインスタンス (廃止) でのみサポートされており、無視できます。
	swapped_keys	カウント	これらのメトリクスは、ハイブリッドストレージインスタンス (廃止) でのみサポートされており、無視できます。
Hit_Rate_Monitor	hit_rate	%	キー検索の成功率です。計算式：キーヒット数 ÷ (キーヒット数 + キーミス数)。	DB DB 集計
	hit	カウント/秒	1 秒あたりのキーヒット数です。
	miss	カウント/秒	1 秒あたりのキーミス数です。
	evicted_keys_per_sec	Counts/s	The number of keys evicted per second.
DiskUsage	disk_usage	%	これらのメトリクスは、ディスク使用率、入力バッファサイズ、出力バッファサイズ、およびディスクパフォーマンスを表します。ディスクベースのインスタンスでのみサポートされています。	DB
Tair_Connection_Monitor	UsedInputBuffer	バイト
Tair_Connection_Monitor	UsedOutputBuffer	バイト
Tair_Disk_Monitor	`io_bandwidth_kbps`、`iops`、`iops_usage` など。	%、ms、カウントなど。
UsedConnection	ConnectionUsage	%	接続使用率は、「使用中の接続数 ÷ ノードでサポートされる最大接続数」として計算されます。このメトリックは、クライアントがプロキシノードを介してTair インスタンス (クラスターまたは読み取り/書き込み分離アーキテクチャ) に接続する場合に有用な参考情報となります。	プロキシプロキシ集計
	ConnCount	カウント	使用中の接続数です。
	NewUserConnQps	カウント/秒	クライアントからプロキシノードへの、1 秒あたりの接続確立数です。
Redis_Package_Monitor	request	バイト	単一リクエストの平均サイズです (バイト単位)。	プロキシ
	response	バイト	単一レスポンスの平均サイズです (バイト単位)。
	request_max	バイト	単一リクエストの最大サイズです (バイト単位)。
	response_max	バイト	単一レスポンスの最大サイズです (バイト単位)。
RedisProxyConn	RedisUsedConnection	カウント	プロキシノードからデータノードへの接続数です。
	NewDBConnQps	カウント/秒	プロキシノードからデータノードへの、1 秒あたりの接続確立数です。
	DisconnectDBConn	カウント	プロキシノードからデータノードへの切断の累計数です。
	DisconnectUserConn	カウント	クライアントからプロキシノードへの切断の累計数です。
TotalCalls	TotalRefusedCommands	カウント	拒否されたコマンドの累計数です。
	TotalCallsPerSecCalls	カウント/秒	プロキシが 1 秒あたりに処理するコマンドの総数です。
	TotalCallsPerSecRetryCalls	カウント/秒	1 秒あたりの再試行リクエスト数です。
	TotalCallsPerSecRetryFailed	カウント/秒	1 秒あたりの失敗したリクエスト数です。

コマンド統計メトリクス

コマンド統計メトリクスは、特定のデータノードについてのみクエリできます。これらのメトリクスをクエリするには、対応する MonitorKeys パラメーターを渡し、NodeId パラメーターでデータノードを指定します。

説明

Tair 拡張コマンドモニタリンググループは、クラシックデプロイモード (ローカルディスク) を使用するメモリ最適化インスタンスでのみサポートされています。

MonitorKeys	サブメトリック	単位	説明
Redis_Keys_Monitor	del, dump, exists, expire, expireat, move, persist, pexpire, pexpireat, pttl, randomkey, rename, renamenx, restore, sort, ttl, type, scan	カウント/秒	DEL や EXISTS などのキー関連コマンドの 1 秒あたりの呼び出し数。
Redis_String_Monitor	append, bitcount, bitop, decr, decrby, get, getbit, getrange, getset, incr, incrby, incrbyfloat, mget, mset, msetnx, psetex, set, setbit, setex, setnx, setrange, strlen	カウント/秒	APPEND や MGET などの文字列関連コマンドの 1 秒あたりの呼び出し数。
Redis_Hashes_Monitor	hdel, hexists, hget, hgetall, hincrby, hincrbyfloat, hkeys, hlen, hmget, hmset, hset, hsetnx, hvals, hscan	カウント/秒	HGET や HDEL などのハッシュ関連コマンドの 1 秒あたりの呼び出し数。
Redis_Lists_Monitor	blpop, brpop, brpoplpush, lindex, linsert, llen, lpop, lpush, lpushx, lrange, lrem, lset, ltrim, rpop, rpoplpush, rpush, rpushx	カウント/秒	BLPOP や BRPOP などのリスト関連コマンドの 1 秒あたりの呼び出し数。
Redis_Sets_Monitor	sadd, scard, sdiff, sdiffstore, sinter, sinterstore, sismember, smembers, smove, spop, srandmember, srem, sunion, sunionstore, sscan	カウント/秒	SADD や SCARD などのセット関連コマンドの 1 秒あたりの呼び出し数。
Redis_Zset_Monitor	zadd, zcard, zcount, zincrby, zrange, zrangebyscore, zrank, zrem, zremrangebyrank, zremrangebyscore, zrevrange, zrevrangebyscore, zrevrank, zscore, zunionstore, zinterstore, zscan, zrangebylex, zlexcount, zremrangebylex, zpopmin, zpopmax, bzpopmin, bzpopmax	カウント/秒	ZADD や ZCARD などのソート済みセット関連コマンドの 1 秒あたりの呼び出し数。
Redis_Hyperlog_Monitor	pfadd, pfcount, pfmerge	カウント/秒	PFADD や PFCOUNT などの HyperLogLog 関連コマンドの 1 秒あたりの呼び出し数。
Redis_Pub_Sub_Monitor	psubscribe, publish, pubsub, punsubscribe, subscribe, unsubscribe	カウント/秒	PUBLISH や SUBSCRIBE などのパブリッシュ/サブスクライブ関連コマンドの 1 秒あたりの呼び出し数。
Redis_Transaction_Monitor	discard, exec, multi, unwatch, watch	カウント/秒	WATCH や MULTI などのトランザクション関連コマンドの 1 秒あたりの呼び出し数。
Redis_Scripting_Monitor	eval, evalsha, script	カウント/秒	EVAL や EVALSHA などのスクリプティング関連コマンドの 1 秒あたりの呼び出し数。
Calls_Monitor	flushall_calls, flushdb_calls, keys_calls	カウント	FLUSHALL、FLUSHDB、KEYS コマンドの累積呼び出し数。
Redis_Connection_Monitor	auth, echo, ping, quit, select	カウント/秒	AUTH や ECHO などの接続関連コマンドの 1 秒あたりの呼び出し数。
Redis_Server_Monitor	bgsave, client, command, config, dbsize, debug, flushall, flushdb, info, monitor, slowlog, time	カウント/秒	BGSAVE や CONFIG などのサーバー関連コマンドの 1 秒あたりの呼び出し数。
Redis_Geo_Monitor	geoadd, geohash, geopos, geodist, georadius, georadiusbymember	カウント/秒	GEOADD や GEOHASH などの Geo 関連コマンドの 1 秒あたりの呼び出し数。
Redis_Streams_Monitor	xinfo, xadd, xtrim, xdel, xrange, xrevrange, xlen, xread, xgroup, xreadgroup, xack, xclaim, xpending	カウント/秒	XINFO や XADD などのストリーム関連コマンドの 1 秒あたりの呼び出し数。
Redis_TairDoc_Monitor	jsondel, jsonget, jsonmget, jsonset, jsontype, jsonnumincrby, jsonstrappend, jsonstrlen, jsonarrappend, jsonarrpop, jsonarrinsert, jsonarrlen, jsonarrtrim	カウント/秒	JSON.SET や JSON.GET などの Doc 関連コマンドの 1 秒あたりの呼び出し数。
Redis_TairHash_Monitor	exhset, exhsetnx, exhmset, exhexpireat, exhexpire, exhmsetwithopts, exhpexpireat, exhpexpire, exhpttl, exhttl, exhver, exhsetver, exhincrby, exhincrbyfloat, exhget, exhgetwithver, exhmget, exhdel, exhlen, exhexists, exhkeys, exhvals, exhgetall, exhmgetwithver, exhsterlen, exhscan	カウント/秒	EXHSET や EXHMSET などの exHash 関連コマンドの 1 秒あたりの呼び出し数。
Redis_TairString_Monitor	cas, cad, exset, exget, exsetver, exincrby, exincrbyfloat, excas, excad	カウント/秒	EXSET や EXGET などの exString 関連コマンドの 1 秒あたりの呼び出し数。
Redis_TairGis_Monitor	gisadd, gisget, gisdel, gissearch, giscontains, gisintersects, gisgetall	カウント/秒	GIS.ADD、GIS.GET、GIS.DEL などの GIS 関連コマンドの 1 秒あたりの呼び出し数。
Redis_TairBloom_Monitor	bfadd, bfmadd, bfexists, bfmexists, bfinsert, bfreserve, bfdebug	カウント/秒	BF.RESERVE や BF.ADD などの Bloom 関連コマンドの 1 秒あたりの呼び出し数。

レスポンスフィールド

フィールド	型	説明	例
	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****

例

成功レスポンス

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****"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidStartTime.Malformed	The Specified parameter "StartTime" is not valid.
400	InvalidEndTime.Malformed	The Specified parameter "EndTime" is not valid.

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

変更履歴

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