Queries the Grafana dashboards of a Container Service for Kubernetes cluster.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | ListDashboards | The operation that you want to perform. Set the value to ListDashboards. |
RegionId | String | Yes | cn-hangzhou | The ID of the region. |
ClusterId | String | Yes | cc7a37ee31aea4ed1a059eff8034b**** | The ID of the Container Service for Kubernetes cluster. |
ClusterType | String | No | Node | The type of the cluster. 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. |
Language | string | No | en | The language of the Grafana dashboards. |
Title | String | No | ApiServer | The dashboard title. The dashboard title can be changed. We recommend that you specify the DashboardName parameter. |
Product | String | No | xxxx | The product code. |
RecreateSwitch | Boolean | No | false | Specifies whether to create or query a virtual cluster. This parameter provides backward compatibility. |
DashboardName | String | No | k8s-node-overview | 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, |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 2A0CEDF1-06FE-44AC-8E21-21A5BE65**** | The ID of the request. |
DashboardVos | Array of DashboardVos | The information about the Grafana dashboards. |
|
Type | String | dash-db | The type of the Grafana dashboard. Valid values:
|
Time | String | 1590136924 | The timestamp when the Grafana dashboard was created. |
NeedUpdate | Boolean | false | Indicates whether the Grafana dashboard has a new version that is available for upgrade. |
Kind | String | BASIC | 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. |
Url | String | http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s | The complete URL of the Grafana dashboard. |
HttpsUrl | String | http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s | The URL of the Grafana dashboard. |
DashboardType | String | Node | The type of the Grafana dashboard. This parameter has the same effect as the Exporter parameter whereas provides clearer implication. |
Exporter | String | NGINX | The type of the exporter access source. Valid values:
|
Version | String | v2 | The version of the Grafana dashboard. The combination of version and name uniquely identifies a dashboard. |
IsArmsExporter | Boolean | false | Indicates whether the exporter is provided by Application Real-Time Monitoring Service (ARMS).
|
HttpUrl | String | http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s | The URL of the Grafana dashboard. |
Title | String | ApiServer | The title of the Grafana dashboard. |
Name | String | k8s-node-overview | The name of the Grafana dashboard. This parameter is different from the Title parameter and cannot be changed. |
Id | String | 1100** | The ID of the Grafana dashboard. The value is unique only when you install the Grafana dashboard. |
Uid | String | 1131971649496228-*****-59 | The unique identifier of a dashboard when multiple Grafana dashboards are installed. It is a unique business ID displayed on the page. |
Tags | Array of String | ["arms-k8s","ccc8ce1fe0c9543629e39ee657e34****"] | The tag of the Grafana dashboard. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=ListDashboards
&RegionId=cn-hangzhou
&ClusterId=cc7a37ee31aea4ed1a059eff8034b****
&ClusterType=Node
&Title=ApiServer
&Product=xxxx
&RecreateSwitch=false
&DashboardName=k8s-node-overview
&<Common request parameters>
Sample success responses
XML
format
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**&refresh=60s</Url>
<HttpsUrl>http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&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**&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
format
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**&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****\"]"
}
}
Error codes
For a list of error codes, visit the API Error Center.