All Products
Search
Document Center

Application Real-Time Monitoring Service:ListPrometheusIntegration

Last Updated:Nov 05, 2024

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

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
arms:GetPrometheusIntegrationnone
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

cn-hangzhou
ClusterIdstringYes

The ID of the Prometheus instance. Only aliyun-cs and ecs instances are supported.

c77f6f2397ea74672872acf5e31374a27
IntegrationTypestringYes

The integration type. Valid values: kafka, mysql, redis, snmp, emr, nubela, and tidb.

kafka, mysql, redis, snmp, emr, nubela, and tidb

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

1F1D8840-5330-5804-A8DB-C3C5C5CED6BB
Dataarray<object>

The queried exporters.

Instanceobject

The returned struct.

ClusterIdstring

The ID of the Prometheus instance.

c589a1b8db05c4561aefbb898ca8fb1cf
ShowDescribeboolean

Indicates whether the description is displayed.

true
NeedUpgradeboolean

Indicates whether an upgrade is required.

true
InstanceNamestring

The name of the exporter.

inet
ExporterTypestring

The type of the exporter.

kafka-exporter
IntegrationTypestring

The integration type. Valid values: kafka, mysql, redis, snmp, emr, nubela, and tidb.

Kafka, mysql, redis, snmp, emr, nubela, and tidb
InstanceIdlong

The ID of the exporter.

29374
Versionstring

The version number.

1.0.0
Targetstring

The monitored IP address.

121.40.62.240:3342
CanDeleteboolean

Indicates whether the exporter can be deleted.

true
CanEditorboolean

Indicates whether the exporter can be edited.

true
Statusstring

The status of the exporter.

installed
ContainerNamestring

The name of the container.

container-1
Namespacestring

The namespace.

arms-prom
PodNamestring

The pod name of the exporter.

kafka-exporter-1
Describestring

The description of the exporter.

"{}"
ShowLogboolean

Indicates whether the exporter logs are displayed.

true
Paramstring

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" }
Messagestring

The returned message.

message
Codeinteger

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 timeSummary of changesOperation
No change history