Adding a Prometheus Instance

Updated on 2025-01-07 GMT+08:00

View PDF

Function

This API is used to add a Prometheus instance.

Calling Method

For details, see Calling APIs.

URI

POST /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.
region	Yes	String	Region to which the Prometheus instance belongs. Generally, it is the domain name or IP address of the server bearing the REST service endpoint. This parameter varies depending on the service and region.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
prom_name	Yes	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_type	Yes	String	Prometheus instance type (VPC and KUBERNETES are not supported). Enumeration values: ECS VPC CCE REMOTE_WRITE KUBERNETES
prom_version	No	String	Prometheus instance version.
enterprise_project_id	No	String	Enterprise project that the Prometheus instance belongs to.
project_id	No	String	ID of the project that the Prometheus instance belongs to.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
prometheus	Array of PromInstanceEpsCreateModel objects	Prometheus instance list.

**Table 5** PromInstanceEpsCreateModel
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 (VPC and KUBERNETES are not supported). Enumeration values: ECS VPC CCE REMOTE_WRITE KUBERNETES
prom_version	String	Prometheus instance version.
prom_create_timestamp	Long	Timestamp when the Prometheus instance was created.
prom_update_timestamp	Long	Timestamp when the Prometheus instance was 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.
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.

**Table 6** 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.

Example Requests

Add a Prometheus instance for CCE.

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

{
  "prom_type" : "CCE",
  "prom_name" : "aom_prometheus"
}

Example Responses

Status code: 200

OK: The request is successful.

{
  "prometheus" : [ {
    "deleted_time" : 0,
    "enterprise_project_id" : "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-****-*.myhuaweicloud.com:***/v1/2a4***56cc***7f837***891***c1cf/08****2a-8**b-4**5-b**1-d1********79",
      "remote_read_url" : "aom-internal.cn-****-*.myhuaweicloud.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-****-*.myhuaweicloud.com:***/v1/2a4***56cc***7f837***891***c1cf/08****2a-8**b-4**5-b**1-d1********79/push",
      "region_id" : "cn-****-*"
    },
    "prom_type" : "CCE",
    "prom_update_timestamp" : 1691718171483
  } ]
}