ListDashboard - - Alibaba Cloud Documentation Center

Queries a list of dashboards.

Operation description

Usage notes

Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.
An AccessKey pair is created and obtained. For more information, see AccessKey pair.

The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a RAM user to call API operations or perform routine O&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see Create a RAM user and authorize the RAM user to access Simple Log Service.

The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see Manage a project.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

GET /dashboards

Request parameters

Parameter	Type	Required	Description	Example
project	string	Yes	The name of the project.	ali-test-project
offset	integer	No	The line from which the query starts. Default value: 0.	0
size	integer	No	The number of entries per page. Maximum value: 500. Default value: 500.	10

Response parameters

Parameter	Type	Description	Example
headers	object
Server	string	The name of the server.	nginx
Content-Type	string	The format of the response body.	application/json
Content-Length	string	The length of the response body.	0
Connection	string	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.	close
Date	string	The time when the response was returned.	Sun, 27 May 2018 08:25:04 GMT
x-log-requestid	string	The request ID.	5B0A6B60BB6EE39764D458B5
	object	The details of the dashboards.
dashboards	array	The queried dashboards. Each dashboard in the array is specified by dashboardName.
	string	The queried dashboards. Each dashboard in the array is specified by dashboardName.	dashboard-1609294922657-434834
dashboardItems	array<object>	The details of the dashboard.
	object
dashboardName	string	The dashboard ID. The ID must be unique in a project. Fuzzy search is supported. For example, if you enter da, all dashboards whose IDs start with da are queried.	dashboard-1609294922657-434834
displayName	string	The display name of the dashboard.	data-ingest

Examples

Sample success responses

JSONformat

{
  "dashboards": [
    "dashboard-1609294922657-434834"
  ],
  "dashboardItems": [
    {
      "dashboardName": "dashboard-1609294922657-434834",
      "displayName": "data-ingest"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.