ListDashboards - 擷取叢集的大盤列表 - Application Real-Time Monitoring Service

擷取叢集的Grafana大盤的列表。

介面說明

暫無。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	否	地區 ID。	cn-hangzhou
ClusterId	string	否	阿里雲Container Service 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 版、ApsaraDB for MongoDB、時序資料庫 InfluxDB、MSE 服務-雲原生網關、Grafana 服務、分布式調度平台 SchedulerX、MSE 服務-全域事務、Enterprise Distributed Application Service、Machine Learning Platform for AI-EAS、應用高可用服務 AHAS、Performance Testing Service。	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 大盤資訊。
	array<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://gnew.console.alibabacloud.com/d/1131971649496228-***-59/ApiServer?orgId=3&refresh=60s
HttpsUrl	string	Grafana 大盤 URL。	http://gnew.console.alibabacloud.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://gnew.console.alibabacloud.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 大盤標籤。
	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://gnew.console.alibabacloud.com/d/1131971649496228-***-59/ApiServer?orgId=3&refresh=60s
HttpsUrl	string	Grafana 大盤的 URL。	http://gnew.console.alibabacloud.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://gnew.console.alibabacloud.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 大盤標籤。
	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://gnew.console.alibabacloud.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s",
      "HttpsUrl": "http://gnew.console.alibabacloud.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s",
      "DashboardType": "Node",
      "Exporter": "Nginx",
      "Version": "v2",
      "IsArmsExporter": false,
      "HttpUrl": "http://gnew.console.alibabacloud.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://gnew.console.alibabacloud.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s",
        "HttpsUrl": "http://gnew.console.alibabacloud.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s",
        "DashboardType": "Node",
        "Exporter": "Nginx",
        "Version": "v2",
        "IsArmsExporter": false,
        "HttpUrl": "http://gnew.console.alibabacloud.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"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。