Querying a Prometheus Instance
Function
This API is used to query a Prometheus instance.
Calling Method
For details, see Calling APIs.
URI
GET /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. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
prom_id |
No |
String |
Prometheus instance ID. If both prom_id and prom_type exist, only prom_id takes effect. |
prom_type |
No |
String |
Prometheus instance type (VPC and KUBERNETES are not supported). Enumeration values:
|
cce_cluster_enable |
No |
String |
Whether to enable a CCE cluster. Enumeration values:
|
prom_status |
No |
String |
Prometheus instance status. Enumeration values:
|
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 |
No |
String |
Enterprise project ID.
|
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
prometheus |
Array of PromInstanceEpsModel objects |
Prometheus instance list. |
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 (VPC and KUBERNETES are not supported). Enumeration values:
|
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 |
Prometheus instance status. Enumeration values:
|
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. |
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. |
Example Requests
- Query a Prometheus instance.
https://{Endpoint}/v1/{project_id}/aom/prometheus
- Query the Prometheus instance whose prom_id is 08****2a-8b-45-b1-d1******79.
https://{Endpoint}/v1/{project_id}/aom/prometheus?prom_id=08****2a-8**b-4**5-b**1-d1********79
Example Responses
Status code: 200
OK: The request is successful.
{ "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", "region_id" : "cn-****-*", "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" }, "prom_type" : "CCE", "prom_update_timestamp" : 1691718171483 } ] }
SDK Sample Code
The SDK sample code is as follows.
Java
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 ListPromInstanceSolution { 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(); ListPromInstanceRequest request = new ListPromInstanceRequest(); request.withPromId("<prom_id>"); request.withPromType(ListPromInstanceRequest.PromTypeEnum.fromValue("<prom_type>")); request.withCceClusterEnable(ListPromInstanceRequest.CceClusterEnableEnum.fromValue("<cce_cluster_enable>")); request.withPromStatus(ListPromInstanceRequest.PromStatusEnum.fromValue("<prom_status>")); try { ListPromInstanceResponse response = client.listPromInstance(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
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 = ListPromInstanceRequest() request.prom_id = "<prom_id>" request.prom_type = "<prom_type>" request.cce_cluster_enable = "<cce_cluster_enable>" request.prom_status = "<prom_status>" response = client.list_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
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 |
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.ListPromInstanceRequest{} promIdRequest:= "<prom_id>" request.PromId = &promIdRequest promTypeRequest:= model.GetListPromInstanceRequestPromTypeEnum().<PROM_TYPE> request.PromType = &promTypeRequest cceClusterEnableRequest:= model.GetListPromInstanceRequestCceClusterEnableEnum().<CCE_CLUSTER_ENABLE> request.CceClusterEnable = &cceClusterEnableRequest promStatusRequest:= model.GetListPromInstanceRequestPromStatusEnum().<PROM_STATUS> request.PromStatus = &promStatusRequest response, err := client.ListPromInstance(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. |
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