Queries the Grafana dashboards of a Container Service for Kubernetes (ACK) cluster.
Operation description
None.
Debugging
Authorization information
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RegionId | string | Yes | The region ID. | cn-hangzhou |
ClusterId | string | Yes | The ID of the ACK cluster. | cc7a37ee31aea4ed1a059eff8034b**** |
ClusterType | string | No | 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 | Node |
Language | string | No | The language of the returned Grafana dashboard. Valid values: en and zh. Default value: en. | en |
Title | string | No | The dashboard title. The dashboard title can be changed. We recommend that you specify the DashboardName parameter. | ApiServer |
Product | string | No | The cloud service code. This parameter is required if you set the ClusterType parameter to | xxxx |
RecreateSwitch | boolean | No | Specifies whether to create or query a virtual cluster. This parameter provides backward compatibility. | false |
DashboardName | string | No | 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, | k8s-node-overview |
Response parameters
Examples
Sample success responses
JSON
format
{
"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"
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2024-04-02 | The response structure of the API has changed | View Change Details |
2023-12-14 | The response structure of the API has changed | View Change Details |
2023-08-30 | The response structure of the API has changed | View Change Details |
2021-11-25 | The request parameters of the API has changed | View Change Details |