调用ListDashboards接口获取集群的Grafana大盘的列表。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListDashboards

系统规定参数。取值:ListDashboards

RegionId String cn-hangzhou

地域ID。

ClusterId String cc7a37ee31aea4ed1a059eff8034b****

阿里云容器服务Kubernetes版的Kubernetes集群的ID。

ClusterType String Node

集群类型。虚拟集群可通过集群类型查询大盘列表。

Title String ApiServer

指定大盘标题。大盘标题可能会修改,建议使用DashboardName查询。

Product String xxxx

云产品Code。

RecreateSwitch Boolean false

创建或者查询虚拟集群开关参数,可以对老数据兼容控制。

DashboardName String k8s-node-overview

大盘唯一名称,可筛选查询指定名称的大盘。相对于Title参数,Title可能会发生变化,name不会。并且支持指定多个name,以半角逗号(,)分隔,例如:k8s-event,k8s-overview。同一个大盘名称会有多个版本,如果要指定版本,可以在name后面增加版本信息,例如:k8s-event:v1,k8s-overview:latest

返回数据

名称 类型 示例值 描述
RequestId String 2A0CEDF1-06FE-44AC-8E21-21A5BE65****

请求ID。

DashboardVos Array of DashboardVos

Grafana大盘信息。

Type String dash-db

Grafana大盘类型,包括:

  • dash-db:大盘
  • dash-folder:文件夹(可包含大盘)
Time String 1590136924

Grafana大盘创建时间的时间戳。

NeedUpdate Boolean false

大盘是否有新版本可以升级。

Kind String BASIC

大盘种类,为BASIC、THIRD、LIMIT、CUSTOM的其中一种。

Url String http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s

Grafana大盘的完整URL。

HttpsUrl String http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s

Grafana大盘URL。

DashboardType String Node

大盘类型,作用与exporter一致,但是字段含义更明确。

Exporter String Nginx

Exporter接入源的类型,包括:

  • Prometheus
  • Node
  • GPU
  • Redis
  • MySQL
  • Kafka
  • Nginx(v2)
  • Nginx
  • ZooKeeper
  • MongoDB
  • RabbitMQ
  • PostgreSQL
  • Kubernetes
  • Client Library
  • Elasticsearch
  • RocketMQ
Version String v2

大盘版本,与name形成唯一键,确定一个大盘。

IsArmsExporter Boolean false

是否属于ARMS提供的Exporter:

  • true:是ARMS提供的Exporter。
  • false:不是ARMS提供的Exporter。
HttpUrl String http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s

Grafana大盘的URL。

Title String ApiServer

Grafana大盘名称。

Name String k8s-node-overview

大盘名称,与Title不同,不会修改。

Id String 1100**

Grafana大盘ID,仅在安装Grafana大盘时是唯一的。

Uid String 1131971649496228-*****-59

安装多个Grafana大盘时的大盘唯一标识符,是展示在页面上的唯一业务ID。

Tags Array of String ["arms-k8s","ccc8ce1fe0c9543629e39ee657e34****"]

Grafana大盘标签。

示例

请求示例

http(s)://[Endpoint]/?Action=ListDashboards
&RegionId=cn-hangzhou
&ClusterId=cc7a37ee31aea4ed1a059eff8034b****
&ClusterType=Node
&Title=ApiServer
&Product=xxxx
&RecreateSwitch=false
&DashboardName=k8s-node-overview
&公共请求参数

正常返回示例

XML格式

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

<ListDashboardsResponse>
    <RequestId>2A0CEDF1-06FE-44AC-8E21-21A5BE65****</RequestId>
    <DashboardVos>
        <Type>dash-db</Type>
        <Time>1590136924</Time>
        <NeedUpdate>false</NeedUpdate>
        <Kind>BASIC</Kind>
        <Url>http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&amp;refresh=60s</Url>
        <HttpsUrl>http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&amp;refresh=60s</HttpsUrl>
        <DashboardType>Node</DashboardType>
        <Exporter>Nginx</Exporter>
        <Version>v2</Version>
        <IsArmsExporter>false</IsArmsExporter>
        <HttpUrl>http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&amp;refresh=60s</HttpUrl>
        <Title>ApiServer</Title>
        <Name>k8s-node-overview</Name>
        <Id>1100**</Id>
        <Uid>1131971649496228-*****-59</Uid>
        <Tags>["arms-k8s","ccc8ce1fe0c9543629e39ee657e34****"]</Tags>
    </DashboardVos>
</ListDashboardsResponse>

JSON格式

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

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