查询指定监控看板下的监控视图列表

project_id

是

String

参数解释:

租户ID。用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取方式请参见“获取项目ID”。

约束限制:

不涉及。

取值范围:

字符串的长度必须在 1 到 64个字符之间。

默认取值:

不涉及。

dashboard_id

是

String

监控看板id，以db开头，包含22个字母和数字例：db16564943172807wjOmoLyn'

正则匹配：^db([a-z]|[A-Z]|[0-9]){22}$

group_id

否

String

视图所在的分组id

正则匹配：^dg([a-z]|[A-Z]|[0-9]){22}|default$

Content-Type

否

String

参数解释:

发送的实体的MIME类型。

约束限制:

不涉及。

取值范围:

最小字符数量为1，最大为64。

默认取值:

默认使用application/json; charset=UTF-8。

默认取值：

application/json; charset=UTF-8

X-Auth-Token

否

String

参数解释:

用户Token。

约束限制:

不涉及。

取值范围:

最小字符数量为1，最大为16384。

默认取值:

不涉及。

widgets

Array of WidgetInfoWithId objects

监控视图列表

widget_id

String

视图id

正则匹配：^wg([a-z]|[A-Z]|[0-9]){22}$

group_id

String

视图分区id

正则匹配：^dg([a-z]|[A-Z]|[0-9]){22}|default$

metrics

Array of WidgetMetric objects

指标列表

title

String

监控视图标题

正则匹配：^([\u4E00-\u9FFF]|[\u00C0-\u0204]|[a-z]|[A-Z]|[0-9]|[\"”≤<>&%_:/;“'?+,~，（） º\\(\\)\\[\\.\\-])( *([\u4E00-\u9FFF]|[\u00C0-\u0204]|[a-z]|[A-Z]|[0-9]|[\"”≤<>&%_:/;“'?+,~，（） º\\(\\)\\[\\.\\-]))*$

threshold

Double

监控视图指标的阈值

取值范围：

0-1.7976931348623157E308

threshold_enabled

Boolean

阈值是否展示，true:展示，false:不展示

view

String

监控视图图表类型, bar条形图，line折线图，bar_chart柱状图，table表格，circular_bar环形柱状图，area_chart面积图

枚举值：

• bar

• line

• bar_chart

• table

• circular_bar

• area_chart

metric_display_mode

String

指标展示类型，single 单指标展示，multiple 多指标展示

枚举值：

• single

• multiple

properties

properties object

额外信息

location

location object

监控视图图表坐标

unit

String

单位

create_time

Long

监控看板创建时间

取值范围：

1111111111111-9999999999999

namespace

String

服务维度

正则匹配：^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*\.([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*$

dimensions

DimensionInfo object

维度信息列表

metric_name

String

多个指标名称，用逗号隔开

alias

Array of strings

监控视图的指标别名列表

extra_info

ExtraInfo object

指标信息

rollup_enable

Boolean

参数解释

是否开启聚合

约束限制

当RollupEnable开启时，RollupFilter和RollupDimension必填

取值范围

true，表示开启聚合；false表示不开启聚合

默认取值

false

rollup_filter

String

聚合规则，last:最新值,max:最大值,min:最小值,average:平均值,sum:求和值

枚举值：

• last

• max

• min

• average

• sum

rollup_dimension

String

聚合维度

last_week_compare_enable

Boolean

是否展示同比（上周同一时间）数据，true:展示，false:不展示

yesterday_compare_enable

Boolean

是否展示环比（昨天同一时间）数据，true:展示，false:不展示

metric_dimension

String

维度名称，多维度用逗号分隔，各服务支持的维度可参考：“服务维度名称”

正则匹配：^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){0,31}(,([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){0,31}){0,3}$

top_num

Integer

展示数据数量

取值范围：

1-200

unit

String

单位

order

String

排序字段，asc正序，desc倒序

枚举值：

• asc

• desc

topn_metric_name

String

资源的监控指标名称，必须以字母开头，只能包含0-9/a-z/A-Z/_，字符长度最短为1，最大为64；如：弹性云服务器中的监控指标cpu_util，表示弹性服务器的CPU使用率；文档数据库中的指标mongo001_command_ps，表示command执行频率；各服务的指标名称可查看：“服务指标名称”。

name

String

维度名称，多维度用逗号分隔，各服务支持的维度可参考：“服务维度名称”

正则匹配：^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){0,31}(,([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){0,31}){0,3}$

filter_type

String

资源类型, all_instances: 全部资源, specific_instances: 指定资源

枚举值：

• all_instances

• specific_instances

values

Array of strings

维度值列表

origin_metric_name

String

指标名称

正则匹配：^([a-z]|[A-Z]|[0-9]|_|-|~|\.|/|:)*$

metric_prefix

String

指标名称前缀

正则匹配：^([a-z]|[A-Z]|[0-9]|_|-|~|\.|/|:)*$

metric_type

String

指标类型

正则匹配：^([a-z]|[A-Z]|[0-9]|_|-|~|\.|/|:)*$

custom_proc_name

String

自定义进程名称

filter

String

聚合类型，目前只有TopN这一种类型，折线图不支持该参数

枚举值：

• topN

topN

Integer

Top前N个；折线图时为随机展示的时序数据条数

取值范围：

1-2147483647

默认取值：

100

order

String

排序字段，asc正序，desc倒序，折线图不支持该参数

枚举值：

• asc

• desc

description

String

监控视图的描述信息

last_week_compare_enable

Boolean

是否展示同比（上周同一时间）数据，true:展示，false:不展示

yesterday_compare_enable

Boolean

是否展示环比（昨天同一时间）数据，true:展示，false:不展示

legend_location

String

图例位置标记，hide表示隐藏图例，right表示图例放在监控视图右侧，bottom表示图例放在监控视图底部，表格不支持该参数

枚举值：

• hide

• right

• bottom

legend_values

Array of strings

当前时序数据需要在图例中展示的统计值名称列表，表格不支持该参数；条形图和柱状图仅支持配置当前值

枚举值：

• last

• max

• min

• avg

• sum

thresholds

Array of ThresholdInfo objects

监控视图的阈值辅助线配置

is_all_compare_enable

Boolean

同比环比总开关是否生效;true:生效；false:不生效

threshold

Number

监控视图辅助线的阈值

取值范围：

0-2147483647

threshold_color

String

监控视图辅助线的颜色,"#B50E65"紫色,"#F23030"红色,"#FF8800"橙色,"#F2E70C"黄色

枚举值：

• #B50E65

• #F23030

• #FF8800

• #F2E70C

top

Integer

监控视图的上坐标

取值范围：

0-2147483647

left

Integer

监控视图的左坐标

取值范围：

0-9

width

Integer

监控视图图表宽度

取值范围：

3-12

height

Integer

监控视图图表高度

取值范围：

3-2147483647

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

200

OK

400

Bad Request, 请求错误

401

Unauthorized, 未提供认证信息，或认证信息错误

500

Internal Server Error, 请求未完成, 服务异常