ListPrometheusInstances - 获取所有正常实例

更新时间:
复制 MD 格式

获取Prometheus的所有正常实例。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

RegionId

string

地域 ID。

cn-hangzhou

ClusterType

string

可选实例类型(若不填则为查询所有类型的实例):

  • cloud-product-prometheus (Region 级云服务旧版)

  • ManagedKubernetes (容器服务 ACK 托管版类型)

  • satellite (Prometheus for ARMS OpenTelemetry)

  • Ask (容器服务 ACK Serverless 集群类型)

  • remote-write-prometheus (通用实例)

  • cloud-monitor-cmee (企业云监控)

  • ExternalKubernetes (容器服务注册集群类型)

  • vpc-prometheus (Prometheus for ECS)

  • cloud-monitor-direct (云服务自监控)

  • Edge Kubernetes (容器服务 Edge 集群类型)

cloud-product-prometheus

ShowGlobalView

boolean

是否获取 GlobalView 聚合实例:

  • true:获取

  • false:不获取

true

返回参数

名称

类型

描述

示例值

object

返回结构体。

Data

string

返回实例 JSON。

[{"agentStatus":"0","clusterId":"global-v2-cn-1672753017899-dmjnwtzz","clusterName":"test-GlobalView","clusterType":"GlobalViewV2","commercialConfig":{},"createTime":1656579981000,"id":13785300,"isAdvancedClusterInstalled":false,"isClusterRunning":true,"isControllerInstalled":true,"isIntegrationCenter":false,"regionId":"cn-hongkong","updateTime":1657616273000,"userId":"1672753017899"},{"agentStatus":"0","clusterId":"51a123a61a8f31f0","clusterName":"cloud-product-prometheus_cn-qingdao","clusterType":"cloud-product-prometheus","commercialConfig":{},"controllerId":"51a123a61a8f31f0","createTime":1653532488000,"id":13746658,"isAdvancedClusterInstalled":false,"isClusterRunning":true,"isControllerInstalled":true,"isIntegrationCenter":false,"regionId":"cn-qingdao","updateTime":1653532518000,"userId":"1672753017899"}]

RequestId

string

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

E9C9DA3D-10FE-472E-9EEF-2D0A3E41****

Code

integer

状态码。

200

Message

string

返回信息。

success

示例

正常返回示例

JSON格式

{
  "Data": "[{\"agentStatus\":\"0\",\"clusterId\":\"global-v2-cn-1672753017899-dmjnwtzz\",\"clusterName\":\"test-GlobalView\",\"clusterType\":\"GlobalViewV2\",\"commercialConfig\":{},\"createTime\":1656579981000,\"id\":13785300,\"isAdvancedClusterInstalled\":false,\"isClusterRunning\":true,\"isControllerInstalled\":true,\"isIntegrationCenter\":false,\"regionId\":\"cn-hongkong\",\"updateTime\":1657616273000,\"userId\":\"1672753017899\"},{\"agentStatus\":\"0\",\"clusterId\":\"51a123a61a8f31f0\",\"clusterName\":\"cloud-product-prometheus_cn-qingdao\",\"clusterType\":\"cloud-product-prometheus\",\"commercialConfig\":{},\"controllerId\":\"51a123a61a8f31f0\",\"createTime\":1653532488000,\"id\":13746658,\"isAdvancedClusterInstalled\":false,\"isClusterRunning\":true,\"isControllerInstalled\":true,\"isIntegrationCenter\":false,\"regionId\":\"cn-qingdao\",\"updateTime\":1653532518000,\"userId\":\"1672753017899\"}]",
  "RequestId": "E9C9DA3D-10FE-472E-9EEF-2D0A3E41****",
  "Code": 200,
  "Message": "success"
}

错误码

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

变更历史

更多信息,参考变更详情