PolarDB-X 1.0-API参考-1.0（2017版本）-实例管理类 API-查询PolarDB-X的性能监控数据

2021-12-11 08:37:07

功能描述

根据性能参数获取某个用户实例在某个时间段范围内的性能监控数据。默认情况下（不传参数PeriodMultiple的时候）根据时间段范围不同会有不同的统计周期：

当时间段范围小于1天，统计周期为5分钟。
当时间段范围大于1天小于2天，统计周期为10分钟。
当时间段范围大于2天小于5天，统计周期为30分钟。
当时间段范围大于5天小于一周，统计周期为1小时。
当时间段范围大于一周，则不支持。

请求参数

参数名	类型	是否必须	描述
Action	String	是	系统规定参数，取值：DescribeDrdsInstanceMonitor。
DrdsInstanceId	String	是	PolarDB-X 实例 ID。
Key	String	是	性能指标，多个用英文半角“,”分隔，详情请参见性能参数表。
StartTime	Long	是	查询开始时间的毫秒级时间戳，例如：1542814801930。
EndTime	Long	是	查询结束时间的毫秒级时间戳，例如：1542944401930。
PeriodMultiple	Integer	否	统计周期倍数，指定统计周期为5分钟*PeriodMultiple。如：PeriodMultiple=2，则统计周期为10分钟，PeriodMultiple=12，则统计周期为1小时该参数不传则默认统计周期如《功能描述》所规定。

性能参数表

KEY-VALUE	描述
cpu	CPU使用率（单位%）
net	网络流量（单位kbps）
lqps	逻辑QPS
pqps	物理QPS
lrt	逻辑RT（ms）
prt	物理RT（ms）
con	连接数
thread	活跃线程数

返回值

参数名	类型	描述
公共返回值
data	List	由PartialPerformanceData组成的数组。

PartialPerformanceData组成如下：

参数名	类型	描述
Key	String	性能指标，详情请参见性能参数表。例外（如果请求的性能指标时net，则返回输入流量netin和输出流量netout俩个性能数值）
Unit	String	性能数值单位
Values	List	由PerformanceValue组成的数组。包含着指定性能指标在对应时间时的数值。

PerformanceValue组成如下：

参数名	类型	描述
Date	Long	毫秒级的时间戳
Value	String	时间对应的各项性能数值

错误码

错误码	报错信息	错误描述	HTTP 状态码
ServiceUnable	DRDS service is not enable for you	服务未开通	400
ActionUnauthorized	The specified action is not available for you	权限错误	400
InvalidDRDSInstanceId.NotFound	The DrdsInstanceId provided does not exist in our records.	实例ID不存在	404
InvalidParameter.time	The startTime and endTime must in one week	时间范围最大一周	400
InvalidParameter.periodMultiple	The periodMultiple is too larger than the time between startTime and endTime	统计周期倍数PeriodMultiple * 5分钟得出的统计周期，超出结束时间减去开始时间的统计范围。