ListPrometheusInstances-阿里云帮助中心

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
ClusterType	string	No	The cluster type. If you do not specify this parameter, all cluster types are queried. Valid values: cloud-product-prometheus: Prometheus instance for cloud services ManagedKubernetes: ACK managed cluster satellite: Prometheus instance for ARMS OpenTelemetry Ask: ACK Serverless cluster remote-write-prometheus: general-purpose Prometheus instance cloud-monitor-cmee: Hybrid Cloud Monitoring ExternalKubernetes: external Kubernetes cluster registered in ACK vpc-prometheus: Prometheus instance for ECS cloud-monitor-direct: cloud service self-monitoring Edge Kubernetes: ACK Edge cluster	cloud-product-prometheus
ShowGlobalView	boolean	Yes	Specifies whether to obtain global aggregation instances. Valid values: true false	true

Response elements

Element	Type	Description	Example
	object	The information about the array object.
Data	string	The Prometheus instances in the region in the JSON format.	[{"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	The request ID. You can use the ID to query logs and troubleshoot issues.	E9C9DA3D-10FE-472E-9EEF-2D0A3E41****
Code	integer	The status code.	200
Message	string	The returned message.	success

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.