更新时间:2024-06-28 GMT+08:00

新增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实例类型(暂时不支持VPC、KUBERNETES)。

枚举值:

  • ECS

  • VPC

  • CCE

  • REMOTE_WRITE

  • KUBERNETES

  • CLOUD_SERVICE

  • ACROSS_ACCOUNT

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-****-*.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
  } ]
}

SDK代码示例

SDK代码示例如下。

新增Prometheus类型为CCE的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
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 CreatePromInstanceSolution {

    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");

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

        AomClient client = AomClient.newBuilder()
                .withCredential(auth)
                .withRegion(AomRegion.valueOf("<YOUR REGION>"))
                .build();
        CreatePromInstanceRequest request = new CreatePromInstanceRequest();
        PromInstanceRequestModel body = new PromInstanceRequestModel();
        body.withPromType(PromInstanceRequestModel.PromTypeEnum.fromValue("CCE"));
        body.withPromName("aom_prometheus");
        request.withBody(body);
        try {
            CreatePromInstanceResponse response = client.createPromInstance(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类型为CCE的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
# 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"]

    credentials = BasicCredentials(ak, sk)

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

    try:
        request = CreatePromInstanceRequest()
        request.body = PromInstanceRequestModel(
            prom_type="CCE",
            prom_name="aom_prometheus"
        )
        response = client.create_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类型为CCE的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
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")

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

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

    request := &model.CreatePromInstanceRequest{}
	request.Body = &model.PromInstanceRequestModel{
		PromType: model.GetPromInstanceRequestModelPromTypeEnum().CCE,
		PromName: "aom_prometheus",
	}
	response, err := client.CreatePromInstance(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

OK 请求响应成功。

错误码

请参见错误码