# 新增Prometheus实例 - CreatePromInstance #### 功能介绍 该接口用于新增Prometheus实例。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-aom/aom_04_0057.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-aom/aom_04_0031.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | aom:metric:put | Write | - | - | - | - | #### 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。 | | aggr_prometheus_info | 否 | Array of [AggrPrometheusInfo] objects | 被聚合的账号和普罗实例列表。 | 表4AggrPrometheusInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 被聚合的账号的projectid。 | | prometheusIds | 是 | Array of strings | 被聚合的账号下的普罗ID列表。 | | id | 是 | String | 被聚合的账号id。 | | name | 是 | String | 被聚合的账号名称。 | #### 响应参数 **状态码：200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | prometheus | Array of [PromInstanceEpsCreateModel] objects | Prometheus实例名称列表。 | 表6PromInstanceEpsCreateModel | 参数 | 参数类型 | 描述 | |:---|:---|:---| | prom_name | String | Prometheus实例名称 名称不能以下划线或中划线开头结尾，只含有中文、英文、数字、下划线、中划线、长度1-100。 | | prom_id | String | Prometheus实例id。 | | prom_type | String | **参数解释**： Prometheus实例类型（暂时不支持VPC、KUBERNETES）。 **取值范围**： ECS：Prometheus for ECS。 VPC：Prometheus for VPC。 CCE：Prometheus for CCE。 REMOTE_WRITE：Prometheus 通用实例。 KUBERNETES：Prometheus for KUBERNETES。 CLOUD_SERVICE：Prometheus for 云服务。 ACROSS_ACCOUNT：Prometheus for 多账号聚合实例。 | | 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特殊配置。 | 表7PromConfigModel | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 } ] } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 新增Prometheus类型为CCE的Prometheus实例。 ``` 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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); AomClient client = AomClient.newBuilder() .withCredential(auth) .withRegion(AomRegion.valueOf("")) .build(); CreatePromInstanceRequest request = new CreatePromInstanceRequest(); PromInstanceRequestModel body = new PromInstanceRequestModel(); body.withPromType("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()); } } } ``` - [Python] 新增Prometheus类型为CCE的Prometheus实例。 ``` # 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("")) \ .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) ``` - [Go] 新增Prometheus类型为CCE的Prometheus实例。 ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := aom.AomClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := aom.NewAomClient(hcClient) request := &model.CreatePromInstanceRequest{} request.Body = &model.PromInstanceRequestModel{ PromType: "CCE", PromName: "aom_prometheus", } response, err := client.CreatePromInstance(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/AOM/sdk?api=CreatePromInstance)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK 请求响应成功。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-aom/ErrorCode.html)。