GetPrometheusIntegration - Managed Service for Prometheus

Queries the information about an exporter that is integrated into a Prometheus instance for Container Service or a Prometheus instance for ECS.

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 a Prometheus instance for Container Service or a Prometheus instance for ECS is supported.	cc7a37ee31aea4ed1a059eff8034b****
IntegrationType	string	Yes	The type of the integration.	kafka, mysql, redis, snmp, emr, nubela, and tidb
InstanceId	long	Yes	The exporter ID.	2893

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	9BEF2832-9D95-5E3E-9B10-74887CA17B94
Data	object	The struct returned.
ClusterId	string	The ID of the Prometheus instance.	c589a1b8db05c4561aefbb898ca8fb1cf
InstanceId	long	The exporter ID.	2893
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.	lpd-skyeye
IntegrationType	string	The type of the integration.	tidb
ExporterType	string	The type of the exporter.	tidb-exporter
Version	string	The version information.	1.0.0
Target	string	The monitored IP address.	127.0.0.1:3422
CanDelete	boolean	Indicates whether the exporter can be deleted.	true
CanEditor	boolean	Indicates whether the exporter can be modified.	true
Status	string	The status of the exporter.	installed
Describe	string	The description of the exporter.	"{}"
ShowLog	string	Indicates whether the exporter logs are displayed.	true
Namespace	string	The namespace.	arms-prom
ContainerName	string	The container name.	kafka-exporter-1
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" }
Code	integer	The status code. The status code 200 indicates that the request was successful. If another status code is returned, the request failed.	200
Message	string	The message returned.	message

Examples

Sample success responses

JSONformat

{
  "RequestId": "9BEF2832-9D95-5E3E-9B10-74887CA17B94",
  "Data": {
    "ClusterId": "c589a1b8db05c4561aefbb898ca8fb1cf",
    "InstanceId": 2893,
    "ShowDescribe": true,
    "NeedUpgrade": true,
    "InstanceName": "lpd-skyeye",
    "IntegrationType": "tidb",
    "ExporterType": "tidb-exporter",
    "Version": "1.0.0",
    "Target": "127.0.0.1:3422",
    "CanDelete": true,
    "CanEditor": true,
    "Status": "installed",
    "Describe": "\"{}\"",
    "ShowLog": "true",
    "Namespace": "arms-prom",
    "ContainerName": "kafka-exporter-1",
    "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}"
  },
  "Code": 200,
  "Message": "message"
}

Error codes

HTTP status code	Error code	Error message
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

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

Change history

Change time

Summary of changes

Operation

2023-04-10

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400

2023-03-23

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400