调用ListDashboards接口列出指定地域下的某个集群的Grafana大盘。

调试

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

请求参数

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

系统规定参数。取值:ListDashboards。

ClusterId String SDGDGSFSDGSDGF

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

RegionId String cn-hangzhou

地域ID。

返回数据

名称 类型 示例值 描述
DashboardVos Array

Grafana大盘信息

Exporter String Kubernates

Exporter接入源的类型

Id String 171

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

IsArmsExporter Boolean false

是否属于ARMS提供的Exporter

Tags List ["arms-k8s","ccc8ce1fe0c9543629e39ee657e34****"]

Grafana大盘标签

Time String 1590136924

Grafana大盘创建时间

Title String ApiServer

Grafana大盘名称

Type String dash-db

Grafana大盘类型

Uid String 1411998742223274-****-02

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

Url String http://grafana.console.aliyun.com/d/1411998742223274-****-02/apiserver?orgId=142&refresh=60s

Grafana大盘所在的完整URL地址

RequestId String 959C77E2-04E9-4FD4-848A-B8C1A48BEF51

请求ID

示例

请求示例

http://arms.cn-hangzhou.aliyun-inc.com:8099/prometheus/ListDashboards.json?Region=cn-hangzhou
&ClusterId=DFADGSDSFASDF

正常返回示例

XML 格式

<DashboardVos>
    <Uid>1411998742223274-****-02</Uid>
    <Type>dash-db</Type>
    <Title>ApiServer</Title>
    <Time>1590136924</Time>
    <Id>171</Id>
    <Exporter>Kubernates</Exporter>
    <Url>http://grafana.console.aliyun.com/d/1411998742223274-****-02/apiserver?orgId=142&amp;refresh=60s</Url>
    <IsArmsExporter>false</IsArmsExporter>
</DashboardVos>
<DashboardVos>
    <Tags>["arms-k8s","ccc8ce1fe0c9543629e39ee657e34****"]</Tags>
</DashboardVos>
<RequestId>959C77E2-04E9-4FD4-848A-B8C1A48BEF51</RequestId>

JSON 格式

{
    "DashboardVos": [
        {
            "Uid": "1411998742223274-****-02",
            "Type": "dash-db",
            "Title": "ApiServer",
            "Time": 1590136924,
            "Id": 171,
            "Exporter": "Kubernates",
            "Url": "http://grafana.console.aliyun.com/d/1411998742223274-****-02/apiserver?orgId=142&amp;refresh=60s",
            "IsArmsExporter": false
        },
        {
            "Tags": "[\"arms-k8s\",\"ccc8ce1fe0c9543629e39ee657e34****\"]"
        }
    ],
    "RequestId": "959C77E2-04E9-4FD4-848A-B8C1A48BEF51"
}

错误码

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