查看云數(shù)據(jù)庫(kù) Tair(兼容 Redis)實(shí)例的性能監(jiān)控信息。
接口說(shuō)明
該 API 對(duì)應(yīng)的控制臺(tái)操作請(qǐng)參見(jiàn)性能監(jiān)控。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語(yǔ)句的Action
元素中使用,用來(lái)給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說(shuō)明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問(wèn)級(jí)別:是指每個(gè)操作的訪問(wèn)級(jí)別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說(shuō)明如下:
- 對(duì)于必選的資源類型,用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問(wèn)級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
kvstore:DescribeHistoryMonitorValues | get | *DBInstance acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId} |
| 無(wú) |
請(qǐng)求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 實(shí)例 ID。 | r-bp1zxszhcgatnx**** |
StartTime | string | 是 | 歷史監(jiān)控開(kāi)始時(shí)間點(diǎn),格式為yyyy-MM-ddTHH:mm:ssZ(UTC 時(shí)間)。 | 2022-11-06T00:00:00Z |
EndTime | string | 是 | 歷史監(jiān)控結(jié)束時(shí)間點(diǎn),須晚于歷史監(jiān)控開(kāi)始時(shí)間,格式為yyyy-MM-ddTHH:mm:ssZ(UTC 時(shí)間)。 說(shuō)明
支持查詢最近 1 個(gè)月的監(jiān)控?cái)?shù)據(jù),且最大查詢范圍不能超過(guò) 7 天。
| 2022-11-06T00:30:00Z |
IntervalForHistory | string | 是 | 本參數(shù)已廢棄,固定取值為 實(shí)際會(huì)根據(jù)查詢的開(kāi)始時(shí)間和結(jié)束時(shí)間自動(dòng)決定查詢的時(shí)間間隔。以查詢時(shí)間范圍小于等于 10 分鐘為例,數(shù)據(jù)聚合頻率為 5s/次,查詢結(jié)果會(huì)按照 5s/次的頻率返回。 說(shuō)明
| 01m |
MonitorKeys | string | 否 | 監(jiān)控指標(biāo),如需傳入多個(gè)監(jiān)控指標(biāo),需使用英文逗號(hào)(,)分隔。以 CpuUsage 為例:
更多信息監(jiān)控指標(biāo)與詳細(xì)說(shuō)明,請(qǐng)參見(jiàn)下方的 MonitorKeys 參數(shù)補(bǔ)充說(shuō)明。 說(shuō)明
| CpuUsage |
NodeId | string | 否 | 實(shí)例的中的節(jié)點(diǎn) ID。傳入本參數(shù)可查詢指定節(jié)點(diǎn)的監(jiān)控信息。 說(shuō)明
| r-bp1zxszhcgatnx****-db-0#1679**** |
NodeRole | string | 否 | 若希望查詢?cè)圃孀x寫分離架構(gòu)實(shí)例中只讀節(jié)點(diǎn)的指標(biāo),您在傳入具體 NodeId 的同時(shí),還需要在本參數(shù)傳入 READONLY。 說(shuō)明
其余情況請(qǐng)無(wú)需傳入(或傳入 MASTER)。
| READONLY |
MonitorKeys 參數(shù)補(bǔ)充說(shuō)明
調(diào)用 OpenAPI 時(shí),請(qǐng)傳入下表MonitorKeys列參數(shù),系統(tǒng)將返回子監(jiān)控項(xiàng)。實(shí)例支持通用類監(jiān)控項(xiàng)和命令統(tǒng)計(jì)類監(jiān)控項(xiàng)。
通用類監(jiān)控項(xiàng)
通用類監(jiān)控項(xiàng)的使用說(shuō)明如下,以 CpuUsage 為例。
-
集群節(jié)點(diǎn)或讀寫分離架構(gòu):
- 查詢所有數(shù)據(jù)節(jié)點(diǎn)(DB)整體的 CPU 使用率:您需要傳入CpuUsage$db。
- 查詢所有 Proxy 節(jié)點(diǎn)整體的 CPU 使用率:您需要傳入CpuUsage$proxy。
- 查詢單個(gè)數(shù)據(jù)節(jié)點(diǎn)或 Proxy 節(jié)點(diǎn)的 CPU 使用率:您需要傳入CpuUsage,同時(shí)在 NodeId 參數(shù)指定 DB 節(jié)點(diǎn)或 Proxy 節(jié)點(diǎn)。
-
標(biāo)準(zhǔn)架構(gòu)(主從節(jié)點(diǎn)):傳入 CpuUsage 即可。
MonitorKeys | 子監(jiān)控項(xiàng) | 單位 | 說(shuō)明 | 支持范圍 |
CpuUsage | CpuUsage | % | CPU 使用率,范圍為 0~100。 說(shuō)明 若您的實(shí)例原先傳入或返回 RedisCpuUsage 參數(shù),您仍可以使用原參數(shù)。 |
|
MemoryUsage | memoryUsage | % | 內(nèi)存使用率。 |
|
quotaMemory | quotaMemory | Bytes | 當(dāng)前分片的內(nèi)存總量。 |
|
UsedMemory | UsedMemory | Bytes | 已使用內(nèi)存量,包含數(shù)據(jù)和緩存部分。 |
|
Tair_PmemUsage | PmemUsage | % | 分別為持久內(nèi)存使用率、持久內(nèi)存已使用量和持久內(nèi)存的內(nèi)存總量。 僅持久內(nèi)存型實(shí)例支持。 |
|
Tair_Pmem | PmemUsed | Bytes | ||
PmemQuota | Bytes | |||
Redis_DetailedSpaceUsage | ins_size | MB | 分別為實(shí)例占用總磁盤空間、數(shù)據(jù)文件占用的磁盤空間(包括 AOF、RDB 文件)和日志文件占用的磁盤空間(包含運(yùn)行日志)。 僅經(jīng)典部署模式(原本地盤)的內(nèi)存型實(shí)例支持。 |
|
data_size | MB | |||
log_size | MB | |||
Redis_Memory_Monitor | used_memory_rss | Bytes | 該進(jìn)程所占的物理內(nèi)存,即操作系統(tǒng)分配給 Tair 服務(wù)的內(nèi)存。 |
|
used_memory_lua | Bytes | Lua 腳本使用內(nèi)存量。 | ||
used_memory_startup | Bytes | Tair 啟動(dòng)時(shí)消耗的內(nèi)存。 | ||
lazyfree_pending_objects | Counts | Tair 執(zhí)行 lazy free 操作,在等待被實(shí)際回收內(nèi)容的鍵個(gè)數(shù)。 | ||
used_memory_overhead | Bytes | Tair 為維護(hù)數(shù)據(jù)集的內(nèi)部機(jī)制所需的內(nèi)存開(kāi)銷,包括所有客戶端的輸出緩沖區(qū)、查詢緩沖區(qū)和 AOF。 | ||
used_memory_dataset | Bytes | 數(shù)據(jù)占用的內(nèi)存空間。 | ||
UsedQPS | TotalQps | Counts/s | 每秒總請(qǐng)求數(shù),包含讀和寫命令。 |
|
GetQps | Counts/s | 分別代表每秒讀、寫命令的請(qǐng)求數(shù)。實(shí)例的兼容版本需為 Redis 4.0 及以上。 | ||
PutQps | Counts/s | |||
OtherOps | Counts/s | 指 PING、INFO、SELECT 與 AUTH 等無(wú)讀寫屬性的請(qǐng)求。由于 Proxy 對(duì)請(qǐng)求存在特殊處理,若實(shí)例帶有 Proxy 節(jié)點(diǎn),則 OtherOps 僅包含部分 INFO 請(qǐng)求。 | ||
ConnectionUsage | connectionUsage | % | 連接數(shù)使用率,計(jì)算方法:已連接數(shù)÷實(shí)例支持的總連接數(shù)。客戶端通過(guò)直連地址連接至Tair實(shí)例(集群架構(gòu))時(shí),此指標(biāo)具備參考價(jià)值。 |
|
UsedConnection | ConnCount | Counts | 已使用連接數(shù)。 | |
QPSUsage | qpsUsage | % | QPS 使用率。 |
|
IntranetIn | InFlow | KB/s | 入、出流量速率。 |
|
IntranetOut | OutFlow | KB/s | ||
IntranetInRatio | intranetInRatio | % | 入、出流量使用率。 |
|
IntranetOutRatio | intranetOutRatio | % | ||
Redis_Avg_Rt_Monitor | AvgRt | us | 平均時(shí)延,表示后端節(jié)點(diǎn)從接收命令到發(fā)出響應(yīng)的時(shí)延平均值。
|
|
Redis_Max_Rt_Monitor | MaxRt | us | 最大時(shí)延,表示節(jié)點(diǎn)從接收命令到發(fā)出響應(yīng)的時(shí)延最大值。
| |
Redis_Basic_Monitor | Keys | Counts | Key 總數(shù)量,即實(shí)例存儲(chǔ)的一級(jí) Key 總數(shù)。 |
|
Expires | Counts | 實(shí)例中設(shè)置過(guò)期時(shí)間的 Key 數(shù)量,該指標(biāo)展示的是采集數(shù)據(jù)時(shí)的瞬時(shí)值。 | ||
ExpiredKeys | Counts | 歷史累計(jì)淘汰的 Key 總數(shù)。 | ||
EvictedKeys | Counts | 歷史累計(jì)逐出的 Key 總數(shù)。 | ||
ExpiredKeysPerSecond | Counts/s | 每秒淘汰的 Key 數(shù)量。 | ||
EvictedKeysPerSecond | Counts/s | 每秒逐出的 Key 數(shù)量。 | ||
inmem_keys | Counts | 該參數(shù)僅混合存儲(chǔ)型實(shí)例(已停售)支持,可忽略。 | ||
swapped_keys | Counts | |||
Hit_Rate_Monitor | hit_rate | % | 命中率計(jì)算方法:Key 命中數(shù)÷(Key 命中數(shù)+Key 未命中數(shù))。 |
|
hit | Counts | 每秒命中的 Key 數(shù)量。 | ||
miss | Counts | 每秒未命中的 key 數(shù)量。 | ||
evicted_keys_per_sec | Counts | 每秒被驅(qū)逐的 Key 數(shù)量。 | ||
DiskUsage | disk_usage | % | 分別為磁盤使用率、輸入緩沖區(qū)占用大小、輸出緩沖區(qū)占用大小和磁盤性能監(jiān)控項(xiàng),僅磁盤型實(shí)例支持。 |
|
RocksDBConn | Tair_Connection_Monitor | Bytes | ||
Tair_Connection_Monitor | Bytes | |||
Tair_Disk_Monitor | io_bandwidth_kbps、iops、iops_usage 等。 | %、ms、Counts 等。 | ||
UsedConnection | ConnectionUsage | % | 連接數(shù)使用率,計(jì)算方法:已使用連接數(shù)÷節(jié)點(diǎn)支持的最大連接數(shù)。客戶端通過(guò) Proxy 節(jié)點(diǎn)連接至Tair實(shí)例(集群或讀寫分離架構(gòu))時(shí),此指標(biāo)具備參考價(jià)值。 |
|
UsedConnection | Counts | 已使用連接數(shù)。 | ||
NewUserConnQps | Counts/s | 客戶端到 Proxy 節(jié)點(diǎn)每秒建立的連接數(shù)。 | ||
Redis_Package_Monitor | request | Byte | 單個(gè)請(qǐng)求的平均字節(jié)數(shù)。 |
|
response | Byte | 單個(gè)響應(yīng)的平均字節(jié)數(shù)。 | ||
request_max | Byte | 單個(gè)請(qǐng)求的最大字節(jié)數(shù)。 | ||
response_max | Byte | 單個(gè)響應(yīng)的最大字節(jié)數(shù)。 | ||
RedisProxyConn | RedisUsedConnection | Counts | Proxy 節(jié)點(diǎn)到數(shù)據(jù)節(jié)點(diǎn)的連接數(shù)。 | |
NewDBConnQps | Counts/s | Proxy 節(jié)點(diǎn)到數(shù)據(jù)節(jié)點(diǎn)每秒建立的連接數(shù)。 | ||
DisconnectDBConn | Counts | Proxy 節(jié)點(diǎn)到數(shù)據(jù)節(jié)點(diǎn)累計(jì)斷連次數(shù)。 | ||
DisconnectUserConn | Counts | 客戶端到 Proxy 節(jié)點(diǎn)的累計(jì)斷連次數(shù)。 | ||
TotalCalls | TotalRefusedCommands | Counts | 累計(jì)拒絕命令數(shù)。 | |
TotalCallsPerSecCalls | Counts/s | 每秒請(qǐng)求數(shù)。 | ||
TotalCallsPerSecRetryCalls | Counts/s | 每秒請(qǐng)求重試數(shù)。 | ||
TotalCallsPerSecRetryFailed | Counts/s | 每秒失敗請(qǐng)求數(shù)。 |
返回參數(shù)
示例
正常返回示例
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****"
}
錯(cuò)誤碼
HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 |
---|---|---|
400 | InvalidStartTime.Malformed | The Specified parameter "StartTime" is not valid. |
400 | InvalidEndTime.Malformed | The Specified parameter "EndTime" is not valid. |
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-05-08 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |