文档首页/ 应用运维管理 AOM/ API参考（吉隆坡区域）/ API/ Prometheus实例/ 新增Prometheus实例
更新时间：2025-08-07 GMT+08:00
在线调试
CLI示例
查看PDF
分享

新增Prometheus实例

功能介绍

该接口用于新增Prometheus实例。

调用方法

请参见如何调用API。

URI

POST /v1/{project_id}/aom/prometheus

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户从IAM申请到的projectid，一般为32位字符串。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

从IAM服务获取的用户Token。

Content-Type

是

String

指定类型为application/json。

region

是

String

Prometheus实例所属Region，一般为承载REST服务端点的服务器域名或IP，不同服务不同区域的名称不同。
表3 请求Body参数

参数

是否必选

参数类型

描述

prom_name

是

String

Prometheus实例名称 名称不能以下划线或中划线开头结尾，只含有中文、英文、数字、下划线、中划线、长度1-100。

prom_type

是

String

Prometheus实例类型。

  • ECS：Prometheus for ECS

  • CCE：Prometheus for CCE

  • REMOTE_WRITE：Prometheus 通用实例

  • CLOUD_SERVICE：Prometheus for 云服务

  • ACROSS_ACCOUNT：Prometheus for 多账号聚合实例

prom_version

否

String

Prometheus实例版本号。

enterprise_project_id

否

String

Prometheus实例所属的企业项目。

project_id

否

String

Prometheus实例所属projectId。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

prometheus

Array of PromInstanceEpsCreateModel objects

Prometheus实例名称列表。
表5 PromInstanceEpsCreateModel

参数

参数类型

描述

prom_name

String

Prometheus实例名称 名称不能以下划线或中划线开头结尾，只含有中文、英文、数字、下划线、中划线、长度1-100。

prom_id

String

Prometheus实例id。

prom_type

String

Prometheus实例类型（暂时不支持VPC、KUBERNETES）。

枚举值：

  • ECS

  • VPC

  • CCE

  • REMOTE_WRITE

  • KUBERNETES

  • CLOUD_SERVICE

  • ACROSS_ACCOUNT

prom_version

String

Prometheus实例版本号。

prom_create_timestamp

Long

Prometheus实例创建时间戳。

prom_update_timestamp

Long

Prometheus实例更新时间戳。

prom_status

String

Prometheus实例状态。

枚举值：

  • DELETED

  • NORMAL

  • ALL

enterprise_project_id

String

Prometheus实例所属的企业项目。

project_id

String

Prometheus实例所属projectId。

deleted_time

Long

删除时间。

prom_spec_config

PromConfigModel object

Prometheus实例所属特定配置。

cce_spec_config

String

Prometheus实例所属CCE特殊配置。
表6 PromConfigModel

参数

参数类型

描述

remote_write_url

String

Prometheus实例remote-write地址。

remote_read_url

String

Prometheus实例remote-read地址。

prom_http_api_endpoint

String

Prometheus实例调用url。

dashboard_id

String

Prometheus实例关联dashboard的dashboard id（目前未使用）。

region_id

String

Prometheus实例所属的region。

请求示例

新增Prometheus类型为CCE的Prometheus实例。

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

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

响应示例

状态码：200

OK 请求响应成功。

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

状态码

状态码

描述

200

OK 请求响应成功。

错误码

请参见错误码。

父主题： Prometheus实例