文档首页/ 云监控服务 CES/ API参考/ API V2/ 监控视图/ 创建/复制/批量创建监控视图到指定的监控看板
更新时间：2024-10-30 GMT+08:00
查看PDF
分享

创建/复制/批量创建监控视图到指定的监控看板

功能介绍

创建/复制/批量创建监控视图到指定的监控看板

接口约束

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

调试

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

URI

POST /v2/{project_id}/dashboards/{dashboard_id}/widgets

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户id

最小长度：1

最大长度：64

dashboard_id

是

String

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

数组长度：24 - 24

正则匹配：^db([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
表3 请求Body参数

参数

是否必选

参数类型

描述

[数组元素]

否

Array of BaseWidgetInfo objects

创建单指标条形图类型监控视图到指定监控看板请求体
表4 BaseWidgetInfo

参数

是否必选

参数类型

描述

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

单位
表5 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

指标信息
表6 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
表7 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
表8 properties

参数

是否必选

参数类型

描述

filter

否

String

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

枚举值：

  • topN

topN

否

Integer

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

最小值：1

最大值：2147483647

缺省值：100

order

否

String

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

枚举值：

  • asc

  • desc
表9 location

参数

是否必选

参数类型

描述

top

是

Integer

监控视图的上坐标

最小值：0

最大值：2147483647

left

是

Integer

监控视图的左坐标

最小值：0

最大值：9

width

是

Integer

监控视图图表宽度

最小值：3

最大值：12

height

是

Integer

监控视图图表高度

最小值：3

最大值：2147483647

响应参数

状态码： 200

表10 响应Body参数

参数

参数类型

描述

widget_ids

Array of strings

批量创建监控视图返回结果

数组长度：1 - 50

状态码： 400

表11 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

最小长度：0

最大长度：256

error_msg

String

请求异常信息

最小长度：0

最大长度：256

request_id

String

请求ID

最小长度：0

最大长度：256

状态码： 401

表12 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

最小长度：0

最大长度：256

error_msg

String

请求异常信息

最小长度：0

最大长度：256

request_id

String

请求ID

最小长度：0

最大长度：256

状态码： 500

表13 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

最小长度：0

最大长度：256

error_msg

String

请求异常信息

最小长度：0

最大长度：256

request_id

String

请求ID

最小长度：0

最大长度：256

请求示例

[ {
  "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" : "%"
} ]

响应示例

状态码： 200

OK

{
  "widget_ids" : [ "wgx234567890123456789012" ]
}

状态码

状态码

描述

200

OK

400

Bad Request, 请求错误

401

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

500

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

错误码

请参见错误码。

父主题： 监控视图