文档

ListPrometheusInstances - 获取所有正常实例

更新时间:

获取Prometheus的所有正常实例。

调试

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

授权信息

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

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

请求参数

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

地域 ID。

cn-hangzhou
ClusterTypestring

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

  • 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
ShowGlobalViewboolean

是否获取 GlobalView 聚合实例:

  • true:获取
  • false:不获取
true

返回参数

名称类型描述示例值
object

返回结构体。

Datastring

返回实例 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"}]
RequestIdstring

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

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

状态码。

200
Messagestring

返回信息。

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

错误码

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

变更历史

变更时间变更内容概要操作
2023-11-20API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-04-21OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:ClusterType
2023-03-20OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈