GetPrometheusInstance - Application Real-Time Monitoring Service

Queries the information about the specified Prometheus instance.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region.	cn-hangzhou
ClusterId	string	Yes	The ID of the Prometheus instance.	c77f6f2397ea74672872acf5e31374a27

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	52C422FD-6B43-524D-B8A1-A4693294318C
Message	string	The message that is returned.	message
Code	integer	The HTTP status code that is returned. The HTTP 200 status code indicates that the call is successful. If a different HTTP status code is returned, the call fails.	200
Data	object	The information that is returned.
ClusterId	string	The ID of the Prometheus instance.	c589a1b8db05c4561aefbb898ca8fb1cf
RegionId	string	The ID of the region.	cn-beijing
UserId	string	The ID of the user.	167275301789****
ClusterName	string	The name of the cluster.	prom1
ClusterType	string	The type of the cluster. Valid values: remote-write (Prometheus instance for Remote Write), ecs (Prometheus instance for ECS), Prometheus for Cloud Services, cloud-product (Prometheus instance for Alibaba Cloud services outside China), global-view (Prometheus instance for GlobalView), and aliyun-cs (Prometheus for Container Service).	remote-write
VpcId	string	The virtual private cloud (VPC) where the cluster resides.	vpc-8vb02uk57qbcktqcvqqqj
VSwitchId	string	The ID of the vSwitch.	vsw-f8z73vcja1tqnw90aav5a
SecurityGroupId	string	The ID of the security group.	sg-8vbdgmf4nraiqa9bx0jo
SubClustersJson	string	The JSON string of the child instance of the GlobalView instance.	\[{"headers":{},"regionId":"cn-hangzhou","sourceType":"AlibabaPrometheus","extras":{},"clusterId":"c39a1048921e04fceb039db2fbb73\\\","sourceName":"arms-luyao-test","dataSource":"","userId":"167275301789\\\"},{"headers":{},"regionId":"cn-beijing","sourceType":"AlibabaPrometheus","extras":{},"clusterId":"c6b6485496d5b400abde22cb47b5\\\\","sourceName":"agent-321-test","dataSource":"","userId":"1672753017899\\\"},{"headers":{},"regionId":"cn-zhangjiakou","sourceType":"AlibabaPrometheus","extras":{},"clusterId":"c261a4f3200c446659133f1ade789b15e","sourceName":"zaifeng-cardinality-01","dataSource":"","userId":"167275301789\\\"}]
PaymentType	string	The billing method. Valid values: PREPAY (subscription) and POSTPAY (pay-as-you-go).	PREPAY
GrafanaInstanceId	string	The ID of the Grafana workspace.	grafana-rnggfvhlcdl6m71***
ResourceGroupId	string	The ID of the resource group to which the instance belongs.	rg-aek2vezare****
ResourceType	string	The type of the resource. Only PROMETHEUS is supported.	PROMETHEUS
Tags	array	The tags of the instance.
	object	The tag of the instance.
TagKey	string	The tag key of the instance.	tag1
TagValue	string	The tag value of the instance.	tagValue1

Examples

Sample success responses

JSONformat

{
  "RequestId": "52C422FD-6B43-524D-B8A1-A4693294318C",
  "Message": "message",
  "Code": 200,
  "Data": {
    "ClusterId": "c589a1b8db05c4561aefbb898ca8fb1cf",
    "RegionId": "cn-beijing",
    "UserId": "167275301789****",
    "ClusterName": "prom1",
    "ClusterType": "remote-write",
    "VpcId": "vpc-8vb02uk57qbcktqcvqqqj",
    "VSwitchId": "vsw-f8z73vcja1tqnw90aav5a",
    "SecurityGroupId": "sg-8vbdgmf4nraiqa9bx0jo",
    "SubClustersJson": "\\[{\"headers\":{},\"regionId\":\"cn-hangzhou\",\"sourceType\":\"AlibabaPrometheus\",\"extras\":{},\"clusterId\":\"c39a1048921e04fceb039db2fbb73\\*\\*\\*\",\"sourceName\":\"arms-luyao-test\",\"dataSource\":\"\",\"userId\":\"167275301789\\*\\*\\*\"},{\"headers\":{},\"regionId\":\"cn-beijing\",\"sourceType\":\"AlibabaPrometheus\",\"extras\":{},\"clusterId\":\"c6b6485496d5b400abde22cb47b5\\*\\*\\*\\*\",\"sourceName\":\"agent-321-test\",\"dataSource\":\"\",\"userId\":\"1672753017899\\*\\*\\*\"},{\"headers\":{},\"regionId\":\"cn-zhangjiakou\",\"sourceType\":\"AlibabaPrometheus\",\"extras\":{},\"clusterId\":\"c261a4f3200c446659133f1ade789b15e\",\"sourceName\":\"zaifeng-cardinality-01\",\"dataSource\":\"\",\"userId\":\"167275301789\\*\\*\\*\"}]\n",
    "PaymentType": "PREPAY",
    "GrafanaInstanceId": "grafana-rnggfvhlcdl6m71***",
    "ResourceGroupId": "rg-aek2vezare****",
    "ResourceType": "PROMETHEUS",
    "Tags": [
      {
        "TagKey": "tag1",
        "TagValue": "tagValue1"
      }
    ]
  }
}

Error codes

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