全部产品
Search
文档中心

应用实时监控服务ARMS:ListClusterFromGrafana - 列出指定地域下的所有Grafana大盘

更新时间:Nov 05, 2024

列出指定地域下的所有Grafana大盘。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
arms:ListClusterFromGrafananone
  • 全部资源
    *

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。

cn-hangzhou

返回参数

名称类型描述示例值
object

返回结构体。

RequestIdstring

请求 ID。用于定位日志,排查问题。

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

用户集群信息列表。

PromClusterobject

Grafana 大盘信息。

UpdateTimelong

更新时间。

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

创建时间。

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

集群所属用户的主账号 ID。

1247285**
Optionsstring

自定义参数。

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

Prometheus 监控的安装状态:

  • true:已安装
  • false:未安装
true
AgentStatusstring

集群的 Agent 状态。包括:

  • INSTALL_FAILED:安装失败
  • INSTALL_SUCCEED:安装成功
  • NOT_REGISTER:未注册
INSTALL_FAILED
Extrastring

扩展字段,JSON 字符串。

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

安装时间的时间戳。

1653532518000
RegionIdstring

地域 ID。

cn-beijing
ControllerIdstring

管控角色 ID。

1092
PluginsJsonArraystring

nodejsonar 类型的日志列表。

{}
ClusterTypestring

集群类型。

cloud-product-prometheus
ClusterNamestring

集群名称。

ay-ads-hangzhou
StateJsonstring

集群的应用部署情况。

{}
LastHeartBeatTimelong

上次心跳汇报时间。

1653532518000
NodeNuminteger

节点数量。

3
Idlong

集群数据库记录 ID。

16136
ClusterIdstring

集群 ID。

c0df7ad9db0ed43128925ca04774c469e

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史