Help Center/ Cloud Eye/ API Reference/ API V2/ Graphs/ This API is used to create, copy, or batch create graphs on a dashboard.

Updated on 2024-12-26 GMT+08:00

View PDF

This API is used to create, copy, or batch create graphs on a dashboard.

Function

Constraints

This API is not supported in the following five sites: CN East-Qingdao, LA-Mexico City1, TR-Istanbul, AP-Jakarta, and 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}/dashboards/{dashboard_id}/widgets

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Tenant ID. Minimum: 1 Maximum: 64
dashboard_id	Yes	String	Dashboard ID, which starts with db and follows 22 letters and digits. Example: db16564943172807wjOmoLyn Array Length: 24 - 24 Regex Pattern: ^db([a-z]\|[A-Z]\|[0-9]){22}$

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	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	User token. It is a response to the API used to obtain 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 value. Minimum: 1 Maximum: 16000

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
[items]	No	Array of BaseWidgetInfo objects	Graph information.

**Table 4** BaseWidgetInfo
Parameter	Mandatory	Type	Description
metrics	Yes	Array of WidgetMetric objects	Metric list. Array Length: 1 - 200
title	Yes	String	Graph name. Minimum: 1 Maximum: 128 Regex Pattern: ^([\u4E00-\u9FFF]\|[a-z]\|[A-Z]\|[0-9]\|_\|-\|:\|;\|$\|$\|\.\|~\|（\|）)+$
threshold	No	Double	Threshold of metrics on the graph. Minimum: 0 Maximum: 1.7976931348623157E308
threshold_enabled	Yes	Boolean	Whether to display thresholds of metrics. The value can be true (to display) and false (not to display).
view	Yes	String	Monitoring view chart type. The options are bar, line, bar_chart, table, circular_bar, and area_chart. Enumeration values: bar line bar_chart table circular_bar area_chart
metric_display_mode	Yes	String	Metric display mode. The value can be single or multiple. Enumeration values: single multiple
properties	No	properties object	Additional information.
location	Yes	location object	Graph coordinates.
unit	No	String	Unit.

**Table 5** WidgetMetric
Parameter	Mandatory	Type	Description
namespace	Yes	String	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	Dimension list.
metric_name	Yes	String	Metric name. Minimum: 1 Maximum: 96 Regex Pattern: ^([A-Za-z]){1}([0-9A-Za-z]\|_\|-)*$
alias	No	Array of strings	Alias list of metrics on the graph. Minimum: 1 Maximum: 128 Array Length: 0 - 200
extra_info	No	ExtraInfo object	Metric information.

**Table 6** DimensionInfo
Parameter	Mandatory	Type	Description
name	Yes	String	Dimension name. Use commas (,) to separate multiple dimensions. For details about the dimensions supported by each cloud service, see Services Interconnected with Cloud Eye. 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	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	Dimension value list. Minimum: 1 Maximum: 1024 Array Length: 0 - 200

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

**Table 8** properties
Parameter	Mandatory	Type	Description
filter	No	String	Aggregation type. Currently, the value can only be TopN. A line chart does not support this parameter. Enumeration values: topN
topN	No	Integer	Top N values. In the line chart, this parameter indicates the number of time series data records that are randomly displayed. Minimum: 1 Maximum: 2147483647 Default: 100
order	No	String	Sorting field. The value can be asc (ascending order) or desc (descending order). A line chart does not support this parameter. Enumeration values: asc desc

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

Response Parameters

Status code: 200

**Table 10** Response body parameters
Parameter	Type	Description
widget_ids	Array of strings	Response body for creating graphs in batches. Array Length: 1 - 50

Status code: 400

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

Status code: 401

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

Status code: 500

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

Example Requests

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

Example Responses

Status code: 200

{
  "widget_ids" : [ "wgx234567890123456789012" ]
}

Status Codes

Status Code	Description
200	OK
400	The server failed to process the request.
401	Token authentication is required.
500	Failed to complete the request because of an internal server error.