文档首页/ 数据仓库服务 DWS/ 更多文档/ API参考（吉隆坡区域）/ API说明/ 主机监控/ 查询集群使用指标列表
更新时间：2025-09-18 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询集群使用指标列表

功能介绍

查询集群使用指标列表。

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

cluster_id

是

String

参数解释：

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

约束限制：

必须是有效的dws集群ID。

取值范围：

36位UUID。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

offset

是

Integer

参数解释：

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

约束限制：

不涉及。

取值范围：

大于等于0。

默认取值：

0

limit

是

Integer

参数解释：

分页单页大小。

约束限制：

不涉及。

取值范围：

大于0，最大1000。

默认取值：

不限制。

order_by

否

String

参数解释：

排序字段，固定取值。

约束限制：

不涉及。

取值范围：

create_time：按创建时间排序。

默认取值：

不涉及。

sort_by

否

String

参数解释：

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

约束限制：

不涉及。

取值范围：

asc：正序。

desc：倒序。

默认取值：

不涉及。

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

code

Integer

参数解释：

响应码。

取值范围：

不涉及。

msg

String

参数解释：

响应信息。

取值范围：

不涉及。

data

Array of ClusterMetric objects

参数解释：

指标列表。

取值范围：

不涉及。

count

Long

参数解释：

总列表大小。

取值范围：

不涉及。
表4 ClusterMetric

参数

参数类型

描述

scope

String

参数解释：

指标名称。

取值范围：

不涉及。

fields

Array of SimpleFieldDto objects

参数解释：

指标表相关字段信息。

取值范围：

不涉及。

metric_name

String

参数解释：

作用域。

取值范围：

不涉及。

collect_rate

Integer

参数解释：

采集速率。

取值范围：

不涉及。

collect_range

Array of strings

参数解释：

采集时间范围。

取值范围：

不涉及。

create_time

String

参数解释：

创建时间。

取值范围：

不涉及。
表5 SimpleFieldDto

参数

参数类型

描述

column_name

String

参数解释：

指标表对应字段名称。

取值范围：

不涉及。

column_type

String

参数解释：

指标表对应字段类型。

取值范围：

不涉及。

请求示例

https://{Endpoint}/v1/{project_id}/clusters/{cluster_id}/dms/metrics?limit=1&offset=0&order_by=create_time&sort_by=desc

响应示例

状态码：200

查询成功。

{
  "code" : 0,
  "msg" : "OK",
  "data" : [ {
    "scope" : "CN,ANY",
    "fields" : [ {
      "column_name" : "db_name",
      "column_type" : "text"
    }, {
      "column_name" : "schema_name",
      "column_type" : "text"
    }, {
      "column_name" : "table_name",
      "column_type" : "text"
    }, {
      "column_name" : "table_owner",
      "column_type" : "text"
    }, {
      "column_name" : "table_size",
      "column_type" : "bigint"
    }, {
      "column_name" : "dirty_page_rate",
      "column_type" : "double precision"
    } ],
    "metric_name" : "TableDirtyPageRate",
    "collect_rate" : 7200,
    "collect_range" : [ ],
    "create_time" : "1701915436000"
  } ],
  "count" : 1
}

状态码

状态码

描述

200

查询成功。

400

请求错误。

401

鉴权失败

403

没有操作权限

500

内部服务错误

503

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