ListDashboard - Simple Log Service - Alibaba Cloud Documentation Center

Queries all dashboards in a project.

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 pairs.
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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only common request headers and does not have operation-specific request headers. For more information, see Common request parameters.

Request syntax

GET /dashboards HTTP/1.1

Request parameters

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

Response parameters

Parameter	Type	Example	Description
Server	String	nginx	The name of the server.
Content-Type	String	application/json	The format 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.
dashboards	Array of String	dashboard-1609294922657-434834	The queried dashboards. Each dashboard in the array is specified by dashboardName.
dashboardItems	Array		The details of the dashboards.
dashboardName	String	dashboard-1609294922657-434834	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.
displayName	String	data-ingest	The display name of the dashboard.

Examples

Sample requests

GET /dashboards?offset=0&size=10 HTTP/1.1
Host:ali-test-project.cn-hangzhou.log.aliyuncs.com
Content-Type:application/json

Sample success responses

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

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

HttpStatusCode	ErrorCode	ErrorMessage	Description
404	ProjectNotExist	Project does not exist.	The specified project does not exist.
400	ParameterInvalid	offset: offset is invalid.	The specified value of the offset parameter is invalid.
400	ParameterInvalid	size: size is invalid.	The specified value of the size parameter is invalid.
500	InternalServerError	Specified Server Error Message.	An internal server error has occurred.

For more information, see Common error codes.