文档首页/ 云监控服务 CES/ API参考/ API V2/ 监控视图/ 查询指定监控视图信息 - ShowWidget
更新时间：2025-10-29 GMT+08:00
查看PDF
分享

查询指定监控视图信息 - ShowWidget

功能介绍

查询指定监控视图信息

接口约束

目前华东-青岛、拉美-墨西哥城一、土耳其-伊斯坦布尔、亚太-雅加达、中东-利雅得、亚太-马尼拉6个局点不支持该接口

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    ces:widgets:get

    Read

    -

    -

    -

    -

URI

GET /v2/{project_id}/widgets/{widget_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

widget_id

是

String

参数解释:

监控视图id。

约束限制:

不涉及。

取值范围:

字符串必须以wg开头，包含22个字母和数字，长度为24个字符。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

否

String

参数解释:

发送的实体的MIME类型。

约束限制:

不涉及。

取值范围:

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

默认取值:

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

X-Auth-Token

否

String

参数解释:

用户Token。

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

widget_id

String

参数解释

视图id

取值范围

字符串必须以wg开头，包含22个字母和数字，长度为24个字符。

group_id

String

参数解释

视图分组id

取值范围

字符串必须以dg开头，包含22个字母和数字，长度为24个字符或者为default，default代表不分组

metrics

Array of WidgetMetricResp objects

参数解释

指标列表

title

String

参数解释

监控视图标题

取值范围

长度为[1,128]个字符，允许包括以下内容：1、中文汉字；2、拉丁字母；3、英文大小写字母；4、数字(0-9)；5、符号： ” " ≤ < > & / %_ : / ; “ ' ? + , ~ ， （ ） º ( ) [ . -

threshold

Double

参数解释

监控视图指标的阈值

取值范围

最小值为0，最大值为1.7976931348623157e+308

threshold_enabled

Boolean

参数解释

阈值是否展示

取值范围

  • true:展示

  • false:不展示

view

String

参数解释

监控视图图表类型

取值范围

  • bar:条形图

  • line:折线图

  • bar_chart:柱状图

  • table:表格

  • circular_bar:环形柱状图

  • area_chart:面积图

metric_display_mode

String

参数解释

指标展示类型

取值范围

  • single:单指标展示

  • multiple:多指标展示

properties

properties object

参数解释

额外信息

location

location object

参数解释

监控视图图表坐标

unit

String

参数解释

单位

取值范围

长度为[0,32]个字符

create_time

Long

参数解释

监控看板创建时间

取值范围

最小值为1111111111111，最大值为9999999999999
表4 WidgetMetricResp

参数

参数类型

描述

namespace

String

参数解释

查询服务的命名空间，各服务命名空间请参考“服务命名空间”

取值范围

格式为service.item；service和item必须是字符串，必须以字母开头，只能包含0-9/a-z/A-Z/_。字符串的长度必须在 3 到 32个字符之间。

dimensions

DimensionInfoResp object

参数描述

维度信息列表。

metric_name

String

参数解释

多个指标名称

取值范围

长度为[1,1080]个字符，多个指标名称之间用逗号隔开

alias

Array of strings

参数解释

监控视图的指标别名列表

extra_info

ExtraInfoResp object

参数解释

指标信息

rollup_enable

Boolean

参数解释

是否开启聚合

取值范围

  • true：表示开启聚合

  • false：表示不开启聚合

rollup_filter

String

参数解释

聚合规则

取值范围

  • last:最新值

  • max:最大值

  • min:最小值

  • average:平均值

  • sum:求和值

rollup_dimension

String

参数解释

聚合维度

取值范围

长度为[1,32]个字符

last_week_compare_enable

Boolean

参数解释

是否展示同比（上周同一时间）数据

取值范围

  • true:展示

  • false:不展示

yesterday_compare_enable

Boolean

参数解释

是否展示环比（昨天同一时间）数据

取值范围

  • true:展示

  • false:不展示

metric_dimension

String

参数解释

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

取值范围

必须以字母开头，只能包含0-9/a-z/A-Z/_/-，多维度用","分隔，每个维度的最大长度为32。总长度为[1,131]个字符。目前最大支持4个维度。举例：单维度场景：instance_id；多维度场景：instance_id,disk

top_num

Integer

参数解释

展示数据数量

取值范围

最小值为1，最大值为200

unit

String

参数解释

单位

取值范围

长度为[0,32]个字符

order

String

参数解释

排序字段

取值范围

  • asc:正序

  • desc:倒序

topn_metric_name

String

参数解释

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

取值范围

长度为[1,96]个字符
表5 DimensionInfoResp

参数

参数类型

描述

name

String

参数描述：

维度名称。

取值范围：

多维度用逗号分隔，各服务支持的维度可参考：“服务维度名称”。必须以字母开头，只能包含0-9/a-z/A-Z/_/-，多维度用","分隔，每个维度的最大长度为32。总长度为[1,131]个字符。目前最大支持4个维度。举例：单维度场景：instance_id；多维度场景：instance_id,disk

filter_type

String

参数描述：

资源类型。

取值范围：

  • all_instances: 全部资源

  • specific_instances: 指定资源

values

Array of strings

参数描述：

维度值列表。
表6 ExtraInfoResp

参数

参数类型

描述

origin_metric_name

String

参数解释

指标名称

取值范围

长度为[1,4096]个字符

metric_prefix

String

参数解释

指标名称前缀

取值范围

长度为[1,4096]个字符

metric_type

String

参数解释

指标类型

取值范围

长度为[1,32]个字符

custom_proc_name

String

参数解释

自定义进程名称

取值范围

长度为[1,250]个字符
表7 properties

参数

参数类型

描述

filter

String

参数解释

聚合类型

取值范围

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

topN

Integer

参数解释

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

取值范围

最小值为1，最大值为2147483647

order

String

参数解释

排序字段

取值范围

  • asc:正序

  • desc:倒序

description

String

参数解释

监控视图的描述信息

取值范围

长度为[0,200]个字符

last_week_compare_enable

Boolean

参数解释

是否展示同比（上周同一时间）数据

取值范围

  • true:展示

  • false:不展示

yesterday_compare_enable

Boolean

参数解释

是否展示环比（昨天同一时间）数据

取值范围

  • true:展示

  • false:不展示

legend_location

String

参数解释

图例位置标记

取值范围

  • hide:表示隐藏图例

  • right:表示图例放在监控视图右侧

  • bottom:表示图例放在监控视图底部

legend_values

Array of strings

参数解释

当前时序数据需要在图例中展示的统计值名称列表

thresholds

Array of ThresholdInfoResp objects

参数解释

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

is_all_compare_enable

Boolean

参数解释

同比环比总开关是否生效

取值范围

  • true:生效

  • false:不生效
表8 ThresholdInfoResp

参数

参数类型

描述

threshold

Number

参数解释

监控视图辅助线的阈值

取值范围

最小值为0，最大值为2147483647

threshold_color

String

参数解释

监控视图辅助线的颜色

取值范围

  • "#B50E65":紫色

  • "#F23030":红色

  • "#FF8800":橙色

  • "#F2E70C":黄色
表9 location

参数

参数类型

描述

top

Integer

参数解释

监控视图的上坐标

取值范围

最小值为0，最大值为2147483647

left

Integer

参数解释

监控视图的左坐标

取值范围

最小值为0，最大值为9

width

Integer

参数解释

监控视图图表宽度

取值范围

最小值为3，最大值为12

height

Integer

参数解释

监控视图图表高度

取值范围

最小值为3，最大值为2147483647

状态码：400

表10 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

状态码：401

表11 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

状态码：500

表12 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

请求示例

无

响应示例

状态码：200

OK

{
  "widget_id" : "wg1234567890123456789012",
  "metrics" : [ {
    "namespace" : "SYS.ECS",
    "dimensions" : {
      "name" : "instance_id",
      "filter_type" : "all_instances"
    },
    "metric_name" : "cpu_util",
    "alias" : [ "cpuutilalias" ],
    "extra_info" : {
      "origin_metric_name" : "cpu_util",
      "metric_prefix" : "cpu",
      "metric_type" : "type",
      "custom_proc_name" : "app.sh"
    }
  } ],
  "view" : "bar",
  "metric_display_mode" : "single",
  "threshold" : 0.7,
  "threshold_enabled" : true,
  "title" : "widget_title",
  "properties" : {
    "filter" : "topN",
    "topN" : 100,
    "order" : "desc",
    "description" : "简单的示例",
    "last_week_compare_enable" : false,
    "yesterday_compare_enable" : false,
    "legend_location" : "right",
    "legend_values" : [ "max", "min" ],
    "thresholds" : [ {
      "threshold" : 90,
      "threshold_color" : "#F23030"
    } ]
  },
  "location" : {
    "left" : 0,
    "top" : 0,
    "width" : 4,
    "height" : 3
  },
  "unit" : "%",
  "create_time" : 1111111111111
}

状态码

状态码

描述

200

OK

400

Bad Request, 请求错误

401

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

500

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

错误码

请参见错误码。

父主题： 监控视图