查看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 入参发生变更 | 查看变更详情 |