CreatePrometheusMonitoring - Create Prometheus monitoring configuration - Application Real-Time Monitoring Service

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

arms:CreatePrometheusMonitoring

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
ClusterId	string	Yes	The Prometheus instance ID.	cc7a37ee31aea4ed1a059eff8034b****
Type	string	Yes	The configuration type. For Container Service instances, valid values are serviceMonitor, podMonitor, customJob, and probe. For ECS instances, valid values are customJob and probe.	serviceMonitor
Status	string	No	The status of the monitoring configuration. Valid values: run and stop. Default value: run. This parameter is not supported for probe and must be left empty.	run
ConfigYaml	string	Yes	The YAML string of the monitoring configuration.	See the supplementary description of request parameters

serviceMonitor example:

apiVersion: monitoring.coreos.com/v1
kind: ServiceMonitor
metadata:
  name: tomcat-demo
  namespace: default
spec:
  endpoints:
    - interval: 30s
      path: /metrics
      port: tomcat-monitor
  namespaceSelector:
    any: true
  selector:
    matchLabels:
      app: tomcat

podMonitor example:

apiVersion: "monitoring.coreos.com/v1"
kind: "PodMonitor"
metadata:
  name: "podmonitor-demo"
  namespace: "default"
spec:
  namespaceSelector:
    any: true
  podMetricsEndpoints:
    - interval: "30s"
      path: "/metrics"
      port: "tomcat-monitor"
  selector:
    matchLabels:
      app: "nginx2-exporter"

customJob example:

scrape_configs:
  - job_name: prometheus1
    honor_timestamps: false
    honor_labels: false
    scheme: http
    metrics_path: /metric
    static_configs:
      - targets:
          - 127.0.0.1:9090

probe example:

apiVersion: monitoring.coreos.com/v1
kind: Probe
metadata:
  name: name1-tcp-blackbox # Rule: xxx-{tcp/http/ping}-blackbox
  namespace: arms-prom # Optional
spec:
  interval: 30s
  jobName: blackbox
  module: tcp_connect
  prober:
    path: /blackbox/probe
    scheme: http
    url: 'localhost:9335'
  targets:
    staticConfig:
      static:
        - 'arms-prom-admin.arms-prom:9335'

Response elements

Element	Type	Description	Example
	object	Schema of Response
Code	integer	The HTTP status code. A status code of 200 indicates success.	200
Data	string	The name of the successfully added monitoring configuration, or the error message.	name1
Message	string	The message returned in the response.	message
RequestId	string	Id of the request	21E85B16-75A6-429A-9F65-8AAC9A54****

Examples

Success response

JSON format

{
  "Code": 200,
  "Data": "name1",
  "Message": "message",
  "RequestId": "21E85B16-75A6-429A-9F65-8AAC9A54****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.