文档首页/ 数据仓库服务 DWS/ 更多文档/ API参考（联盟区域）/ API说明/ 主机监控/ 获取指定指标相关采集数据
更新时间：2025-12-10 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取指定指标相关采集数据

功能介绍

获取指定指标相关采集数据。

调用方法

请参见如何调用API。

URI

GET /v1/{project_id}/clusters/{cluster_id}/dms/metrics/{metric_name}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID。获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

cluster_id

是

String

参数解释：

集群ID。获取方法请参见获取集群ID。

约束限制：

必须是有效的dws集群ID。

取值范围：

36位UUID。

默认取值：

不涉及。

metric_name

是

String

参数解释：

指标名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

offset

是

Integer

参数解释：

分页偏移量，从0开始，页数减1。

约束限制：

不涉及。

取值范围：

大于等于0。

默认取值：

0

limit

是

Integer

参数解释：

分页单页大小。

约束限制：

不涉及。

取值范围：

大于0，最大1000。

默认取值：

不限制。

from

是

Long

参数解释：

采集开始时间，13位时间戳。

约束限制：

不涉及。

取值范围：

13位时间戳。

默认取值：

不涉及。

to

是

Long

参数解释：

采集结束时间，13位时间戳。

约束限制：

开始时间到结束时间最多不超过一天。

取值范围：

13位时间戳。

默认取值：

不涉及。

order_by

否

String

参数解释：

排序字段，固定取值。

约束限制：

不涉及。

取值范围：

ctime：采集时间。

默认取值：

不涉及。

sort_by

否

String

参数解释：

描述信息请求。

约束限制：

正序还是倒序，固定取值。

取值范围：

asc：正序。

desc：倒序。

默认取值：

不涉及。

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

code

Integer

参数解释：

响应码。

取值范围：

不涉及。

msg

String

参数解释：

响应信息。

取值范围：

不涉及。

data

Array of Map<String,Object> objects

参数解释：

指标采集数据列表。

取值范围：

不涉及。

count

Long

参数解释：

总列表大小。

取值范围：

不涉及。

请求示例

https://{Endpoint}/v1/{project_id}/clusters/{cluster_id}/dms/metrics/TableDirtyPageRate?limit=1&offset=0&from=1701914324000&to=1701942194000&order_by=ctime&sort_by=desc

响应示例

状态码：200

查询指标采集数据对象成功。

{
  "code" : 0,
  "msg" : "OK",
  "data" : [ {
    "table_size" : 40960,
    "virtual_cluster_id" : 53,
    "db_name" : "postgres",
    "ctime" : 1701929836000,
    "table_owner" : "Ruby",
    "schema_name" : "pmk",
    "table_name" : "pmk_meta_data",
    "dirty_page_rate" : 0.8
  } ],
  "count" : 3
}

状态码

状态码

描述

200

查询指标采集数据对象成功。

400

请求错误。

401

鉴权失败

403

没有操作权限

500

内部服务错误

503

服务不可用
父主题： 主机监控