修改Prometheus实例
功能介绍
该接口用于修改Prometheus实例。
调用方法
请参见如何调用API。
URI
PUT /v1/{project_id}/aom/prometheus
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
租户从IAM申请到的projectid，一般为32位字符串。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token。 |
|
Content-Type |
是 |
String |
指定类型为application/json。 |
|
Enterprise-Project-Id |
是 |
String |
企业项目id。
|
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
prom_id |
是 |
String |
待修改的普罗实例id。 |
|
prom_limits |
否 |
PromLimits object |
指标存储时长,每天只能修改一次。 |
|
prom_name |
否 |
String |
待修改的普罗实例名称，名称不能以下划线或中划线开头和结尾，只含有中文，英文，数字，下划线，中划线，长度1-100。 |
|
aggr_prometheus_info |
否 |
Array of AggrPrometheusInfo objects |
被聚合的账号和普罗实例列表。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
count |
Long |
普罗实例总数。 |
|
prometheus |
Array of PromInstanceEpsModel objects |
普罗实例列表名称。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
prom_name |
String |
Prometheus实例名称 名称不能以下划线或中划线开头结尾，只含有中文、英文、数字、下划线、中划线、长度1-100。 |
|
prom_id |
String |
Prometheus实例id。 |
|
prom_type |
String |
Prometheus实例类型。
|
|
prom_version |
String |
Prometheus实例版本号。 |
|
prom_create_timestamp |
Long |
Prometheus实例创建时间戳。 |
|
prom_update_timestamp |
Long |
Prometheus实例更新时间戳。 |
|
prom_status |
String |
Prometheus实例状态。 枚举值：
|
|
enterprise_project_id |
String |
Prometheus实例所属的企业项目。 |
|
project_id |
String |
Prometheus实例所属projectId。 |
|
is_deleted_tag |
Long |
删除标记。 |
|
deleted_time |
Long |
删除时间。 |
|
prom_spec_config |
PromConfigModel object |
Prometheus实例所属特定配置。 |
|
cce_spec_config |
String |
Prometheus实例所属CCE特殊配置。 |
|
prom_limits |
PromLimits object |
Prometheus实例限制。 |
|
limits_update_time |
Long |
指标存储周期修改时间。 |
|
application |
ApplicationModel object |
应用详情。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
compactor_blocks_retention_period |
String |
指标存储时长，只支持 15天，30天，60天 ，90天 枚举值：
|
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误信息。 |
|
error_type |
String |
错误类型。 |
|
trace_id |
String |
链路id。 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误信息。 |
|
error_type |
String |
错误类型。 |
|
trace_id |
String |
链路id。 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误信息。 |
|
error_type |
String |
错误类型。 |
|
trace_id |
String |
链路id。 |
请求示例
更新Prometheus实例名称和指标存储时长。
https://{Endpoint}/v1/{project_id}/aom/prometheus
{
"prom_id" : "a4a3****-****-4ef6-****-****d1cc****",
"prom_limits" : {
"compactor_blocks_retention_period" : "720h"
},
"prom_name" : "aomPrometheus"
}响应示例
状态码：200
OK 请求响应成功。
{
"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
} ]
}状态码：400
BadRequest 非法请求。建议直接修改该请求，不要重试该请求。
{
"error_code" : "AOM.11016014",
"error_msg" : "prom instance not found",
"trace_id" : ""
}状态码：401
Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。
{
"error_code" : "SVCSTG.AMS.4010000",
"error_msg" : "auth failed.",
"error_type" : "AUTH_FAILED",
"trace_id" : null
}状态码：500
InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。
{
"error_code" : "APM.00000500",
"error_msg" : "Internal Server Error",
"trace_id" : ""
}状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK 请求响应成功。 |
|
400 |
BadRequest 非法请求。建议直接修改该请求，不要重试该请求。 |
|
401 |
Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 |
|
500 |
InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。 |
错误码
请参见错误码。
