ListDashboards - 获取集群的大盘列表 - 可观测监控 Prometheus 版

获取集群的Grafana大盘的列表。

接口说明

暂无。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
arms:ListDashboards	none	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。	cn-hangzhou
ClusterId	string	是	阿里云容器服务 Kubernetes 版的 Kubernetes 集群的 ID。	cc7a37ee31aea4ed1a059eff8034b****
ClusterType	string	否	集群类型，包括：ACK、ASK、cloud-product-prometheus 和 Node。虚拟集群可通过集群类型查询大盘列表。InfluxDB 类云产品统一传`cloud-product-prometheus`。	Node
Language	string	否	指定返回的 Grafana 大盘的语言，参数值包括 en 、 zh ，默认值为 en。	en
Title	string	否	指定大盘标题。大盘标题可能会修改，建议使用 DashboardName 查询。	ApiServer
Product	string	否	云产品 Code，可选。当`clusterType=cloud-product-prometheus`时该字段必传。目前已经接入的云产品有：SAE、MSE、RocketMQ、Lindorm、Kafka、Clickhouse、DLA、消息队列 RabbitMQ 版、云数据库 MongoDB 版、时序数据库 InfluxDB、MSE 服务-云原生网关、Grafana 服务、分布式调度平台 SchedulerX、MSE 服务-全局事务、企业级分布式应用服务 EDAS、机器学习平台 PAI-EAS、应用高可用服务 AHAS、性能测试 PTS。	xxxx
RecreateSwitch	boolean	否	创建或者查询虚拟集群开关参数，可以对老数据兼容控制。	false
DashboardName	string	否	大盘唯一名称，可筛选查询指定名称的大盘。相对于 Title 参数，Title 可能会发生变化，name 不会。并且支持指定多个 name，以半角逗号（,）分隔，例如：`k8s-event,k8s-overview`。同一个大盘名称会有多个版本，如果要指定版本，可以在 name 后面增加版本信息，例如：`k8s-event:v1,k8s-overview:latest`。	k8s-node-overview

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	2A0CEDF1-06FE-44AC-8E21-21A5BE65****
DashboardVos	array<object>	Grafana 大盘信息。
DashboardVos	object	grafana 大盘信息。
Type	string	Grafana 大盘类型，包括： `dash-db`：大盘 `dash-folder`：文件夹（可包含大盘）	dash-db
Time	string	Grafana 大盘创建时间的时间戳。单位：秒	1590136924
NeedUpdate	boolean	大盘是否有新版本可以升级。	false
Kind	string	大盘种类，为 BASIC（基础类型）、THIRD（第三方）、LIMIT（限时免费）、CUSTOM（自定义）的其中一种。	BASIC
Language	string	Grafana 大盘使用的语言。	en
Url	string	Grafana 大盘的完整 URL。	http://g.console.aliyun.com/d/1131971649496228-***-59/ApiServer?orgId=3&refresh=60s
HttpsUrl	string	Grafana 大盘 URL。	http://g.console.aliyun.com/d/1131971649496228-***-59/ApiServer?orgId=3&refresh=60s
DashboardType	string	大盘类型，作用与 Exporter 一致，但是字段含义更明确。	Node
Exporter	string	Exporter 接入源的类型，包括： Prometheus Node GPU Redis MySQL Kafka Nginx（v2） Nginx ZooKeeper MongoDB RabbitMQ PostgreSQL Kubernetes Client Library Elasticsearch RocketMQ	Nginx
Version	string	大盘版本，与 Name 形成唯一键，确定一个大盘。	v2
IsArmsExporter	boolean	是否属于 ARMS 提供的 Exporter： `true`：是 ARMS 提供的 Exporter。 `false`：不是 ARMS 提供的 Exporter。	false
HttpUrl	string	Grafana 大盘的 URL。	http://g.console.aliyun.com/d/1131971649496228-***-59/ApiServer?orgId=3&refresh=60s
Title	string	Grafana 大盘标题。	ApiServer
Name	string	大盘名称，与 Title 不同，不会修改。	k8s-node-overview
Id	string	Grafana 大盘 ID，仅在安装 Grafana 大盘时是唯一的。	1100**
Uid	string	安装多个 Grafana 大盘时的大盘唯一标识符，是展示在页面上的唯一业务 ID。	1131971649496228-*****-59
Tags	array	Grafana 大盘标签。
Tags	string	Grafana 大盘标签。	["arms-k8s","ccc8ce1fe0c9543629e39ee657e34****"]
I18nChild	object	Grafana 大盘信息。
Type	string	Grafana 大盘类型，包括： `dash-db`：大盘 `dash-folder`：文件夹（可包含大盘）	dash-db
Time	string	Grafana 大盘创建时间的时间戳。	1590136924
NeedUpdate	boolean	大盘是否有新版本可以升级。	false
Kind	string	大盘种类，为 basic、third、limit、custom 的其中一种。	BASIC
Language	string	Grafana 大盘使用的语言。	zh
Url	string	Grafana 大盘的完整 URL。	http://g.console.aliyun.com/d/1131971649496228-***-59/ApiServer?orgId=3&refresh=60s
HttpsUrl	string	Grafana 大盘的 URL。	http://g.console.aliyun.com/d/1131971649496228-***-59/ApiServer?orgId=3&refresh=60s
DashboardType	string	大盘类型，作用与 Exporter 一致，但是字段含义更明确。	Node
Exporter	string	Exporter 接入源的类型，包括： Prometheus Node GPU Redis MySQL Kafka Nginx（v2） Nginx ZooKeeper MongoDB RabbitMQ PostgreSQL Kubernetes Client Library Elasticsearch RocketMQ	Nginx
Version	string	大盘版本，与 Name 形成唯一键，确定一个大盘。	v2
IsArmsExporter	boolean	是否属于 ARMS 提供的 Exporter： `true`：是 ARMS 提供的 Exporter。 `false`：不是 ARMS 提供的 Exporter。	false
HttpUrl	string	Grafana 大盘的 URL。	http://g.console.aliyun.com/d/1131971649496228-***-59/ApiServer?orgId=3&refresh=60s
Title	string	Grafana 大盘标题。	ApiServer
Name	string	大盘名称，与 Title 不同，不会修改。	k8s-node-overview
Id	string	Grafana 大盘 ID，仅在安装 Grafana 大盘时是唯一的。	1100**
Uid	string	安装多个 Grafana 大盘时的大盘唯一标识符，是展示在页面上的唯一业务 ID。	1131971649496228-*****-59
Tags	array	Grafana 大盘标签。
Tags	string	Grafana 大盘标签。	["arms-k8s","ccc8ce1fe0c9543629e39ee657e34****"]
PrometheusServiceOpened	string	是否开通 Prometheus 服务。	true
EnvironmentId	string	环境 ID。	env-ebd54733482581fc8c4237******
GrafanaServiceOpened	string	是否开通 Grafana 服务。	true

示例

正常返回示例

JSON格式

{
  "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"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-04-02	OpenAPI 返回结构发生变更	查看变更详情
2023-12-14	OpenAPI 返回结构发生变更	查看变更详情
2023-08-30	OpenAPI 返回结构发生变更	查看变更详情
2021-11-25	OpenAPI 入参发生变更	查看变更详情