Help Center/ Cloud Eye/ API Reference/ API v2/ Graphs/ Updating Graphs in Batches

Updated on 2024-05-16 GMT+08:00

View PDF

Updating Graphs in Batches

Function

This API is used to update graphs in batches.

Constraints

This API is not supported at the following regions: CN East-Qingdao, LA-Mexico City1, TR-Istanbul, AP-Jakarta, ME-Riyadh.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

POST /v2/{project_id}/widgets/batch-update

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the tenant ID. Minimum: 1 Maximum: 64 Regex Pattern: ^[a-zA-Z0-9-]{1,64}$

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Specifies the MIME type of the request body. Default value application/json is recommended. Default: application/json;charset=UTF-8 Minimum: 1 Maximum: 64
X-Auth-Token	Yes	String	Specifies the user token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. The value of X-Subject-Token in the response header is the token. Minimum: 1 Maximum: 16000

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
[items]	Yes	Array of UpdateWidgetInfo objects	Specifies the request body for updating graphs in batches.

**Table 4** UpdateWidgetInfo
Parameter	Mandatory	Type	Description
widget_id	Yes	String	Specifies the graph ID. Regex Pattern: ^wg([a-z]\|[A-Z]\|[0-9]){22}$
metrics	No	Array of WidgetMetric objects	Specifies the metric list. Array Length: 1 - 200
title	No	String	Specifies the graph name. Minimum: 1 Maximum: 128 Regex Pattern: ^([\u4E00-\u9FFF]\|[a-z]\|[A-Z]\|[0-9]\|_\|-\|:\|;\|$\|$\|\.\|~\|（\|）)+$
threshold	No	Double	Specifies the threshold of metrics on the graph. Minimum: 0 Maximum: 1.7976931348623157E308
threshold_enabled	No	Boolean	Specifies whether to display the threshold of metrics. The value can be true (to display) or false (not to display).
view	No	String	Specifies the graph type. The value can be bar (bar chart) or line (line chart). Enumeration values: bar line
metric_display_mode	No	String	Specifies how many metrics will be displayed on one graph. The value can be single or multiple. Enumeration values: single multiple
properties	No	properties object	Specifies additional information. This parameter takes effect only when you set view to bar.
location	No	location object	Specifies the graph coordinates.
unit	No	String	Specifies the metric unit.

**Table 5** WidgetMetric
Parameter	Mandatory	Type	Description
namespace	Yes	String	Specifies the cloud service dimension. Minimum: 3 Maximum: 32 Regex Pattern: ^([a-z]\|[A-Z]){1}([a-z]\|[A-Z]\|[0-9]\|_)\.([a-z]\|[A-Z]){1}([a-z]\|[A-Z]\|[0-9]\|_)$
dimensions	Yes	DimensionInfo object	Specifies the dimension list.
metric_name	Yes	String	Specifies the metric name. Minimum: 1 Maximum: 96 Regex Pattern: ^([A-Za-z]){1}([0-9A-Za-z]\|_\|-)*$
alias	No	Array of strings	Specifies the alias list of metrics on the graph. Minimum: 1 Maximum: 128 Array Length: 0 - 200
extra_info	No	ExtraInfo object	Specifies the metric information.

**Table 6** DimensionInfo
Parameter	Mandatory	Type	Description
name	Yes	String	Specifies the dimension name. Use commas (,) to separate multiple dimensions. For details about dimensions supported by each cloud service, see "[Services Interconnected with Cloud Eye] (https://support.huaweicloud.com/intl/en-us/usermanual-ces/en-us_topic_0202622212.html)". Minimum: 1 Maximum: 131 Regex Pattern: ^([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	Yes	String	Specifies the resource type. The value can be all_instances (all resources) or specific_instances (specified resources). Enumeration values: all_instances specific_instances
values	No	Array of strings	Specifies the dimension value list. Minimum: 1 Maximum: 1024 Array Length: 0 - 200

**Table 7** ExtraInfo
Parameter	Mandatory	Type	Description
origin_metric_name	Yes	String	Specifies the metric name. Minimum: 1 Maximum: 4096 Regex Pattern: ^([a-z]\|[A-Z]\|[0-9]\|_\|-\|~\|\.\|/\|:)*$
metric_prefix	No	String	Specifies the metric name prefix. Minimum: 1 Maximum: 4096 Regex Pattern: ^([a-z]\|[A-Z]\|[0-9]\|_\|-\|~\|\.\|/\|:)*$
metric_type	No	String	Specifies the metric type. Minimum: 1 Maximum: 32 Regex Pattern: ^([a-z]\|[A-Z]\|[0-9]\|_\|-\|~\|\.\|/\|:)*$
custom_proc_name	No	String	Specifies the custom process name. Minimum: 1 Maximum: 250

**Table 8** properties
Parameter	Mandatory	Type	Description
filter	No	String	Specifies how metric data is aggregated. The value can only be TopN. Enumeration values: topN
topN	No	Integer	Specifies the top n resources sorted by a metric. Minimum: 1 Maximum: 2147483647 Default: 100
order	No	String	Specifies how top n resources by a metric are sorted on a graph. The value can be asc or desc. Enumeration values: asc desc

**Table 9** location
Parameter	Mandatory	Type	Description
top	Yes	Integer	Specifies the grids between the graph and the top of the dashboard. Minimum: 0 Maximum: 2147483647
left	Yes	Integer	Specifies the grids between the graph and the left side of the dashboard. Minimum: 0 Maximum: 9
width	Yes	Integer	Specifies the graph width. Minimum: 3 Maximum: 12
height	Yes	Integer	Specifies the graph height. Minimum: 3 Maximum: 2147483647

Response Parameters

Status code: 200

**Table 10** Response body parameters
Parameter	Type	Description
widgets	Array of BatchUpdateWidgetInfo objects	Specifies the update result list. Array Length: 1 - 50

**Table 11** BatchUpdateWidgetInfo
Parameter	Type	Description
widget_id	String	Specifies the graph ID. Regex Pattern: ^wg([a-z]\|[A-Z]\|[0-9]){22}$
ret_status	String	Specifies the update result. The value can be successful or error. Enumeration values: successful error
error_msg	String	Specifies the error message when an operation fails. Minimum: 1 Maximum: 2048

Status code: 400

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the status codes customized by each cloud service when a request error occurs. Minimum: 0 Maximum: 256
error_msg	String	Specifies the request error message. Minimum: 0 Maximum: 256
request_id	String	Specifies the request ID. Minimum: 0 Maximum: 256

Status code: 401

**Table 13** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the status codes customized by each cloud service when a request error occurs. Minimum: 0 Maximum: 256
error_msg	String	Specifies the request error message. Minimum: 0 Maximum: 256
request_id	String	Specifies the request ID. Minimum: 0 Maximum: 256

Status code: 500

**Table 14** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the status codes customized by each cloud service when a request error occurs. Minimum: 0 Maximum: 256
error_msg	String	Specifies the request error message. Minimum: 0 Maximum: 256
request_id	String	Specifies the request ID. Minimum: 0 Maximum: 256

Example Requests

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

Example Responses

Status code: 200

{
  "widgets" : [ {
    "widget_id" : "wgXXXXXXXXXXXXXXXXXXXXXX",
    "ret_status" : "successful"
  }, {
    "widget_id" : "wg9876543210123456789012",
    "ret_status" : "error",
    "error_msg" : "record not found"
  } ]
}