ListPrometheusIntegration - Managed Service for Prometheus

Queries a list of exporters that are integrated into a Prometheus instance. Only aliyun-cs and ecs instances are supported.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
ClusterId	string	Yes	The ID of the Prometheus instance. Only aliyun-cs and ecs instances are supported.	c77f6f2397ea74672872acf5e31374a27
IntegrationType	string	Yes	The integration type.	kafka, mysql, redis, snmp, emr, nubela, and tidb

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	1F1D8840-5330-5804-A8DB-C3C5C5CED6BB
Data	object []	The queried exporters.
ClusterId	string	The ID of the Prometheus instance.	c589a1b8db05c4561aefbb898ca8fb1cf
ShowDescribe	boolean	Indicates whether the description is displayed.	true
NeedUpgrade	boolean	Indicates whether an upgrade is required.	true
InstanceName	string	The name of the exporter.	inet
ExporterType	string	The type of the exporter.	kafka-exporter
IntegrationType	string	The integration type.	Kafka, mysql, redis, snmp, emr, nubela, and tidb
InstanceId	long	The exporter ID.	29374
Version	string	The version number.	1.0.0
Target	string	The monitored IP address.	121.40.62.240:3342
CanDelete	boolean	Indicates whether the exporter can be deleted.	true
CanEditor	boolean	Indicates whether the exporter can be edited.	true
Status	string	The state of the exporter.	installed
ContainerName	string	The name of the container.	container-1
Namespace	string	The namespace.	arms-prom
PodName	string	The pod name of the exporter.	kafka-exporter-1
Describe	string	The description of the exporter.	"{}"
ShowLog	boolean	Indicates whether the exporter logs are displayed.	true
Param	string	The configurations of the exporter. The value is a JSON string.	{ "port": "5554", "name": "kafka-test12", "kafka_instance": "kafka-test", "__label_value": "kafka-test", "scrape_interval": 33, "metrics_path": "/metrics", "__label_key": "kafka-test" }
Message	string	The returned message.	message
Code	integer	The response code. The status code 200 indicates that the request was successful.	200

Examples

Sample success responses

JSONformat

{
  "RequestId": "1F1D8840-5330-5804-A8DB-C3C5C5CED6BB",
  "Data": [
    {
      "ClusterId": "c589a1b8db05c4561aefbb898ca8fb1cf",
      "ShowDescribe": true,
      "NeedUpgrade": true,
      "InstanceName": "inet",
      "ExporterType": "kafka-exporter",
      "IntegrationType": "Kafka, mysql, redis, snmp, emr, nubela, and tidb\n",
      "InstanceId": 29374,
      "Version": "1.0.0",
      "Target": "121.40.62.240:3342",
      "CanDelete": true,
      "CanEditor": true,
      "Status": "installed",
      "ContainerName": "container-1",
      "Namespace": "arms-prom",
      "PodName": "kafka-exporter-1",
      "Describe": "\"{}\"",
      "ShowLog": true,
      "Param": "{\n      \"port\": \"5554\",\n      \"name\": \"kafka-test12\",\n      \"kafka_instance\": \"kafka-test\",\n      \"__label_value\": \"kafka-test\",\n      \"scrape_interval\": 33,\n      \"metrics_path\": \"/metrics\",\n      \"__label_key\": \"kafka-test\"\n}"
    }
  ],
  "Message": "message",
  "Code": 200
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history