All Products
Search
Document Center

Application Real-Time Monitoring Service:AddPrometheusIntegration

Last Updated:Aug 27, 2026

Adds an exporter to a Prometheus instance for Container Service or a Prometheus instance for ECS.

Note

This API has been deprecated with no replacement. While temporary access is maintained, no further updates or bug fixes will be provided. To ensure continued functionality, plan your migration and contact your account manager for support.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

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、tidb等

Param

string

Yes

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

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

Id of the request

3703B98C-335E-5BA7-972E-F90E9E768A85

Data

object

The struct returned.

InstanceId

integer

The ID of the exporter.

2829

InstanceName

string

The name of the exporter.

hw-cloud02

Code

integer

The status code or error code.

200

Message

string

The message returned.

message

Examples

Success response

JSON format

{
  "RequestId": "3703B98C-335E-5BA7-972E-F90E9E768A85",
  "Data": {
    "InstanceId": 2829,
    "InstanceName": "hw-cloud02"
  },
  "Code": 200,
  "Message": "message"
}

Error codes

HTTP status code

Error code

Error message

Description

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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.