Modifying a Dashboard

Function

This API is used to modify a dashboard.

Constraints

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

Debugging

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

URI

PUT /v2/{project_id}/dashboards/{dashboard_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Tenant ID. Constraints: None Value range: Project ID, used to specify the project that an asset belongs to. You can query the assets of a project by project ID. You can obtain the project ID by calling an API or on the console. For details, see Obtaining a Project ID. The value must contain of 1 to 64 characters. Default value: None
dashboard_id	Yes	String	Dashboard ID, which starts with db and follows 22 letters and digits. Example: db16564943172807wjOmoLyn. Regex Pattern: ^db([a-z]\|[A-Z]\|[0-9]){22}$

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	No	String	Definition MIME type of the request body. Constraints: None Value range: The value can contain 1 to 64 characters. Default value: The default type is application/json; charset=UTF-8. Default value: application/json; charset=UTF-8
X-Auth-Token	No	String	Definition User token. Constraints: None Value range: The value can contain 1 to 16,384 characters. Default value: None

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
dashboard_name	No	String	Custom dashboard name. Regex Pattern: ^([\u4E00-\u9FFF]\|[a-z]\|[A-Z]\|[0-9]\|_\|-)+$
is_favorite	No	Boolean	Whether a dashboard is added to favorites. The value can be true or false.
row_widget_num	Yes	Integer	How a graph is displayed. 0 indicates that you can customize top and left of the graph. 1 indicates one graph per row. Value range: 0-4 Default value: 3
extend_info	No	ExtendInfo object	Extended information about the dashboard.

**Table 4** ExtendInfo
Parameter	Mandatory	Type	Description
filter	No	String	Metric aggregation mode. The value can be average, min, max, or sum. Enumeration values: average min max sum
period	No	String	Metric rollup period. {1 indicates the original value, 60 indicates one minute, 300 indicates five minutes, 1200 indicates 20 minutes, 3600 indicates one hour, 14400 indicates four hours, and 86400 indicates one day.} Regex Pattern: ^(1\|60\|300\|1200\|3600\|14400\|86400)$
display_time	No	Integer	Display time. The value 0 indicates that you can customize a time. The value can be 5 minutes, 15 minutes, 30 minutes, 1 hour, 2 hours, 3 hours, 12 hours, 1 day, 7 days, or 30 days. Enumeration values: 0 5 15 30 60 120 180 720 1440 10080 43200
refresh_time	No	Integer	Refresh interval. The value can be 0 (not refreshed), 10s, 1 min, 5 mins, or 20 mins. Enumeration values: 0 10 60 300 1200
from	No	Long	Start time. Value range: 0-9999999999999
to	No	Long	End time. Value range: 0-9999999999999
screen_color	No	String	Background color of the dashboard.
enable_screen_auto_play	No	Boolean	Whether the monitoring dashboard can be automatically switched.
time_interval	No	Integer	Auto-switch interval for dashboard. The value can be 10000 (10s), 30000 (30s), and 60000 (1 min). Enumeration values: 10000 30000 60000
enable_legend	No	Boolean	Whether to display the legend.
full_screen_widget_num	No	Integer	Number of graphs displayed on the dashboard. The value must be consistent with an available one on the console. Value range: 0-65535

Response Parameters

Status code: 204

No Content

Status code: 400

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

Status code: 401

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

Status code: 500

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

Example Requests

{
  "dashboard_name" : "dashboard_name_new",
  "is_favorite" : true,
  "row_widget_num" : 0
}

Example Responses

None

Status Codes

Status Code	Description
204	No Content
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.