Modifying a Prometheus Instance
Function
This API is used to modify a Prometheus instance.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
aom:metric:set
Write
-
-
-
-
URI
PUT /v1/{project_id}/aom/prometheus
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID obtained from IAM. Generally, a project ID contains 32 characters. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
User token obtained from IAM. |
|
Content-Type |
Yes |
String |
Content type, which is application/json. |
|
Enterprise-Project-Id |
Yes |
String |
Enterprise project ID. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
prom_id |
Yes |
String |
ID of the Prometheus instance to be modified. |
|
prom_limits |
No |
PromLimits object |
Metric storage duration, which can be modified only once a day. |
|
prom_name |
No |
String |
Name of the target Prometheus instance. Enter 1–100 characters and do not start or end with an underscore (_) or hyphen (-). Only letters, digits, underscores, and hyphens are allowed. |
|
aggr_prometheus_info |
No |
Array of AggrPrometheusInfo objects |
List of accounts and Prometheus instances for aggregation. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
compactor_blocks_retention_period |
Yes |
String |
Metric storage duration. Only 15, 30, 60, and 90 days are supported. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID of the account for aggregation. |
|
prometheusIds |
Yes |
Array of strings |
Prometheus ID list of the account for aggregation. |
|
id |
Yes |
String |
ID of the account for aggregation. |
|
name |
Yes |
String |
Name of the account for aggregation. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
count |
Long |
Total number of Prometheus instances. |
|
prometheus |
Array of PromInstanceEpsModel objects |
List of Prometheus instance names. |
|
Parameter |
Type |
Description |
|---|---|---|
|
prom_name |
String |
Prometheus instance name. Enter 1–100 characters and do not start or end with an underscore (_) or hyphen (-). Only letters, digits, underscores, and hyphens are allowed. |
|
prom_id |
String |
Prometheus instance ID. |
|
prom_type |
String |
Prometheus instance type. Options: |
|
prom_version |
String |
Prometheus instance version. |
|
prom_create_timestamp |
Long |
Timestamp when the Prometheus instance is created. |
|
prom_update_timestamp |
Long |
Timestamp when the Prometheus instance is updated. |
|
prom_status |
String |
Definition Prometheus instance status. Range |
|
enterprise_project_id |
String |
Enterprise project that the Prometheus instance belongs to. |
|
project_id |
String |
ID of the project that the Prometheus instance belongs to. |
|
is_deleted_tag |
Long |
Whether an instance has been deleted. |
|
deleted_time |
Long |
Deletion time. |
|
prom_spec_config |
PromConfigModel object |
Special configuration of the Prometheus instance. |
|
cce_spec_config |
String |
Special configuration of the Prometheus instance in the CCE scenario. |
|
prom_limits |
PromLimits object |
Prometheus instance limitations. |
|
limits_update_time |
Long |
Time when the metric storage duration was modified. |
|
application |
ApplicationModel object |
Application details. |
|
Parameter |
Type |
Description |
|---|---|---|
|
remote_write_url |
String |
Remote write address of the Prometheus instance. |
|
remote_read_url |
String |
Remote read address of the Prometheus instance. |
|
prom_http_api_endpoint |
String |
URL for calling the Prometheus instance. |
|
dashboard_id |
String |
ID of the dashboard associated with the Prometheus instance (not used currently). |
|
region_id |
String |
Region that the Prometheus instance belongs to. |
|
Parameter |
Type |
Description |
|---|---|---|
|
compactor_blocks_retention_period |
String |
Metric storage duration. Only 15, 30, 60, and 90 days are supported. |
|
Parameter |
Type |
Description |
|---|---|---|
|
app_id |
String |
Application ID. |
|
app_name |
String |
Application name. |
|
app_type |
String |
Definition Source of the application. Range |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
|
error_type |
String |
Error type. |
|
trace_id |
String |
Trace ID. |
Status code: 401
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
|
error_type |
String |
Error type. |
|
trace_id |
String |
Trace ID. |
Status code: 500
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
|
error_type |
String |
Error type. |
|
trace_id |
String |
Trace ID. |
Example Requests
Modify the Prometheus instance name and metric storage duration.
https://{Endpoint}/v1/{project_id}/aom/prometheus
{
"prom_id" : "a4a3****-****-4ef6-****-****d1cc****",
"prom_limits" : {
"compactor_blocks_retention_period" : "720h"
},
"prom_name" : "aomPrometheus"
}
Example Responses
Status code: 200
OK: The request is successful.
{
"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
} ]
}
Status code: 400
Bad Request: Invalid request. The client should not repeat this request without modification.
{
"error_code" : "AOM.11016014",
"error_msg" : "prom instance not found",
"trace_id" : ""
}
Status code: 401
Unauthorized: The authorization information provided by the client is incorrect or invalid.
{
"error_code" : "SVCSTG.AMS.4010000",
"error_msg" : "auth failed.",
"error_type" : "AUTH_FAILED",
"trace_id" : null
}
Status code: 500
Internal Server Error: The server is able to receive the request but unable to understand the request.
{
"error_code" : "APM.00000500",
"error_msg" : "Internal Server Error",
"trace_id" : ""
}
SDK Sample Code
The SDK sample code is as follows.
Java
Modify the Prometheus instance name and metric storage duration.
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()); } } } |
Python
Modify the Prometheus instance name and metric storage duration.
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) |
Go
Modify the Prometheus instance name and metric storage duration.
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) } } |
More
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
OK: The request is successful. |
|
400 |
Bad Request: Invalid request. The client should not repeat this request without modification. |
|
401 |
Unauthorized: The authorization information provided by the client is incorrect or invalid. |
|
500 |
Internal Server Error: The server is able to receive the request but unable to understand the request. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot