GetPrometheusIntegration - Application Real-Time Monitoring Service

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

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:GetPrometheusIntegration	none	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
ClusterId	string	Yes	The ID of the Prometheus instance. Valid values: aliyun-cs and ecs.	cc7a37ee31aea4ed1a059eff8034b****
IntegrationType	string	Yes	The integration type. Valid values: kafka, mysql, redis, snmp, emr, nubela, and tidb.	kafka, mysql, redis, snmp, emr, nubela, and tidb
InstanceId	long	Yes	The ID of the exporter.	2893

Response parameters

Parameter	Type	Description	Example
	object	The response schema.
RequestId	string	The ID of the request.	9BEF2832-9D95-5E3E-9B10-74887CA17B94
Data	object	The returned struct.
ClusterId	string	The ID of the Prometheus instance.	c589a1b8db05c4561aefbb898ca8fb1cf
InstanceId	long	The ID of the exporter.	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 integration type. Valid values: kafka, mysql, redis, snmp, emr, nubela, and tidb.	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 parameters of the exporter. Format: 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	View Change Details
2023-03-23	The Error code has changed	View Change Details