查看Redis實例的性能監控信息。
接口說明
該 API 對應的控制臺操作請參見性能監控。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
kvstore:DescribeHistoryMonitorValues | get |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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 |
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 | Bytes | 當前分片的內存總量。 |
|
UsedMemory | UsedMemory | Bytes | 已使用內存量,包含數據和緩存部分。 |
|
Tair_PmemUsage | PmemUsage | % | 分別為持久內存使用率、持久內存已使用量和持久內存的內存總量。 僅持久內存型實例支持。 |
|
Tair_Pmem | PmemUsed | Bytes | ||
PmemQuota | Bytes | |||
Redis_DetailedSpaceUsage | ins_size | MB | 分別為實例占用總磁盤空間、數據文件占用的磁盤空間(包括 AOF、RDB 文件)和日志文件占用的磁盤空間(包含運行日志)。 僅經典部署模式(原本地盤)的內存型實例支持。 |
|
data_size | MB | |||
log_size | MB | |||
Redis_Memory_Monitor | used_memory_rss | Bytes | 該進程所占的物理內存,即操作系統分配給 Tair 服務的內存。 |
|
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 | 每秒總請求數,包含讀和寫命令。 |
|
GetQps | Counts/s | 分別代表每秒讀、寫命令的請求數。實例的兼容版本需為 Redis 4.0 及以上。 | ||
PutQps | Counts/s | |||
OtherOps | Counts/s | 指 PING、INFO、SELECT 與 AUTH 等無讀寫屬性的請求。由于 Proxy 對請求存在特殊處理,若實例帶有 Proxy 節點,則 OtherOps 僅包含部分 INFO 請求。 | ||
ConnectionUsage | connectionUsage | % | 連接數使用率,計算方法:已連接數÷實例支持的總連接數。客戶端通過直連地址連接至Tair實例(集群架構)時,此指標具備參考價值。 |
|
UsedConnection | ConnCount | Counts | 已使用連接數。 | |
QPSUsage | qpsUsage | % | QPS 使用率。 |
|
IntranetIn | InFlow | KB/s | 入、出流量速率。 |
|
IntranetOut | OutFlow | KB/s | ||
IntranetInRatio | intranetInRatio | % | 入、出流量使用率。 |
|
IntranetOutRatio | intranetOutRatio | % | ||
Redis_Avg_Rt_Monitor | AvgRt | us | 平均時延,為節點從接收命令到發出響應的時延平均值。 |
|
Redis_Max_Rt_Monitor | MaxRt | us | 最大時延,從節點從接收命令到發出響應的時延最大值。 | |
Redis_Basic_Monitor | Keys | Counts | Key 總數量,即實例存儲的一級 Key 總數。 |
|
Expires | Counts | 實例中設置過期時間的 Key 數量,該指標展示的是采集數據時的瞬時值。 | ||
ExpiredKeys | Counts | 歷史累計淘汰的 Key 總數。 | ||
EvictedKeys | Counts | 歷史累計逐出的 Key 總數。 | ||
ExpiredKeysPerSecond | Counts/s | 每秒淘汰的 Key 數量。 | ||
EvictedKeysPerSecond | Counts/s | 每秒逐出的 Key 數量。 | ||
inmem_keys | Counts | 該參數僅混合存儲型實例(已停售)支持,可忽略。 | ||
swapped_keys | Counts | |||
Hit_Rate_Monitor | hit_rate | % | 命中率計算方法:Key 命中數÷(Key 命中數+Key 未命中數)。 |
|
hit | Counts | 每秒命中的 Key 數量。 | ||
miss | Counts | 每秒未命中的 key 數量。 | ||
evicted_keys_per_sec | Counts | 每秒被驅逐的 Key 數量。 | ||
DiskUsage | disk_usage | % | 分別為磁盤使用率、輸入緩沖區占用大小、輸出緩沖區占用大小和磁盤性能監控項,僅磁盤型實例支持。 |
|
RocksDBConn | Tair_Connection_Monitor | Bytes | ||
Tair_Connection_Monitor | Bytes | |||
Tair_Disk_Monitor | io_bandwidth_kbps、iops、iops_usage 等。 | %、ms、Counts 等。 | ||
UsedConnection | ConnectionUsage | % | 連接數使用率,計算方法:已使用連接數÷實例支持的總連接數。客戶端通過 Proxy 節點連接至Tair實例(集群或讀寫分離架構)時,此指標具備參考價值。 |
|
UsedConnection | Counts | 已使用連接數。 | ||
NewUserConnQps | Counts/s | 客戶端到 Proxy 節點每秒建立的連接數。 | ||
Redis_Package_Monitor | request | Byte | 單個請求的平均字節數。 |
|
response | Byte | 單個響應的平均字節數。 | ||
request_max | Byte | 單個請求的最大字節數。 | ||
response_max | Byte | 單個響應的最大字節數。 | ||
RedisProxyConn | RedisUsedConnection | Counts | Proxy 節點到數據節點的連接數。 | |
NewDBConnQps | Counts/s | Proxy 節點到數據節點每秒建立的連接數。 | ||
DisconnectDBConn | Counts | Proxy 節點到數據節點累計斷連次數。 | ||
DisconnectUserConn | Counts | 客戶端到 Proxy 節點的累計斷連次數。 | ||
TotalCalls | TotalRefusedCommands | Counts | 累計拒絕命令數。 | |
TotalCallsPerSecCalls | Counts/s | 每秒請求數。 | ||
TotalCallsPerSecRetryCalls | Counts/s | 每秒請求重試數。 | ||
TotalCallsPerSecRetryFailed | Counts/s | 每秒失敗請求數。 |
返回參數
示例
正常返回示例
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****"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 |
---|---|---|
400 | InvalidStartTime.Malformed | The Specified parameter "StartTime" is not valid. |
400 | InvalidEndTime.Malformed | The Specified parameter "EndTime" is not valid. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-05-08 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |