DescribeHistoryMonitorValues - 查看实例的性能监控信息

更新时间:
复制 MD 格式

查看云数据库 Tair(兼容 Redis)实例的性能监控信息。

接口说明

该 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

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

OtherOps

Counts/s

指 PING、INFO、SELECT 与 AUTH 等无读写属性的请求。由于 Proxy 对请求存在特殊处理,若实例带有 Proxy 节点,则 OtherOps 仅包含部分 INFO 请求。

ConnectionUsage

connectionUsage

%

连接数使用率,计算方法:已连接数÷实例支持的总连接数。客户端通过直连地址连接至Tair实例(集群架构)时,此指标具备参考价值。

  • DB

  • DB 聚合

UsedConnection

ConnCount

Counts

已使用连接数。

IntranetIn

InFlow

KB/s

入、出流量速率。

  • DB

  • DB 聚合

  • Proxy

  • Proxy 聚合

IntranetOut

OutFlow

KB/s

IntranetInRatio

intranetInRatio

%

入、出流量使用率。

  • DB

  • DB 聚合

IntranetOutRatio

intranetOutRatio

%

Redis_Avg_Rt_Monitor

AvgRt

us

平均时延,表示后端节点从接收命令到发出响应的时延平均值。

  • DB 节点的该指标不包含 Proxy 与负载均衡的耗时。

  • Proxy 节点的该指标包含 DB 与 Proxy 的耗时,但不包含负载均衡的耗时。

  • DB

  • DB 聚合

  • Proxy

  • Proxy 聚合

Redis_Max_Rt_Monitor

MaxRt

us

最大时延,表示节点从接收命令到发出响应的时延最大值。

  • DB 节点的该指标不包含 Proxy 与负载均衡的耗时。

  • Proxy 节点的该指标包含 DB 与 Proxy 的耗时,但不包含负载均衡的耗时。

Redis_Basic_Monitor

Keys

Counts

Key 总数量,即实例存储的一级 Key 总数。

  • DB

  • DB 聚合

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 未命中数)。

  • DB

  • DB 聚合

hit

Counts

每秒命中的 Key 数量。

miss

Counts

每秒未命中的 key 数量。

evicted_keys_per_sec

Counts

每秒被驱逐的 Key 数量。

DiskUsage

disk_usage

%

分别为磁盘使用率、输入缓冲区占用大小、输出缓冲区占用大小和磁盘性能监控项,仅磁盘型实例支持。

  • DB

Tair_Connection_Monitor

UsedInputBuffer

Bytes

UsedOutputBuffer

Bytes

Tair_Disk_Monitor

io_bandwidth_kbps、iops、iops_usage 等。

%、ms、Counts 等。

UsedConnection

ConnectionUsage

%

连接数使用率,计算方法:已使用连接数÷节点支持的最大连接数。客户端通过 Proxy 节点连接至Tair实例(集群或读写分离架构)时,此指标具备参考价值。

  • Proxy

  • Proxy 聚合

UsedConnection

Counts

已使用连接数。

NewUserConnQps

Counts/s

客户端到 Proxy 节点每秒建立的连接数。

Redis_Package_Monitor

request

Byte

单个请求的平均字节数。

  • Proxy

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

每秒失败请求数。

命令统计类监控项(如需查看请展开)

命令统计类监控项仅支持查询指定 DB。在查询时,您需要传入对应的MonitorKeys参数,同时还需要在 NodeId 参数指定 DB 节点。
说明

Tair 扩展命令监控组仅经典部署模式(原本地盘)的内存型实例支持。

MonitorKeys

子监控项

单位

说明

Redis_Keys_Monitor

del、dump、exists、expire、expireat、move、persist、pexpire、pexpireat、pttl、randomkey、rename、renamenx、restore、sort、ttl、type、scan

Counts/s

使用键值相关命令的监控信息,例如DELEXISTS等命令的调用次数。

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 数据类型相关命令的监控信息,例如APPENDMGET等命令的调用次数。

Redis_Hashes_Monitor

hdel、hexists、hget、hgetall、hincrby、hincrbyfloat、hkeys、hlen、hmget、hmset、hset、hsetnx、hvals、hscan

Counts/s

使用 Hash 数据类型相关命令的监控信息,例如HGETHDEL等命令的调用次数。

Redis_Lists_Monitor

blpop、brpop、brpoplpush、lindex、linsert、llen、lpop、lpush、lpushx、lrange、lrem、lset、ltrim、rpop、rpoplpush、rpush、rpushx

Counts/s

使用 Lists 数据类型相关命令的监控信息,例如BLPOPBRPOP等命令的调用次数。

Redis_Sets_Monitor

sadd、scard、sdiff、sdiffstore、sinter、sinterstore、sismember、smembers、smove、spop、srandmember、srem、sunion、sunionstore、sscan

Counts/s

使用 Sets 数据类型相关命令的监控信息,例如SADDSCARD等命令的调用次数。

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 数据类型相关命令的监控信息,例如ZADDZCARD等命令的调用次数。

Redis_Hyperlog_Monitor

pfadd、pfcount、pfmerge

Counts/s

使用 HyperLogLog 数据类型相关命令的监控信息,例如PFADDPFCOUNT等命令的调用次数。

Redis_Pub_Sub_Monitor

psubscribe、publish、pubsub、punsubscribe、subscribe、unsubscribe

Counts/s

使用发布与订阅(Pub/Sub)功能相关命令的监控信息,例如PUBLISHSUBSCRIBE等命令的调用次数。

Redis_Transaction_Monitor

discard、exec、multi、unwatch、watch

Counts/s

使用事务(Transaction)相关命令的监控信息,例如WATCHMULTI等命令的调用次数。

Redis_Scripting_Monitor

eval、evalsha、script

Counts/s

使用 Scripting 相关命令的监控信息,例如EVALEVALSHA等命令的每秒调用次数。

Calls_Monitor

flushall_calls、flushdb_calls、keys_calls

Counts

FLUSHALLFLUSHDBKEYS命令累计调用次数。

Redis_Connection_Monitor

auth、echo、ping、quit、select

Counts/s

使用 Connection 相关命令的监控信息,例如AUTHECHO等命令的每秒调用次数。

Redis_Server_Monitor

bgsave、client、command、config、dbsize、debug、flushall、flushdb、info、monitor、slowlog、time

Counts/s

使用 Server 相关命令的监控信息,例如BGSAVECONFIG等命令的每秒调用次数。

Redis_Geo_Monitor

geoadd、geohash、geopos、geodist、georadius、georadiusbymember

Counts/s

使用 Geo 相关命令的监控信息,例如GEOADDGEOHASH等命令的每秒调用次数。

Redis_Streams_Monitor

xinfo、xadd、xtrim、xdel、xrange、xrevrange、xlen、xread、xgroup、xreadgroup、xack、xclaim、xpending

Counts/s

使用 Streams 相关命令的监控信息,例如XINFOXADD等命令的每秒调用次数。

Redis_TairDoc_Monitor

jsondel、jsonget、jsonmget、jsonset、jsontype、jsonnumincrby、jsonstrappend、jsonstrlen、jsonarrappend、jsonarrpop、jsonarrinsert、jsonarrlen、jsonarrtrim

Counts/s

Doc 监控组,使用 Doc 相关命令的监控信息,例如JSON.SETJSON.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 相关命令的监控信息,例如EXHSETEXHMSET等命令的调用次数。

Redis_TairString_Monitor

cas、cad、exset、exget、exsetver、exincrby、exincrbyfloat、excas、excad

Counts/s

exString 监控组,使用 exString 相关命令的监控信息,例如EXSETEXGET等命令的调用次数。

Redis_TairGis_Monitor

gisadd、gisget、gisdel、gissearch、giscontains、gisintersects、gisgetall

Counts/s

GIS 监控组,使用 GIS 相关命令的监控信息,例如GIS.ADDGIS.GETGIS.DEL等命令的调用次数。

Redis_TairBloom_Monitor

bfadd、bfmadd、bfexists、bfmexists、bfinsert、bfreserve、bfdebug

Counts/s

Bloom 监控组,使用 Bloom 相关命令的监控信息,例如BF.RESERVEBF.ADD等命令的调用次数。

返回参数

名称

类型

描述

示例值

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****

示例

正常返回示例

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.

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情