本文导读

功能介绍
接口约束
调试
URI
请求参数
响应参数
请求示例
响应示例
状态码
错误码

展开导读

文档首页/ 云监控服务 CES/ API参考/ API V2/ 监控视图/ 查询指定监控视图信息

查询指定监控视图信息

更新时间：2024-12-26 GMT+08:00

查看PDF

功能介绍

查询指定监控视图信息

接口约束

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

调试

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

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	租户id 最小长度：1 最大长度：64
widget_id	是	String	监控视图id 正则匹配：^wg([a-z]\|[A-Z]\|[0-9]){22}$

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
Content-Type	是	String	发送的实体的MIME类型。推荐用户默认使用application/json 缺省值：application/json;charset=UTF-8 最小长度：1 最大长度：64
X-Auth-Token	是	String	用户Token。用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。最小长度：1 最大长度：16000

响应参数

状态码： 200

表3 响应Body参数
参数	参数类型	描述
widget_id	String	视图id 正则匹配：^wg([a-z]\|[A-Z]\|[0-9]){22}$
metrics	Array of WidgetMetric objects	指标列表数组长度：1 - 200
title	String	监控视图标题最小长度：1 最大长度：128 正则匹配：^([\u4E00-\u9FFF]\|[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

表4 WidgetMetric
参数	参数类型	描述
namespace	String	服务维度最小长度：3 最大长度：32 正则匹配：^([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	指标名称最小长度：1 最大长度：96 正则匹配：^([A-Za-z]){1}([0-9A-Za-z]\|_\|-)*$
alias	Array of strings	监控视图的指标别名列表最小长度：1 最大长度：128 数组长度：0 - 200
extra_info	ExtraInfo object	指标信息

表5 DimensionInfo
参数	参数类型	描述
name	String	维度名称，多维度用逗号分隔，各服务支持的维度可参考：“服务维度名称” 最小长度：1 最大长度：131 正则匹配：^([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	维度值列表最小长度：1 最大长度：1024 数组长度：0 - 200

表6 ExtraInfo
参数	参数类型	描述
origin_metric_name	String	指标名称最小长度：1 最大长度：4096 正则匹配：^([a-z]\|[A-Z]\|[0-9]\|_\|-\|~\|\.\|/\|:)*$
metric_prefix	String	指标名称前缀最小长度：1 最大长度：4096 正则匹配：^([a-z]\|[A-Z]\|[0-9]\|_\|-\|~\|\.\|/\|:)*$
metric_type	String	指标类型最小长度：1 最大长度：32 正则匹配：^([a-z]\|[A-Z]\|[0-9]\|_\|-\|~\|\.\|/\|:)*$
custom_proc_name	String	自定义进程名称最小长度：1 最大长度：250

表7 properties
参数	参数类型	描述
filter	String	聚合类型，目前只有TopN这一种类型，折线图不支持该参数枚举值： topN
topN	Integer	Top前N个；折线图时为随机展示的时序数据条数最小值：1 最大值：2147483647 缺省值：100
order	String	排序字段，asc正序，desc倒序，折线图不支持该参数枚举值： asc desc

表8 location
参数	参数类型	描述
top	Integer	监控视图的上坐标最小值：0 最大值：2147483647
left	Integer	监控视图的左坐标最小值：0 最大值：9
width	Integer	监控视图图表宽度最小值：3 最大值：12
height	Integer	监控视图图表高度最小值：3 最大值：2147483647

状态码： 400

表9 响应Body参数
参数	参数类型	描述
error_code	String	请求异常内部业务状态码最小长度：0 最大长度：256
error_msg	String	请求异常信息最小长度：0 最大长度：256
request_id	String	请求ID 最小长度：0 最大长度：256

状态码： 401

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	请求异常内部业务状态码最小长度：0 最大长度：256
error_msg	String	请求异常信息最小长度：0 最大长度：256
request_id	String	请求ID 最小长度：0 最大长度：256

状态码： 500

**表11** 响应Body参数
参数	参数类型	描述
error_code	String	请求异常内部业务状态码最小长度：0 最大长度：256
error_msg	String	请求异常信息最小长度：0 最大长度：256
request_id	String	请求ID 最小长度：0 最大长度：256

请求示例

无

响应示例

状态码： 200

{
  "widget_id" : "wg1234567890123456789012",
  "metrics" : [ {
    "namespace" : "SYS.ECS",
    "dimensions" : {
      "name" : "instance_id",
      "filter_type" : "specific_instances",
      "values" : [ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" ]
    },
    "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" : "view",
  "metric_display_mode" : "single",
  "threshold" : 0.7,
  "threshold_enabled" : true,
  "title" : "widget_title",
  "properties" : {
    "filter" : "topN",
    "topN" : 100,
    "order" : "desc"
  },
  "location" : {
    "left" : 0,
    "top" : 0,
    "width" : 4,
    "height" : 3
  },
  "unit" : "%",
  "create_time" : 1111111111111
}

状态码


状态码	描述
200	OK
400	Bad Request, 请求错误
401	Unauthorized, 未提供认证信息，或认证信息错误
500	Internal Server Error, 请求未完成, 服务异常

错误码

请参见错误码。

父主题： 监控视图

上一篇：查询指定监控看板下的监控视图列表

下一篇：删除指定监控视图

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

查询指定监控视图信息

功能介绍

接口约束

调试

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

意见反馈

文档内容是否对您有帮助？

文档反馈