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 ヶ月以内のデータをクエリできます。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` メトリクスを挙げます：クラスターまたは読み書き分離アーキテクチャのインスタンスの場合：すべてのデータノード（DB）の全体的な CPU 使用率をクエリするには、このパラメーターを CpuUsage$db に設定します。単一のデータノードの CPU 使用率をクエリするには、このパラメーターを CpuUsage に設定し、`NodeId` パラメーターに該当するデータノードの ID を指定します。標準のプライマリ／スタンバイアーキテクチャのインスタンスの場合、このパラメーターを CpuUsage に設定します。その他のメトリクスおよび詳細な説明については、「」「MonitorKeys パラメーターに関する追加情報」をご参照ください。説明このパラメーターを指定しない場合、デフォルトで `UsedMemory` および `quotaMemory` のメトリクスが返されます。クエリパフォーマンスを最適化するため、シングルノードに対しては 1 回のリクエストで最大 5 個のメトリクスを指定すること、集約メトリクスに対しては 1 回のリクエストで最大 1 個のメトリクスを指定することを推奨します。	CpuUsage
NodeId	string	任意	メトリクスをクエリするノードの ID。説明このパラメーターは、クラスターまたは読み書き分離アーキテクチャを使用するインスタンスでのみ利用可能です。ノード ID を取得するには、DescribeLogicInstanceTopology オペレーションを呼び出します。	r-bp1zxszhcgatnx**-db-0#1679**
NodeRole	string	任意	クラウドネイティブの読み書き分離インスタンスにおいて、読み取り専用ノードのメトリクスをクエリするには、NodeId を指定し、このパラメーターを READONLY に設定する必要があります。説明その他のすべてのシナリオでは、このパラメーターを省略するか、MASTER に設定できます。	READONLY
Type	string	任意

MonitorKeys パラメーター

この API オペレーションを呼び出す際は、以下の表の MonitorKeys 列から該当するパラメーターを指定してください。このオペレーションは、対応するサブモニタリング項目を返します。インスタンスは、汎用モニタリング項目およびコマンド統計モニタリング項目の両方をサポートしています。

汎用モニタリング項目

以下では、CpuUsage を例として、汎用モニタリング項目の使い方を説明します。

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

MonitorKeys	サブモニタリング項目	単位	説明	対応範囲
CpuUsage	CpuUsage	%	CPU 使用率。値の範囲は 0 ～ 100 です。説明以前に `RedisCpuUsage` パラメーターを渡していた、または返していた場合、引き続き使用できます。	DB DB 集約 Proxy Proxy 集約
MemoryUsage	memoryUsage	%	メモリ使用率。	DB DB 集約
quotaMemory	quotaMemory	Bytes	現在のシャードの合計メモリ量。	DB DB 集約
UsedMemory	UsedMemory	Bytes	データおよびキャッシュを含む、使用中のメモリ量。	DB DB 集約
Tair_PmemUsage	PmemUsage	%	それぞれ、永続メモリの使用率、使用量、合計量。これらのモニタリング項目は、永続メモリインスタンスでのみサポートされます。	DB DB 集約
Tair_Pmem	PmemUsed	Bytes
Tair_Pmem	PmemQuota	Bytes
Redis_DetailedSpaceUsage	ins_size	MB	それぞれ、インスタンスが使用する総ディスク領域、データファイル（AOF および RDB ファイルを含む）が使用するディスク領域、ログファイル（ランタイムログを含む）が使用するディスク領域。これらのモニタリング項目は、クラシックデプロイモード（ローカルディスク）のメモリ最適化インスタンスでのみサポートされます。	DB DB 集約
	data_size	MB
	log_size	MB
Redis_Memory_Monitor	used_memory_rss	Bytes	プロセスが使用する物理メモリ。これは、オペレーティングシステムが Tair サービスに割り当てたメモリです。	DB
	used_memory_lua	Bytes	Lua スクリプトが使用するメモリ量。
	used_memory_startup	Bytes	Tair の起動時に消費されるメモリ。
	lazyfree_pending_objects	Counts	Tair の lazy free プロセスによって回収待ちとなっているキーの数。
	used_memory_overhead	Bytes	Tair の内部データ管理に必要なメモリオーバーヘッド。これには、すべてのクライアント出力バッファー、クエリバッファー、AOF が含まれます。
	used_memory_dataset	Bytes	データセットが使用するメモリ領域。
UsedQPS	TotalQps	Counts/s	1 秒あたりのリクエスト総数（読み取りおよび書き込みコマンドを含む）。	DB DB 集約 Proxy Proxy 集約
	GetQps	Counts/s	それぞれ、1 秒あたりの読み取りおよび書き込みリクエスト数。インスタンスは Redis 4.0 以降と互換である必要があります。
	PutQps	Counts/s
	OtherOps	Counts/s	読み取りまたは書き込み属性を持たないリクエスト（`PING`、`INFO`、`SELECT`、`AUTH` など）。インスタンスがプロキシノードを使用している場合、このモニタリング項目には、プロキシノードによる特別な処理のため、一部の `INFO` リクエストのみが含まれます。
ConnectionUsage	connectionUsage	%	使用中の接続数の割合。計算式：「`使用中の接続数 / インスタンスがサポートする接続数の合計`」。このモニタリング項目は、クライアントが直接接続アドレス（エンドポイント）を使用してTair クラスターインスタンスに接続する場合に適用されます。	DB DB 集約
UsedConnection	ConnCount	Counts	使用中の接続数。	DB DB 集約
IntranetIn	InFlow	KB/s	インバウンドおよびアウトバウンドトラフィックの転送速度。	DB DB 集約 Proxy Proxy 集約
IntranetOut	OutFlow	KB/s	インバウンドおよびアウトバウンドトラフィックの転送速度。	DB DB 集約 Proxy Proxy 集約
IntranetInRatio	intranetInRatio	%	インバウンドおよびアウトバウンドトラフィックの使用率。	DB DB 集約
IntranetOutRatio	intranetOutRatio	%	インバウンドおよびアウトバウンドトラフィックの使用率。	DB DB 集約
Redis_Avg_Rt_Monitor	AvgRt	us	バックエンドノードがコマンドを受信してから応答を送信するまでの平均時間。データノードの場合、このモニタリング項目には、プロキシノードまたは負荷分散からのレイテンシーは含まれません。プロキシノードの場合、このモニタリング項目にはデータノードおよびプロキシノードのレイテンシーが含まれますが、負荷分散からのレイテンシーは含まれません。	DB DB 集約 Proxy Proxy 集約
Redis_Max_Rt_Monitor	MaxRt	us	ノードがコマンドを受信してから応答を送信するまでの最大時間。データノードの場合、このモニタリング項目には、プロキシノードまたは負荷分散からのレイテンシーは含まれません。プロキシノードの場合、このモニタリング項目にはデータノードおよびプロキシノードのレイテンシーが含まれますが、負荷分散からのレイテンシーは含まれません。	DB DB 集約 Proxy Proxy 集約
Redis_Basic_Monitor	Keys	Counts	インスタンスに格納されているトップレベルキーの総数。	DB DB 集約
	Expires	Counts	有効期限が設定されたキーの数。この値は、データ収集時のスナップショットです。
	ExpiredKeys	Counts	期限切れとなったキーの累積数。
	EvictedKeys	Counts	削除（evict）されたキーの累積数。
	ExpiredKeysPerSecond	Counts/s	1 秒あたりに期限切れとなるキーの数。
	EvictedKeysPerSecond	Counts/s	1 秒あたりに削除（evict）されるキーの数。
	inmem_keys	Counts	これらのモニタリング項目は、ハイブリッドストレージインスタンス（既に提供終了）でのみサポートされ、無視できます。
	swapped_keys	Counts	これらのモニタリング項目は、ハイブリッドストレージインスタンス（既に提供終了）でのみサポートされ、無視できます。
Hit_Rate_Monitor	hit_rate	%	キーのヒット率。計算式：「`キーのヒット数 / （キーのヒット数 + キーのミス数）`」。	DB DB 集約
	hit	Counts	1 秒あたりのキーのヒット数。
	miss	Counts	1 秒あたりのキーのミス数。
	evicted_keys_per_sec	Counts	1 秒あたりに削除（evict）されるキーの数。
DiskUsage	disk_usage	%	それぞれ、ディスク使用率、入力バッファーのサイズ、出力バッファーのサイズ、ディスクパフォーマンスのモニタリング項目。これらの項目は、ディスクストレージを使用するインスタンスでのみサポートされます。	DB
RocksDBConn	Tair_Connection_Monitor	Bytes
RocksDBConn	Tair_Connection_Monitor	Bytes
Tair_Disk_Monitor	io_bandwidth_kbps, iops, iops_usage, etc.	%, ms, Counts, etc.
UsedConnection	ConnectionUsage	%	使用中の接続数の割合。計算式：「`使用中の接続数 / ノードがサポートする最大接続数`」。このモニタリング項目は、クライアントがプロキシノードを経由してTair クラスターまたは読み書き分離インスタンスに接続する場合に適用されます。	Proxy Proxy 集約
	UsedConnection	Counts	使用中の接続数。
	NewUserConnQps	Counts/s	クライアントからプロキシノードへの、1 秒あたりの接続確立数。
Redis_Package_Monitor	request	Byte	1 つのリクエストの平均サイズ（バイト単位）。	Proxy
	response	Byte	1 つの応答の平均サイズ（バイト単位）。
	request_max	Byte	1 つのリクエストの最大サイズ（バイト単位）。
	response_max	Byte	1 つの応答の最大サイズ（バイト単位）。
RedisProxyConn	RedisUsedConnection	Counts	プロキシノードからデータノードへの接続数。
	NewDBConnQps	Counts/s	プロキシノードからデータノードへの、1 秒あたりの接続確立数。
	DisconnectDBConn	Counts	プロキシノードからデータノードへの切断の累積数。
	DisconnectUserConn	Counts	クライアントからプロキシノードへの切断の累積数。
TotalCalls	TotalRefusedCommands	Counts	拒否されたコマンドの累積数。
	TotalCallsPerSecCalls	Counts/s	1 秒あたりのリクエスト数。
	TotalCallsPerSecRetryCalls	Counts/s	1 秒あたりのリクエスト再試行数。
	TotalCallsPerSecRetryFailed	Counts/s	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	Counts/s	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	Counts/s	APPEND や MGET などの String データ型に関連するコマンドのモニタリング項目。たとえば、1 秒あたりのコマンド呼び出し回数など。
Redis_Hashes_Monitor	hdel, hexists, hget, hgetall, hincrby, hincrbyfloat, hkeys, hlen, hmget, hmset, hset, hsetnx, hvals, hscan	Counts/s	HGET や HDEL などの Hash データ型に関連するコマンドのモニタリング項目。たとえば、1 秒あたりのコマンド呼び出し回数など。
Redis_Lists_Monitor	blpop, brpop, brpoplpush, lindex, linsert, llen, lpop, lpush, lpushx, lrange, lrem, lset, ltrim, rpop, rpoplpush, rpush, rpushx	Counts/s	BLPOP や BRPOP などの List データ型に関連するコマンドのモニタリング項目。たとえば、1 秒あたりのコマンド呼び出し回数など。
Redis_Sets_Monitor	sadd, scard, sdiff, sdiffstore, sinter, sinterstore, sismember, smembers, smove, spop, srandmember, srem, sunion, sunionstore, sscan	Counts/s	SADD や SCARD などの Set データ型に関連するコマンドのモニタリング項目。たとえば、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	Counts/s	Zset (ソートセット) データの型に関連するコマンドの監視項目。ZADD や ZCARD などのコマンドの 1秒あたりの呼び出し数など。
Redis_Hyperlog_Monitor	pfadd, pfcount, pfmerge	Counts/s	PFADD や PFCOUNT などの HyperLogLog データ型に関連するコマンドのモニタリング項目。たとえば、1 秒あたりのコマンド呼び出し回数など。
Redis_Pub_Sub_Monitor	psubscribe, publish, pubsub, punsubscribe, subscribe, unsubscribe	Counts/s	PUBLISH や SUBSCRIBE などのパブリッシュ／サブスクライブ（Pub/Sub）機能に関連するコマンドのモニタリング項目。たとえば、1 秒あたりのコマンド呼び出し回数など。
Redis_Transaction_Monitor	discard, exec, multi, unwatch, watch	Counts/s	WATCH や MULTI などのトランザクション関連コマンドのモニタリング項目。たとえば、1 秒あたりのコマンド呼び出し回数など。
Redis_Scripting_Monitor	eval, evalsha, script	Counts/s	EVAL や EVALSHA などのスクリプト関連コマンドのモニタリング項目。たとえば、1 秒あたりのコマンド呼び出し回数など。
Calls_Monitor	flushall_calls, flushdb_calls, keys_calls	Counts	FLUSHALL、FLUSHDB、KEYS コマンドの呼び出し回数の累積数。
Redis_Connection_Monitor	auth, echo, ping, quit, select	Counts/s	AUTH や ECHO などの接続関連コマンドのモニタリング項目。たとえば、1 秒あたりのコマンド呼び出し回数など。
Redis_Server_Monitor	bgsave, client, command, config, dbsize, debug, flushall, flushdb, info, monitor, slowlog, time	Counts/s	BGSAVE や CONFIG などのサーバー関連コマンドのモニタリング項目。たとえば、1 秒あたりのコマンド呼び出し回数など。
Redis_Geo_Monitor	geoadd, geohash, geopos, geodist, georadius, georadiusbymember	Counts/s	GEOADD や GEOHASH などの Geo 関連コマンドのモニタリング項目。たとえば、1 秒あたりのコマンド呼び出し回数など。
Redis_Streams_Monitor	xinfo, xadd, xtrim, xdel, xrange, xrevrange, xlen, xread, xgroup, xreadgroup, xack, xclaim, xpending	Counts/s	XINFO や XADD などの Streams 関連コマンドのモニタリング項目。たとえば、1 秒あたりのコマンド呼び出し回数など。
Redis_TairDoc_Monitor	jsondel, jsonget, jsonmget, jsonset, jsontype, jsonnumincrby, jsonstrappend, jsonstrlen, jsonarrappend, jsonarrpop, jsonarrinsert, jsonarrlen, jsonarrtrim	Counts/s	Doc モニタリンググループ：jsonset や jsonget などの 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	Counts/s	exHash モニタリンググループ：EXHSET や EXHMSET などの exHash 関連コマンドのモニタリング項目。たとえば、1 秒あたりのコマンド呼び出し回数など。
Redis_TairString_Monitor	cas, cad, exset, exget, exsetver, exincrby, exincrbyfloat, excas, excad	Counts/s	exString モニタリンググループ: EXSET や EXGET などの exString 関連のコマンドに関するモニタリング項目。たとえば、これらのコマンドの 1 秒あたりの呼び出し回数です。
Redis_TairGis_Monitor	gisadd, gisget, gisdel, gissearch, giscontains, gisintersects, gisgetall	Counts/s	GIS モニタリンググループ：gisadd、gisget、gisdel などの GIS 関連コマンドのモニタリング項目。たとえば、1 秒あたりのコマンド呼び出し回数など。
Redis_TairBloom_Monitor	bfadd, bfmadd, bfexists, bfmexists, bfinsert, bfreserve, bfdebug	Counts/s	Bloom モニタリンググループ：bfreserve や bfadd などの 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.

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

変更履歴

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