ListPrometheusInstances - Application Real-Time Monitoring Service

Obtains all Prometheus instances in a 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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
arms:ListPrometheusInstances	none	All Resources *	none	none

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 parameters

Parameter	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

Sample success responses

JSONformat

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

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

Change history

Change time	Summary of changes	Operation
2023-11-20	The internal configuration of the API is changed, but the call is not affected	View Change Details
2023-04-21	The request parameters of the API has changed	View Change Details
2023-03-20	The response structure of the API has changed	View Change Details