更新时间：2024-04-18 GMT+08:00
查询集群使用指标列表
功能介绍
该接口用于查询集群使用指标列表。
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/clusters/{cluster_id}/dms/metrics
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
项目ID。获取方法，请参见获取项目ID。 |
cluster_id |
是 |
String |
集群ID。获取方法，请参见获取集群ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
offset |
是 |
Integer |
偏移量，表示从此偏移量开始查询，offset>=0。 |
limit |
是 |
Integer |
每页显示的条目数量，最大1000。 |
order_by |
否 |
String |
排序字段。固定取值。
|
sort_by |
否 |
String |
正序还是倒叙。固定取值。
|
请求参数
无
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
code |
Integer |
响应码。 |
msg |
String |
响应信息。 |
data |
Array of ClusterMetric objects |
指标列表。 |
count |
Long |
总列表大小。 |
参数 |
参数类型 |
描述 |
|---|---|---|
scope |
String |
指标名称。 |
fields |
Array of SimpleFieldDto objects |
指标表相关字段信息。 |
metric_name |
String |
作用域。 |
collect_rate |
Integer |
采集速率。 |
collect_range |
Array of strings |
采集时间范围。 |
create_time |
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 |
没有操作权限。 |
404 |
找不到资源。 |
500 |
服务内部错误。 |
503 |
服务不可用。 |
