All Products
Search
Document Center

Managed Service for Prometheus:ListClusterFromGrafana

Last Updated:Aug 28, 2026

Queries all Grafana dashboards in a specified region.

Note

This API has been deprecated with no replacement. While temporary access is maintained, no further updates or bug fixes will be provided. To ensure continued functionality, plan your migration and contact your account manager for support.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

Yes

The region ID.

cn-hangzhou

Response elements

Element

Type

Description

Example

object

The information about the array object.

RequestId

string

The request ID, which you can use to query logs and troubleshoot issues.

6849D41E-EED4-5C00-89F9-6047BBD9DCB4

PromClusterList

array<object>

The cluster information.

object

The information about the Grafana dashboards.

UpdateTime

integer

The time when the dashboard was updated.

2021-11-16T08:49:34Z

CreateTime

integer

The time when the dashboard was created.

2021-12-09T02:05:04Z

UserId

string

The ID of the Alibaba Cloud account to which the cluster belongs.

1247285**

Options

string

The custom parameter.

{'Option': ['betaTestApproved']}

IsControllerInstalled

boolean

Indicates whether the Prometheus agent is installed. Valid values:

  • true: The Prometheus agent was installed.

  • false: The Prometheus agent was not installed.

true

AgentStatus

string

The status of the Prometheus agent in the cluster. Valid values:

  • INSTALL_FAILED: The Prometheus agent failed to be installed.

  • INSTALL_SUCCEED: The Prometheus agent was installed.

  • NOT_REGISTER: You have not registered an Alibaba Cloud account.

INSTALL_FAILED

Extra

string

The extended fields, in JSON string format.

{\"app_id\":\"bbd\",\"task_id\":\"4305ba5bf14942daa6e553ed91f46988\"}

InstallTime

integer

The timestamp when the Prometheus agent was installed.

1653532518000

RegionId

string

The region ID.

cn-beijing

ControllerId

string

The controller ID.

1092

PluginsJsonArray

string

The list of nodejsonar logs.

{}

ClusterType

string

The type of the cluster.

cloud-product-prometheus

ClusterName

string

The name of the cluster.

ay-ads-hangzhou

StateJson

string

The information about applications deployed in the cluster.

{}

LastHeartBeatTime

integer

The time when the last heartbeat was reported.

1653532518000

NodeNum

integer

The number of nodes.

3

Id

integer

The ID of a database in the cluster.

16136

ClusterId

string

The cluster ID.

c0df7ad9db0ed43128925ca04774c469e

Examples

Success response

JSON format

{
  "RequestId": "6849D41E-EED4-5C00-89F9-6047BBD9DCB4",
  "PromClusterList": [
    {
      "UpdateTime": 0,
      "CreateTime": 0,
      "UserId": "1247285**",
      "Options": "{'Option': ['betaTestApproved']}",
      "IsControllerInstalled": true,
      "AgentStatus": "INSTALL_FAILED",
      "Extra": "{\\\"app_id\\\":\\\"bbd\\\",\\\"task_id\\\":\\\"4305ba5bf14942daa6e553ed91f46988\\\"}",
      "InstallTime": 1653532518000,
      "RegionId": "cn-beijing",
      "ControllerId": "1092",
      "PluginsJsonArray": "{}",
      "ClusterType": "cloud-product-prometheus",
      "ClusterName": "ay-ads-hangzhou",
      "StateJson": "{}",
      "LastHeartBeatTime": 1653532518000,
      "NodeNum": 3,
      "Id": 16136,
      "ClusterId": "c0df7ad9db0ed43128925ca04774c469e"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.