ListDashboards - Managed Service for Prometheus - Alibaba Cloud Documentation Center

Queries the Grafana dashboards of a Container Service for Kubernetes (ACK) cluster.

Operation description

None.

Debugging

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

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
arms:ListDashboards	Write	Prometheus acs:arms:{#regionId}:{#accountId}:prometheus/*	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
ClusterId	string	Yes	The ID of the ACK cluster.	cc7a37ee31aea4ed1a059eff8034b****
ClusterType	string	No	Valid values: ACK, ASK, cloud-product-prometheus, and Node. You can query the dashboards of a virtual cluster by specifying the cluster type. For InfluxDB, set this parameter to `cloud-product-prometheus`.	Node
Language	string	No	The language of the returned Grafana dashboard. Valid values: en and zh. Default value: en.	en
Title	string	No	The dashboard title. The dashboard title can be changed. We recommend that you specify the DashboardName parameter.	ApiServer
Product	string	No	The cloud service code. This parameter is required if you set the ClusterType parameter to `cloud-product-prometheus`. The following cloud services are available: Serverless App Engine, Microservices Engine, Message Queue for Apache RocketMQ, Lindorm, Message Queue for Apache Kafka, ApsaraDB for ClickHouse, Data Lake Analytics, Message Queue for RabbitMQ, ApsaraDB for MongoDB, Time Series Database (TSDB) for InfluxDB, MSE Cloud-native Gateway, Grafana Service, SchedulerX, Global Transaction Service, Enterprise Distributed Application Service, Machine Learning Platform for AI - Elastic Algorithm Service (EAS), Application High Availability Service, and Performance Testing.	xxxx
RecreateSwitch	boolean	No	Specifies whether to create or query a virtual cluster. This parameter provides backward compatibility.	false
DashboardName	string	No	The unique names of the dashboards. You can query dashboards by specifying their names. The dashboard title can be changed whereas the dashboard name cannot. You can specify multiple names and separate them with commas (,), for example, `k8s-event,k8s-overview`. A dashboard may have multiple versions. If you want to specify a version, you can add version information after the name, for example, `k8s-event:v1,k8s-overview:latest`.	k8s-node-overview

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	2A0CEDF1-06FE-44AC-8E21-21A5BE65****
DashboardVos	object []	The information about the Grafana dashboard.
Type	string	The type of the Grafana dashboard. Valid values: `dash-db`: a dashboard `dash-folder`: a folder that can include a dashboard	dash-db
Time	string	The timestamp generated when the Grafana dashboard was created. Unit: seconds	1590136924
NeedUpdate	boolean	Indicates whether the Grafana dashboard has a new version that was available for upgrade.	false
Kind	string	The type of the dashboard. Valid values: BASIC, THIRD, LIMIT, and CUSTOM. BASIC indicates a basic dashboard. THIRD indicates a third-party dashboard. LIMIT indicates a time-limited free dashboard. CUSTOM indicates a custom dashboard.	BASIC
Language	string	The language of the Grafana dashboard.	en
Url	string	The complete URL of the Grafana dashboard.	http://g.console.aliyun.com/d/1131971649496228-***-59/ApiServer?orgId=3&refresh=60s
HttpsUrl	string	The URL of the Grafana dashboard.	http://g.console.aliyun.com/d/1131971649496228-***-59/ApiServer?orgId=3&refresh=60s
DashboardType	string	The type of the Grafana dashboard. This parameter has the same effect as the Exporter parameter whereas provides clearer implication.	Node
Exporter	string	The type of the exporter access source. Valid values: Prometheus Node GPU Redis MySQL Kafka NGINX V2 Nginx ZooKeeper MongoDB RabbitMQ PostgreSQL Kubernetes Client Library Elasticsearch RocketMQ	Nginx
Version	string	The version of the Grafana dashboard. The combination of version and name uniquely identifies a dashboard.	v2
IsArmsExporter	boolean	Indicates whether the exporter was provided by ARMS. Valid values: `true`: The exporter is provided by ARMS. `false`: The exporter is not provided by ARMS.	false
HttpUrl	string	The URL of the Grafana dashboard.	http://g.console.aliyun.com/d/1131971649496228-***-59/ApiServer?orgId=3&refresh=60s
Title	string	The title of the Grafana dashboard.	ApiServer
Name	string	The name of the Grafana dashboard. This parameter is different from the Title parameter as this parameter cannot be changed.	k8s-node-overview
Id	string	The ID of the Grafana dashboard. The value is unique only when you install the Grafana dashboard.	1100**
Uid	string	The unique identifier of a dashboard when multiple Grafana dashboards were installed. It is a unique business ID displayed on the page.	1131971649496228-*****-59
Tags	array	The tags of the Grafana dashboard.
	string	The tag of the Grafana dashboard.	["arms-k8s","ccc8ce1fe0c9543629e39ee657e34****"]
I18nChild	object	The information about the Grafana dashboards.
Type	string	The type of the Grafana dashboard. Valid values: `dash-db`: a dashboard `dash-folder`: a folder that can include a dashboard	dash-db
Time	string	The timestamp when the Grafana dashboard was created.	1590136924
NeedUpdate	boolean	Indicates whether the Grafana dashboard has a new version that was available for upgrade.	false
Kind	string	The category of the Grafana dashboard. Valid values: BASIC, THIRD, LIMIT, and CUSTOM.	BASIC
Language	string	The language of the Grafana dashboard.	zh
Url	string	The complete URL of the Grafana dashboard.	http://g.console.aliyun.com/d/1131971649496228-***-59/ApiServer?orgId=3&refresh=60s
HttpsUrl	string	The URL of the Grafana dashboard.	http://g.console.aliyun.com/d/1131971649496228-***-59/ApiServer?orgId=3&refresh=60s
DashboardType	string	The type of the Grafana dashboard. This parameter has the same effect as the Exporter parameter whereas provides clearer implication.	Node
Exporter	string	The type of the exporter access source. Valid values: Prometheus Node GPU Redis MySQL Kafka NGINX V2 Nginx ZooKeeper MongoDB RabbitMQ PostgreSQL Kubernetes Client Library Elasticsearch RocketMQ	Nginx
Version	string	The version of the Grafana dashboard. The combination of version and name uniquely identifies a dashboard.	v2
IsArmsExporter	boolean	Indicates whether the exporter was provided by ARMS. Valid values: `true`: The exporter is provided by ARMS. `false`: The exporter is not provided by ARMS.	false
HttpUrl	string	The URL of the Grafana dashboard.	http://g.console.aliyun.com/d/1131971649496228-***-59/ApiServer?orgId=3&refresh=60s
Title	string	The title of the Grafana dashboard.	ApiServer
Name	string	The name of the Grafana dashboard. This parameter is different from the Title parameter as this parameter cannot be changed.	k8s-node-overview
Id	string	The ID of the Grafana dashboard. The value is unique only when you install the Grafana dashboard.	1100**
Uid	string	The unique identifier of a dashboard when multiple Grafana dashboards were installed. It is a unique business ID displayed on the page.	1131971649496228-*****-59
Tags	array	The tags of the Grafana dashboard.
	string	The tag of the Grafana dashboard.	["arms-k8s","ccc8ce1fe0c9543629e39ee657e34****"]
PrometheusServiceOpened	string	Whether or not to turn on Prometheus service.	true
EnvironmentId	string	The environment ID.	env-ebd54733482581fc8c4237******
GrafanaServiceOpened	string	Whether to enable Grafana service.	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "2A0CEDF1-06FE-44AC-8E21-21A5BE65****",
  "DashboardVos": [
    {
      "Type": "dash-db",
      "Time": "1590136924",
      "NeedUpdate": false,
      "Kind": "BASIC",
      "Language": "en",
      "Url": "http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s",
      "HttpsUrl": "http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s",
      "DashboardType": "Node",
      "Exporter": "Nginx",
      "Version": "v2",
      "IsArmsExporter": false,
      "HttpUrl": "http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s",
      "Title": "ApiServer",
      "Name": "k8s-node-overview",
      "Id": "1100**",
      "Uid": "1131971649496228-*****-59",
      "Tags": [
        "[\"arms-k8s\",\"ccc8ce1fe0c9543629e39ee657e34****\"]"
      ],
      "I18nChild": {
        "Type": "dash-db",
        "Time": "1590136924",
        "NeedUpdate": false,
        "Kind": "BASIC",
        "Language": "zh",
        "Url": "http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s",
        "HttpsUrl": "http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s",
        "DashboardType": "Node",
        "Exporter": "Nginx",
        "Version": "v2",
        "IsArmsExporter": false,
        "HttpUrl": "http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s",
        "Title": "ApiServer",
        "Name": "k8s-node-overview",
        "Id": "1100**",
        "Uid": "1131971649496228-*****-59",
        "Tags": [
          "[\"arms-k8s\",\"ccc8ce1fe0c9543629e39ee657e34****\"]"
        ]
      }
    }
  ],
  "PrometheusServiceOpened": "true",
  "EnvironmentId": "env-ebd54733482581fc8c4237******",
  "GrafanaServiceOpened": "true"
}

Error codes

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

Change history

Change time

Summary of changes

Operation

2024-04-02

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2023-12-14

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2023-08-30

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2021-11-25

The request parameters of the API has changed

see changesets

Change item	Change content
Input Parameters	The request parameters of the API has changed.
	delete Input Parameters: ProxyUserId