All Products
Search
Document Center

Application Real-Time Monitoring Service:ListClusterFromGrafana

Last Updated:Nov 05, 2024

Queries all Grafana dashboards in a specified region.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
arms:ListClusterFromGrafananone
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object

The information about the array object.

RequestIdstring

The request ID. You can use the ID to query logs and troubleshoot issues.

6849D41E-EED4-5C00-89F9-6047BBD9DCB4
PromClusterListarray<object>

The cluster information.

PromClusterobject

The information about the Grafana dashboards.

UpdateTimelong

The time when the dashboard was updated.

2021-11-16T08:49:34Z
CreateTimelong

The time when the dashboard was created.

2021-12-09T02:05:04Z
UserIdstring

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

1247285**
Optionsstring

The custom parameter.

{'Option': ['betaTestApproved']}
IsControllerInstalledboolean

Indicates whether the Prometheus agent was installed. Valid values:

  • true: The Prometheus agent was installed.
  • false: The Prometheus agent was not installed.
true
AgentStatusstring

The status of the Prometheus agent on 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
Extrastring

The extended fields. This parameter is a JSON string.

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

The timestamp when the Prometheus agent was installed.

1653532518000
RegionIdstring

The region ID.

cn-beijing
ControllerIdstring

The controller ID.

1092
PluginsJsonArraystring

The list of nodejsonar logs.

{}
ClusterTypestring

The type of the cluster.

cloud-product-prometheus
ClusterNamestring

The name of the cluster.

ay-ads-hangzhou
StateJsonstring

The information about applications deployed in the cluster.

{}
LastHeartBeatTimelong

The time when the last heartbeat was reported.

1653532518000
NodeNuminteger

The number of nodes.

3
Idlong

The ID of a database in the cluster.

16136
ClusterIdstring

The cluster ID.

c0df7ad9db0ed43128925ca04774c469e

Examples

Sample success responses

JSONformat

{
  "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

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history