DescribeHistoryMonitorValues - Tair (Redis® OSS-Compatible)

介面說明

該 API 對應的主控台操作請參見效能監控。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

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 分鐘為例，資料彙總頻率為 5s/次，查詢結果會按照 5s/次的頻率返回。說明查詢結果會與執行個體的資料彙總頻率對齊。若您傳入的 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 參數指定 DB 節點。標準架構（主備）：傳入 CpuUsage 即可。更多資訊監控指標與詳細說明，請參見下方的MonitorKeys 參數補充說明。說明預設為空，將返回 UsedMemory 與 quotaMemory 指標。為保障查詢效率，查詢單一節點的監控指標時，建議單次傳入不超過 5 個監控指標；查詢彙總監控指標時，建議單次不超過傳入 1 個監控指標。	CpuUsage
NodeId	string	否	執行個體中的節點 ID。傳入本參數可查詢指定節點的監控資訊。說明當執行個體的架構為讀寫分離或叢集架構時，本參數才可用。您可以呼叫 DescribeLogicInstanceTopology 介面查詢節點 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 參數，您仍可以使用原參數。	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	資料佔用的記憶體空間。
CustomerMemoryUsage	CustomerMemoryUsage	%	使用者記憶體使用率，範圍為 0~100。	DB DB 彙總
UsedQPS	TotalQps	Counts/s	每秒總請求數，包含讀和寫命令。	DB DB 彙總 Proxy Proxy 彙總
	GetQps	Counts/s	分別代表每秒讀、寫命令的請求數。執行個體的相容版本需為 Redis 4.0 及以上。
	PutQps	Counts/s	分別代表每秒讀、寫命令的請求數。執行個體的相容版本需為 Redis 4.0 及以上。
	OtherOps	Counts/s	指 PING、INFO、SELECT 與 AUTH 等無讀寫屬性的請求。由於 Proxy 對請求存在特殊處理，若執行個體帶有 Proxy 節點，則 OtherOps 僅包含部分 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 節點的該指標不包含 Proxy 與負載平衡的耗時。 Proxy 節點的該指標包含 DB 與 Proxy 的耗時，但不包含負載平衡的耗時。	DB DB 彙總 Proxy Proxy 彙總
				DB DB 彙總 Proxy Proxy 彙總

返回參數

名稱	類型	描述	樣本值
	object
MonitorHistory	string	以 JSON 格式返回的監控資訊，更多資訊，請參見監控參數說明。說明為提高資料傳輸效率，只有非 0 的監控資料才會返回，其餘未顯示的監控資料均為預設值 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

樣本

正常返回樣本

JSON格式

{
  "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 status code	錯誤碼	錯誤資訊	描述
400	InvalidStartTime.Malformed	The Specified parameter "StartTime" is not valid.
400	InvalidEndTime.Malformed	The Specified parameter "EndTime" is not valid.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。