All Products
Document Center

Simple Log Service:UpdateDashboard

Last Updated:Oct 26, 2023

Modifies the configurations of a dashboard.

Usage notes

Host consists of a project name and a Log Service endpoint. You must specify a project in Host.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only common request headers. For more information, see Common request headers.

Request syntax

PUT /dashboards/{dashboardName} HTTP/1.1

Request parameters

Parameter Type Position Required Example Description
project String Host Yes ali-test-project

The name of the project.

dashboardName String Path Yes dashboard-1609294922657-434834

The name of the dashboard.

Object Body No

The data structure of the dashboard.

dashboardName String Body Yes dashboard-1609294922657-434834

The name of the dashboard.

displayName String Body Yes Method pv

The display name of the dashboard.

description String Body No test dashboard.

The description of the dashboard.

attribute Map Body No ""

The attributes of the dashboard.

String Body No ""

The attribute of the dashboard.

charts Array of chart Body Yes

The charts on the dashboard.

Response parameters

Parameter Type Example Description
Server String nginx

The name of the server.

Content-Type String application/json

The type of the response body.

Content-Length String 0

The length of the response body.

Connection String close

Indicates whether the connection is persistent. Valid values:

  • close: The connection is non-persistent. A new TCP connection is established for each HTTP request.
  • keep-alive: The connection is persistent. After a TCP connection is established, the connection remains open, and no more time or bandwidth is consumed to establish new connections.
Date String Sun, 27 May 2018 08:25:04 GMT

The time when the response was returned.

x-log-requestid String 5B0A6B60BB6EE39764D458B5

The request ID.


Sample requests

PUT /dashboards/dashboard-1609294922657-434834 HTTP/1.1

  "dashboardName" : "dashboard-1609294922657-434834",
  "charts" : [ {
    "title" : "my-chart",
    "type" : "linepro"
  } ]

Sample success responses

JSON format

HTTP/1.1 200 OK

Error codes

For a list of error codes, see Service error codes.