云数据库 PostgreSQL 监控接口-腾讯云可观测平台-文档中心-腾讯云

1. 接口描述

域名：monitor.api.qcloud.com
接口：GetMonitorData

云数据库 PostgreSQL 是腾讯云基于开源数据库 PostgreSQL 专业打造的云数据库。具体介绍请参见云数据库 PostgreSQL。

查询云数据库 PostgreSQL 产品监控数据，入参取值如下：
namespace：qce/postgres
dimensions.0.name=resourceId
dimensions.0.value为实例的resourceId

2. 输入参数

以下请求参数列表仅列出了接口请求参数，正式调用时需要加上公共请求参数，见公共请求参数页面。其中，此接口的 Action 字段为 GetMonitorData。

2.1 输入参数

参数名称	必选	类型	输入内容	描述
namespace	是	String	qce/postgres	命名空间，每个云产品会有一个命名空间，具体名称见输入内容一栏。
metricName	是	String	具体的指标名称	指标名称，具体名称见2.2
dimensions.0.name	是	String	resourceId	入参为实例的 resourceId
dimensions.0.value	是	String	实例具体的 resourceId	输入实例的具体 resourceId，例如 postgres-jh7gbd41
period	否	Int	60/300	监控统计周期，绝大部分指标支持60s统计粒度，部分指标仅支持300s统计粒度，统计粒度根据指标的不同而变。输入参数时可参考2.2的指标详情列表。
startTime	否	Datetime	起始时间	起始时间，如"2016-01-01 10:25:00"。默认时间为当天的”00:00:00”
endTime	否	Datetime	结束时间	结束时间，默认为当前时间。 endTime 不能小于 startTime

2.2 指标名称

指标名称	含义	单位
connections	连接数	个
cpu	CPU利用率	%
hit_percent	缓冲区缓存命中率	%
in_flow	输入流量	KB/秒
out_flow	输出流量	KB/秒
iops	磁盘 IOPS	次/秒
memory	内存占用	KB
other_calls	其他请求数	次/分钟
qps	每秒查询数	次/秒
write_calls	写请求数	次/分钟
read_calls	读请求数	次/分钟
read_write_calls	读写请求数	次/分钟
remain_xid	剩余 XID 数量	个
sql_runtime_avg	平均执行时延	ms
sql_runtime_max	最长 TOP10 执行时延	ms
sql_runtime_min	最短 TOP10 执行时延	ms
storage	已用存储空间	GB
xlog_diff	主备 XLOG 同步差异	Byte

3. 输出参数

参数名称	类型	描述
code	Int	错误码，0: 成功, 其他值表示失败
message	String	返回信息
startTime	Datetime	起始时间
endTime	Datetime	结束时间
metricName	String	指标名称
period	Int	监控统计周期
dataPoints	Array	监控数据列表

4. 错误码表

错误代码	错误描述	英文描述
-502	资源不存在	OperationDenied.SourceNotExists
-503	请求参数有误	InvalidParameter
-505	参数缺失	InvalidParameter.MissingParameter
-507	超出限制	OperationDenied.ExceedLimit
-509	错误的维度组合	InvalidParameter.DimensionGroupError
-513	DB操作失败	InternalError.DBoperationFail

5. 示例

输入

https://monitor.api.qcloud.com/v2/index.php?
&公共请求参数
&namespace=qce/postgres
&metricName=connections
&dimensions.0.name=resourceId
&dimensions.0.value=postgres-jh7gbd41
&startTime=2016-06-28 14:10:00
&endTime=2016-06-28 14:20:00

输出

{
    "code": 0,
    "message": "",
    "metricName": "connections",
    "startTime": "2016-06-28 14:10:00",
    "endTime": "2016-06-28 14:20:00",
    "period": 300,
    "dataPoints": [
        3,
        10,
        5
    ]
}

云数据库 PostgreSQL 监控接口

本页目录：