Querying Dashboards

Updated on 2025-02-27 GMT+08:00

View PDF

Function

This API is used to query dashboards.

Constraints

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

URI

GET /v2/{project_id}/dashboards

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Tenant ID. Minimum: 1 Maximum: 64

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_id	No	String	Enterprise project ID. Regex Pattern: ^((([a-z]\|[0-9]){8}-([a-z]\|[0-9]){4}-([a-z]\|[0-9]){4}-([a-z]\|[0-9]){4}-([a-z]\|[0-9]){12})\|0\|all_granted_eps)$
is_favorite	No	Boolean	Whether a dashboard in an enterprise project is added to favorites. The value can be true (added to favorites) and false (not added to favorites). If this parameter is specified, enterprise_id is mandatory.
dashboard_name	No	String	Dashboard name. Minimum: 1 Maximum: 128 Regex Pattern: ^([\u4E00-\u9FFF]\|[a-z]\|[A-Z]\|[0-9]\|_\|-)+$
dashboard_id	No	String	Dashboard ID. Regex Pattern: ^db([a-z]\|[A-Z]\|[0-9]){22}

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
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

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
dashboards	Array of DashBoardInfo objects	Dashboard list. Array Length: 0 - 10

**Table 5** DashBoardInfo
Parameter	Type	Description
dashboard_id	String	Dashboard ID. Regex Pattern: ^db([a-z]\|[A-Z]\|[0-9]){22}
dashboard_name	String	Custom name of the dashboard. Minimum: 1 Maximum: 128 Regex Pattern: ^([\u4E00-\u9FFF]\|[a-z]\|[A-Z]\|[0-9]\|_\|-)+$
enterprise_id	String	Enterprise project ID. Regex Pattern: ^((([a-z]\|[0-9]){8}-([a-z]\|[0-9]){4}-([a-z]\|[0-9]){4}-([a-z]\|[0-9]){4}-([a-z]\|[0-9]){12})\|0)$
creator_name	String	Name of the user who created the dashboard. Minimum: 1 Maximum: 128 Regex Pattern: ^([\u4E00-\u9FFF]\|[a-z]\|[A-Z]\|[0-9]\|_\|-)+$
create_time	Long	Dashboard creation time. Minimum: 1111111111111 Maximum: 9999999999999
row_widget_num	Integer	How a graph is displayed. 0 indicates that you can customize top and left of the graph. 1 indicates one graph per row. Minimum: 0 Maximum: 3 Default: 3
is_favorite	Boolean	Whether a dashboard is added to favorites. The value can be true or false.

Status code: 400

**Table 6** 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 7** 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 8** 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

None

Example Responses

Status code: 200

{
  "dashboards" : [ {
    "dashboard_id" : "dbxxxxxxxxxxxxxxxxxxxxxx",
    "dashboard_name" : "dashboard_name",
    "enterprise_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "creator_name" : "creator_name",
    "create_time" : 1111111111111,
    "row_widget_num" : 3,
    "is_favorite" : false
  } ]
}

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.