调用DescribeHistoryMonitorValues查看Redis实例的性能监控信息。

该API对应的控制台操作请参见性能监控

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeHistoryMonitorValues

系统规定参数。取值:DescribeHistoryMonitorValues

InstanceId String r-bp1zxszhcgatnx****

实例ID。

StartTime String 2022-11-06T00:00:00Z

历史监控开始时间点,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

EndTime String 2022-11-06T00:30:00Z

历史监控结束时间点,须晚于历史监控开始时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

说明
  • 支持查询最近1个月的监控数据,且最大查询范围不能超过7天。
  • 如果实例的数据节点数大于32,数据节点和Proxy节点的聚合指标查询时间范围不能超过1小时。
IntervalForHistory String 01m

历史监控数据间隔,单位为分钟,取值固定为01m

MonitorKeys String memoryUsage

监控指标,如需传入多个监控指标,需使用英文逗号(,)分隔。

说明
  • 默认为空,将返回UsedMemory与quotaMemory指标,关于Redis实例支持的监控指标及其详细说明,请参见监控指标(MonitorKeys)
  • 为保障查询效率,查询单个节点的监控指标时,建议单次传入不超过5个监控指标;查询聚合监控指标时,建议单次不超过传入1个监控指标。
NodeId String r-bp1zxszhcgatnx****-db-0#1679****

实例的中的节点ID。传入本参数可查询指定节点的监控信息。

说明
  • 当Redis实例的架构为读写分离或集群架构时,本参数才可用。
  • 您可以调用DescribeLogicInstanceTopology接口查询节点ID。

返回数据

名称 类型 示例值 描述
MonitorHistory String "{\"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\"}}"

以JSON格式返回的监控信息,更多信息,请参见监控指标说明

说明
  • 为提高数据传输效率,只有非0的监控数据才会返回,其余未显示的监控数据均为默认值0
  • 查询结果会与实例的数据聚合频率对齐。以查询时间范围小于等于10分钟为例,数据聚合频率为5s/次,查询结果会按照5s/次的频率返回。若您传入的StartTime不在数据聚合时间点上,系统返回的首个时间点为最近的数据聚合时间点。例如您传入的StartTime为2022-01-20T12:01:48Z,系统返回的首个时间点为2022-01-20T12:01:45Z。
RequestId String F0997EE8-F4C2-4503-9168-85177ED7****

请求ID。

示例

请求示例

http(s)://r-kvstore.aliyuncs.com/?Action=DescribeHistoryMonitorValues
&InstanceId=r-bp1zxszhcgatnx****
&StartTime=2022-11-06T00:00:00Z
&EndTime=2022-11-06T00:30:00Z
&IntervalForHistory=01m
&MonitorKeys=memoryUsage
&NodeId=r-bp1zxszhcgatnx****-db-0#1679****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeHistoryMonitorValuesResponse>
    <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"}}</MonitorHistory>
    <RequestId>88523C30-8416-56E8-AAEF-64F849803C7C</RequestId>
</DescribeHistoryMonitorValuesResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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" : "88523C30-8416-56E8-AAEF-64F849803C7C"
}

错误码

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