- 生命周期管理
- 实例管理
- 连接管理
- 续费管理
- 账号管理
- 备份恢复
- 监控管理
- 日志管理
- 网络安全
- 参数管理
- 标签管理
- 性能优化
- 数据加密
- 运维任务管理
- 白名单模板管理
- 参数模板管理
- 事件管理
- 故障模拟
- 其他
接口说明
该 API 对应的控制台操作请参见性能监控。
请求参数
字段名称 | 字段详情 |
---|---|
InstanceIdstring | 实例 ID。 示例值:r-bp1zxszhcgatnx****参考取值来源: ModifyInstanceSSL CreateInstance RestartInstance RestoreInstance DescribeInstances |
StartTimestring | 查询历史监控开始时间点,格式为yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 示例值:2022-11-06T00:00:00Z |
EndTimestring | 查询历史监控结束时间点,须晚于历史监控开始时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。展开详情 示例值:2022-11-06T00:30:00Z |
IntervalForHistorystring | 本参数已废弃,固定取值为 示例值:01m枚举值:01m05m15m60m |
MonitorKeysstring | 监控指标,如需传入多个监控指标,需使用英文逗号(,)分隔。以 CpuUsage 为例:展开详情 示例值:CpuUsage |
NodeIdstring | 实例的中的节点 ID。传入本参数可查询指定节点的监控信息。展开详情 示例值:r-bp1zxszhcgatnx****-db-0#1679****参考取值来源: AddShardingNode |
NodeRolestring | 若希望查询云原生版读写分离架构实例中只读节点的指标,您在传入具体 NodeId 的同时,还需要在本参数传入 READONLY。展开详情 示例值: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 | % | 连接数使用率,计算方法:已连接数÷实例支持的总连接数。客户端通过直连地址连接至实例(集群架构)时,此指标具备参考价值。 |
|
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 节点连接至实例(集群或读写分离架构)时,此指标具备参考价值。 |
|
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 | 每秒失败请求数。 |
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等命令的调用次数。 |
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 | 使用 String 数据类型相关命令的监控信息,例如APPEND、MGET等命令的调用次数。 |
Redis_Hashes_Monitor | hdel、hexists、hget、hgetall、hincrby、hincrbyfloat、hkeys、hlen、hmget、hmset、hset、hsetnx、hvals、hscan | Counts/s | 使用 Hash 数据类型相关命令的监控信息,例如HGET、HDEL等命令的调用次数。 |
Redis_Lists_Monitor | blpop、brpop、brpoplpush、lindex、linsert、llen、lpop、lpush、lpushx、lrange、lrem、lset、ltrim、rpop、rpoplpush、rpush、rpushx | Counts/s | 使用 Lists 数据类型相关命令的监控信息,例如BLPOP、BRPOP等命令的调用次数。 |
Redis_Sets_Monitor | sadd、scard、sdiff、sdiffstore、sinter、sinterstore、sismember、smembers、smove、spop、srandmember、srem、sunion、sunionstore、sscan | Counts/s | 使用 Sets 数据类型相关命令的监控信息,例如SADD、SCARD等命令的调用次数。 |
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等命令的调用次数。 |
Redis_Hyperlog_Monitor | pfadd、pfcount、pfmerge | Counts/s | 使用 HyperLogLog 数据类型相关命令的监控信息,例如PFADD、PFCOUNT等命令的调用次数。 |
Redis_Pub_Sub_Monitor | psubscribe、publish、pubsub、punsubscribe、subscribe、unsubscribe | Counts/s | 使用发布与订阅(Pub/Sub)功能相关命令的监控信息,例如PUBLISH、SUBSCRIBE等命令的调用次数。 |
Redis_Transaction_Monitor | discard、exec、multi、unwatch、watch | Counts/s | 使用事务(Transaction)相关命令的监控信息,例如WATCH、MULTI等命令的调用次数。 |
Redis_Scripting_Monitor | eval、evalsha、script | Counts/s | 使用 Scripting 相关命令的监控信息,例如EVAL、EVALSHA等命令的每秒调用次数。 |
Calls_Monitor | flushall_calls、flushdb_calls、keys_calls | Counts | FLUSHALL、FLUSHDB、KEYS命令累计调用次数。 |
Redis_Connection_Monitor | auth、echo、ping、quit、select | Counts/s | 使用 Connection 相关命令的监控信息,例如AUTH、ECHO等命令的每秒调用次数。 |
Redis_Server_Monitor | bgsave、client、command、config、dbsize、debug、flushall、flushdb、info、monitor、slowlog、time | Counts/s | 使用 Server 相关命令的监控信息,例如BGSAVE、CONFIG等命令的每秒调用次数。 |
Redis_Geo_Monitor | geoadd、geohash、geopos、geodist、georadius、georadiusbymember | Counts/s | 使用 Geo 相关命令的监控信息,例如GEOADD、GEOHASH等命令的每秒调用次数。 |
Redis_Streams_Monitor | xinfo、xadd、xtrim、xdel、xrange、xrevrange、xlen、xread、xgroup、xreadgroup、xack、xclaim、xpending | Counts/s | 使用 Streams 相关命令的监控信息,例如XINFO、XADD等命令的每秒调用次数。 |
Counts/s | 使用 Lua 脚本相关命令的监控信息,例如 EVAL、SCRIPT 等命令的调用次数。 | ||
Redis_TairDoc_Monitor | jsondel、jsonget、jsonmget、jsonset、jsontype、jsonnumincrby、jsonstrappend、jsonstrlen、jsonarrappend、jsonarrpop、jsonarrinsert、jsonarrlen、jsonarrtrim | Counts/s | Doc 监控组,使用 Doc 相关命令的监控信息,例如JSON.SET、JSON.GET等命令的调用次数。 |
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 监控组,使用 exHash 相关命令的监控信息,例如EXHSET、EXHMSET等命令的调用次数。 |
Redis_TairString_Monitor | cas、cad、exset、exget、exsetver、exincrby、exincrbyfloat、excas、excad | Counts/s | exString 监控组,使用 exString 相关命令的监控信息,例如EXSET、EXGET等命令的调用次数。 |
Redis_TairGis_Monitor | gisadd、gisget、gisdel、gissearch、giscontains、gisintersects、gisgetall | Counts/s | GIS 监控组,使用 GIS 相关命令的监控信息,例如GIS.ADD、GIS.GET、GIS.DEL等命令的调用次数。 |
Redis_TairBloom_Monitor | bfadd、bfmadd、bfexists、bfmexists、bfinsert、bfreserve、bfdebug | Counts/s | Bloom 监控组,使用 Bloom 相关命令的监控信息,例如BF.RESERVE、BF.ADD等命令的调用次数。 |
返回参数
字段名称 | 字段详情 |
---|---|
MonitorHistorystring | 示例值:"{\"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\"}}" |
RequestIdstring | 请求 ID。 示例值:F0997EE8-F4C2-4503-9168-85177ED7**** |
变更时间 | 变更内容概要 | 操作 | |
---|---|---|---|
2024-05-08 | 新增请求参数NodeRole |