Help Center/Application Operations Management/API Reference/APIs/Prometheus Instance/Modifying a Prometheus Instance
Updated on 2025-11-06 GMT+08:00
View PDF

Modifying a Prometheus Instance

Function

This API is used to modify a Prometheus instance.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/{project_id}/aom/prometheus

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID obtained from IAM. Generally, a project ID contains 32 characters.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token obtained from IAM.

Content-Type

Yes

String

Content type, which is application/json.

Enterprise-Project-Id

Yes

String

Enterprise project ID.

  • To modify the instances in an enterprise project, enter the enterprise project ID.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

prom_id

Yes

String

ID of the Prometheus instance to be modified.

prom_limits

No

PromLimits object

Metric storage duration, which can be modified only once a day.

prom_name

No

String

Name of the target Prometheus instance. Enter 1–100 characters and do not start or end with an underscore (_) or hyphen (-). Only letters, digits, underscores, and hyphens are allowed.

aggr_prometheus_info

No

Array of AggrPrometheusInfo objects

List of accounts and Prometheus instances for aggregation.

Table 4 PromLimits

Parameter

Mandatory

Type

Description

compactor_blocks_retention_period

Yes

String

Metric storage duration. Only 15, 30, 60, and 90 days are supported.

Enumeration values:

  • "360h"

  • "720h"

  • "1440h"

  • "2160h"

Table 5 AggrPrometheusInfo

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of the account for aggregation.

prometheusIds

Yes

Array of strings

Prometheus ID list of the account for aggregation.

id

Yes

String

ID of the account for aggregation.

name

Yes

String

Name of the account for aggregation.

Response Parameters

Status code: 200

Table 6 Response body parameters

Parameter

Type

Description

count

Long

Total number of Prometheus instances.

prometheus

Array of PromInstanceEpsModel objects

List of Prometheus instance names.

Table 7 PromInstanceEpsModel

Parameter

Type

Description

prom_name

String

Prometheus instance name. Enter 1–100 characters and do not start or end with an underscore (_) or hyphen (-). Only letters, digits, underscores, and hyphens are allowed.

prom_id

String

Prometheus instance ID.

prom_type

String

Prometheus instance type. Options:

  • default: default Prometheus instance.

  • ECS: Prometheus for ECS.

  • CCE: Prometheus for CCE.

  • REMOTE_WRITE: common Prometheus instance.

  • CLOUD_SERVICE: Prometheus for cloud services.

  • ACROSS_ACCOUNT: Prometheus for multi-account aggregation (not supported currently).

prom_version

String

Prometheus instance version.

prom_create_timestamp

Long

Timestamp when the Prometheus instance is created.

prom_update_timestamp

Long

Timestamp when the Prometheus instance is updated.

prom_status

String

Prometheus instance status.

Enumeration values:

  • DELETED

  • NORMAL

  • ALL

enterprise_project_id

String

Enterprise project that the Prometheus instance belongs to.

project_id

String

ID of the project that the Prometheus instance belongs to.

is_deleted_tag

Long

Whether an instance has been deleted.

deleted_time

Long

Deletion time.

prom_spec_config

PromConfigModel object

Special configuration of the Prometheus instance.

cce_spec_config

String

Special configuration of the Prometheus instance in the CCE scenario.

prom_limits

PromLimits object

Prometheus instance limitations.

limits_update_time

Long

Time when the metric storage duration was modified.

application

ApplicationModel object

Application details.

Table 8 PromConfigModel

Parameter

Type

Description

remote_write_url

String

Remote write address of the Prometheus instance.

remote_read_url

String

Remote read address of the Prometheus instance.

prom_http_api_endpoint

String

URL for calling the Prometheus instance.

dashboard_id

String

ID of the dashboard associated with the Prometheus instance (not used currently).

region_id

String

Region that the Prometheus instance belongs to.

Table 9 PromLimits

Parameter

Type

Description

compactor_blocks_retention_period

String

Metric storage duration. Only 15, 30, 60, and 90 days are supported.

Enumeration values:

  • "360h"

  • "720h"

  • "1440h"

  • "2160h"

Table 10 ApplicationModel

Parameter

Type

Description

app_id

String

Application ID.

app_name

String

Application name.

app_type

String

Application source.

Status code: 400

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_type

String

Error type.

trace_id

String

Trace ID.

Status code: 401

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_type

String

Error type.

trace_id

String

Trace ID.

Status code: 500

Table 13 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_type

String

Error type.

trace_id

String

Trace ID.

Example Requests

Modify the Prometheus instance name and metric storage duration.

https://{Endpoint}/v1/{project_id}/aom/prometheus

{
  "prom_id" : "a4a3****-****-4ef6-****-****d1cc****",
  "prom_limits" : {
    "compactor_blocks_retention_period" : "720h"
  },
  "prom_name" : "aomPrometheus"
}

Example Responses

Status code: 200

OK: The request is successful.

{
  "count" : 0,
  "prometheus" : [ {
    "deleted_time" : 0,
    "enterprise_project_id" : "0",
    "limits_update_time" : 0,
    "project_id" : "2a4***56cc***7f837***891***c1cf",
    "prom_create_timestamp" : 1691718171483,
    "prom_id" : "08****2a-8**b-4**5-b**1-d1********79",
    "prom_name" : "aom_prometheus",
    "prom_spec_config" : {
      "prom_http_api_endpoint" : "aom-internal.cn-****-*.***.com:***/v1/2a4***56cc***7f837***891***c1cf/08****2a-8**b-4**5-b**1-d1********79",
      "region_id" : "cn-****-*",
      "remote_read_url" : "aom-internal.cn-****-*.***.com:***/v1/2a4***56cc***7f837***891***c1cf/08****2a-8**b-4**5-b**1-d1********79/api/v1/read",
      "remote_write_url" : "aom-internal.cn-****-*.***.com:***/v1/2a4***56cc***7f837***891***c1cf/08****2a-8**b-4**5-b**1-d1********79/push"
    },
    "prom_type" : "CCE",
    "prom_update_timestamp" : 1691718171483
  } ]
}

Status code: 400

Bad Request: Invalid request. The client should not repeat this request without modification.

{
  "error_code" : "AOM.11016014",
  "error_msg" : "prom instance not found",
  "trace_id" : ""
}

Status code: 401

Unauthorized: The authorization information provided by the client is incorrect or invalid.

{
  "error_code" : "SVCSTG.AMS.4010000",
  "error_msg" : "auth failed.",
  "error_type" : "AUTH_FAILED",
  "trace_id" : null
}

Status code: 500

Internal Server Error: The server is able to receive the request but unable to understand the request.

{
  "error_code" : "APM.00000500",
  "error_msg" : "Internal Server Error",
  "trace_id" : ""
}

Status Codes

Status Code

Description

200

OK: The request is successful.

400

Bad Request: Invalid request. The client should not repeat this request without modification.

401

Unauthorized: The authorization information provided by the client is incorrect or invalid.

500

Internal Server Error: The server is able to receive the request but unable to understand the request.

Error Codes

See Error Codes.

Parent topic:Prometheus Instance