批量更新监控视图
功能介绍
批量更新监控视图
接口约束
目前华东-青岛、拉美-墨西哥城一、土耳其-伊斯坦布尔、亚太-雅加达、中东-利雅得5个局点不支持该接口
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v2/{project_id}/widgets/batch-update
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户id 最小长度:1 最大长度:64 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
[数组元素] |
是 |
Array of UpdateWidgetInfo objects |
批量更新监控视图请求体 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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面积图 枚举值:
|
metric_display_mode |
否 |
String |
指标展示类型,single 单指标展示,multiple 多指标展示 枚举值:
|
properties |
否 |
properties object |
视图展示配置 |
location |
否 |
location object |
监控视图图表坐标 |
unit |
否 |
String |
单位 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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 |
指标信息 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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: 指定资源 枚举值:
|
values |
否 |
Array of strings |
维度值列表 最小长度:1 最大长度:1024 数组长度:0 - 200 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
widgets |
Array of BatchUpdateWidgetInfo objects |
更新结果列表 数组长度:1 - 50 |
参数 |
参数类型 |
描述 |
---|---|---|
widget_id |
String |
视图id 正则匹配:^wg([a-z]|[A-Z]|[0-9]){22}$ |
ret_status |
String |
修改结果;成功: successful, 失败: error 枚举值:
|
error_msg |
String |
如果失败则返回失败信息 最小长度:1 最大长度:2048 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
请求异常内部业务状态码 最小长度:0 最大长度:256 |
error_msg |
String |
请求异常信息 最小长度:0 最大长度:256 |
request_id |
String |
请求ID 最小长度:0 最大长度:256 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
请求异常内部业务状态码 最小长度:0 最大长度:256 |
error_msg |
String |
请求异常信息 最小长度:0 最大长度:256 |
request_id |
String |
请求ID 最小长度:0 最大长度:256 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
请求异常内部业务状态码 最小长度:0 最大长度:256 |
error_msg |
String |
请求异常信息 最小长度:0 最大长度:256 |
request_id |
String |
请求ID 最小长度:0 最大长度:256 |
请求示例
[ { "widget_id" : "wgXXXXXXXXXXXXXXXXXXXXXX", "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" : 500, "threshold_enabled" : false, "title" : "widget_title_new", "properties" : { "filter" : "topN", "topN" : 10, "order" : "asc" }, "location" : { "left" : 0, "top" : 3, "width" : 4, "height" : 3 }, "unit" : "%" } ]
响应示例
状态码: 200
OK
{ "widgets" : [ { "widget_id" : "wgXXXXXXXXXXXXXXXXXXXXXX", "ret_status" : "successful" }, { "widget_id" : "wg9876543210123456789012", "ret_status" : "error", "error_msg" : "record not found" } ] }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request, 请求错误 |
401 |
Unauthorized, 未提供认证信息,或认证信息错误 |
500 |
Internal Server Error, 请求未完成, 服务异常 |
错误码
请参见错误码。