文档首页/ 应用运维管理 AOM/ API参考/ API/ Prometheus实例/ 修改Prometheus实例 - UpdatePromInstance
更新时间:2025-11-19 GMT+08:00
分享

修改Prometheus实例 - UpdatePromInstance

功能介绍

该接口用于修改Prometheus实例。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    aom:metric:set

    Write

    -

    -

    -

    -

URI

PUT /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。

Enterprise-Project-Id

String

企业项目id。

  • 更新单个企业项目下实例,填写企业项目id。

表3 请求Body参数

参数

是否必选

参数类型

描述

prom_id

String

待修改的普罗实例id。

prom_limits

PromLimits object

指标存储时长,每天只能修改一次。

prom_name

String

待修改的普罗实例名称,名称不能以下划线或中划线开头和结尾,只含有中文,英文,数字,下划线,中划线,长度1-100。

aggr_prometheus_info

Array of AggrPrometheusInfo objects

被聚合的账号和普罗实例列表。

表4 PromLimits

参数

是否必选

参数类型

描述

compactor_blocks_retention_period

String

指标存储时长,只支持 15天,30天,60天 ,90天

枚举值:

  • "360h"

  • "720h"

  • "1440h"

  • "2160h"

表5 AggrPrometheusInfo

参数

是否必选

参数类型

描述

project_id

String

被聚合的账号的projectid。

prometheusIds

Array of strings

被聚合的账号下的普罗ID列表。

id

String

被聚合的账号id。

name

String

被聚合的账号名称。

响应参数

状态码:200

表6 响应Body参数

参数

参数类型

描述

count

Long

普罗实例总数。

prometheus

Array of PromInstanceEpsModel objects

普罗实例列表名称。

表7 PromInstanceEpsModel

参数

参数类型

描述

prom_name

String

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

prom_id

String

Prometheus实例id。

prom_type

String

Prometheus实例类型。

  • default:默认普罗实例

  • ECS:Prometheus for ECS

  • CCE:Prometheus for CCE

  • REMOTE_WRITE:Prometheus 通用实例

  • CLOUD_SERVICE:Prometheus for 云服务

  • ACROSS_ACCOUNT:Prometheus for 多账号聚合实例 (暂不支持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。

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

应用详情。

表8 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。

表9 PromLimits

参数

参数类型

描述

compactor_blocks_retention_period

String

指标存储时长,只支持 15天,30天,60天 ,90天

枚举值:

  • "360h"

  • "720h"

  • "1440h"

  • "2160h"

表10 ApplicationModel

参数

参数类型

描述

app_id

String

应用id。

app_name

String

应用名称。

app_type

String

应用来源。

状态码:400

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误信息。

error_type

String

错误类型。

trace_id

String

链路id。

状态码:401

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误信息。

error_type

String

错误类型。

trace_id

String

链路id。

状态码:500

表13 响应Body参数

参数

参数类型

描述

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" : ""
}

SDK代码示例

SDK代码示例如下。

更新Prometheus实例名称和指标存储时长。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.aom.v2.region.AomRegion;
import com.huaweicloud.sdk.aom.v2.*;
import com.huaweicloud.sdk.aom.v2.model.*;


public class UpdatePromInstanceSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        AomClient client = AomClient.newBuilder()
                .withCredential(auth)
                .withRegion(AomRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdatePromInstanceRequest request = new UpdatePromInstanceRequest();
        UpdatePromInstanceRequestModle body = new UpdatePromInstanceRequestModle();
        PromLimits promLimitsbody = new PromLimits();
        promLimitsbody.withCompactorBlocksRetentionPeriod(PromLimits.CompactorBlocksRetentionPeriodEnum.fromValue("720h"));
        body.withPromName("aomPrometheus");
        body.withPromLimits(promLimitsbody);
        body.withPromId("a4a3****-****-4ef6-****-****d1cc****");
        request.withBody(body);
        try {
            UpdatePromInstanceResponse response = client.updatePromInstance(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

更新Prometheus实例名称和指标存储时长。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkaom.v2.region.aom_region import AomRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkaom.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = AomClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(AomRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdatePromInstanceRequest()
        promLimitsbody = PromLimits(
            compactor_blocks_retention_period="720h"
        )
        request.body = UpdatePromInstanceRequestModle(
            prom_name="aomPrometheus",
            prom_limits=promLimitsbody,
            prom_id="a4a3****-****-4ef6-****-****d1cc****"
        )
        response = client.update_prom_instance(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

更新Prometheus实例名称和指标存储时长。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    aom "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := aom.NewAomClient(
        aom.AomClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdatePromInstanceRequest{}
	promLimitsbody := &model.PromLimits{
		CompactorBlocksRetentionPeriod: model.GetPromLimitsCompactorBlocksRetentionPeriodEnum().E_720H,
	}
	promNameUpdatePromInstanceRequestModle:= "aomPrometheus"
	request.Body = &model.UpdatePromInstanceRequestModle{
		PromName: &promNameUpdatePromInstanceRequestModle,
		PromLimits: promLimitsbody,
		PromId: "a4a3****-****-4ef6-****-****d1cc****",
	}
	response, err := client.UpdatePromInstance(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK 请求响应成功。

400

BadRequest 非法请求。建议直接修改该请求,不要重试该请求。

401

Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。

500

InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。

错误码

请参见错误码

相关文档