文档首页/ 数据仓库服务 GaussDB(DWS)/ API参考/ API说明/ 主机监控/ 获取指定指标相关采集数据
更新时间：2024-03-19 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。

metric_name

是

String

指标名称。
表2 Query参数

参数

是否必选

参数类型

描述

offset

是

Integer

偏移量，表示从此偏移量开始查询，offset>=0。

limit

是

Integer

每页显示的条目数量，最大1000。

from

是

Long

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

to

是

Long

采集结束时间，13位时间戳。开始时间到结束时间最多不超过一天。

order_by

否

String

排序字段。固定取值。

  • ctime：采集时间。

sort_by

否

String

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

  • asc：正序。
  • desc：倒序。

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

code

Integer

响应码。

msg

String

响应信息。

data

Array of Map<String,String> 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

没有操作权限。

404

找不到资源。

500

服务内部错误。

503

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

相关文档