接口功能介绍
查询实例监控概览,包括节点TPS、CPU、前端连接数和后端连接数。
接口约束
无
URI
GET /v2/status/overview
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
prodInstId | 是 | String | 产品实例id,涉及实例的接口一律使用产品实例id | cb236d462b924ef7bfba5ecf1d61de2b |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
code | 是 | String | 返回码 取值范围:0表示成功,1表示失败 | 0 | |
message | 是 | String | 结果描述 | success | |
result | 否 | Array of Objects | 返回对象,列表,若无该字段或该字段为null或者空列表,都代表返回对象为空。 | result |
表 result
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 | |
---|---|---|---|---|---|---|
id | 是 | String | 内部实例节点id | |||
tps | 是 | Double | TPS | 10.0 | ||
cpu | 是 | Double | CPU | 5.5 | ||
frontend | 是 | Double | 前端连接数 | 5.0 | ||
backend | 是 | Double | 后台连接数 | 5.0 |
请求示例
请求头header
无
请求体body
无
响应示例
{
"code": 0,
"message": "success",
"result": [
{
"id": "/dbproxy_cluster/dbproxy_cluster_0000000005/nodes/node_0000000279",
"tps": 0.0,
"cpu": 4.28,
"frontend": 1.0,
"backend": 0.0
},
{
"id": "/dbproxy_cluster/dbproxy_cluster_0000000005/nodes/node_0000000805",
"tps": 0.0,
"cpu": 5.35,
"frontend": 1.0,
"backend": 0.0
}
]
}
状态码
请参考 状态码说明。