Querying a Prometheus Instance
Function
This API is used to query 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:list
List
-
-
aom:metric:get
-
URI
GET /v1/{project_id}/aom/prometheus
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition Project ID, which can be obtained from the console or by calling an API. For details, see Obtaining a Project ID. Constraints N/A. Range N/A. Default Value N/A. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| prom_id | No | String | Definition Prometheus instance ID. If both prom_id and prom_type exist, only prom_id takes effect. Constraints N/A. Range N/A. Default Value N/A. |
| prom_type | No | String | Definition Prometheus instance type (VPC and KUBERNETES are not supported). Constraints N/A. Range Default Value N/A. |
| cce_cluster_enable | No | String | Definition Whether to enable a CCE cluster. Constraints N/A. Range N/A. Default Value N/A. |
| prom_status | No | String | Definition Prometheus instance status. Constraints N/A Range Default Value N/A |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | Definition User token obtained from IAM. For details, see Obtaining a Token. Constraints N/A. Range Min. characters: 1 Max. characters: 40,960 Default Value N/A. |
| Content-Type | Yes | String | Definition Message body type or format. The specified type is application/json. Constraints N/A. Range Fixed value. Default Value application/json |
| Enterprise-Project-Id | Yes | String | Definition Enterprise project ID. Constraints N/A. Range
Default Value N/A. |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| prometheus | Array of PromInstanceEpsModel objects | Definition Prometheus instance list. Range N/A. |
| Parameter | Type | Description |
|---|---|---|
| prom_name | String | Definition 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. Range N/A. |
| prom_id | String | Definition Prometheus instance ID. Range N/A. |
| prom_type | String | Definition Prometheus instance type. Range |
| prom_version | String | Definition Prometheus instance version. Range N/A. |
| prom_create_timestamp | Long | Definition Timestamp when the Prometheus instance was created. Range N/A. |
| prom_update_timestamp | Long | Definition Timestamp when the Prometheus instance was updated. Range N/A. |
| prom_status | String | Definition Prometheus instance status. Range |
| enterprise_project_id | String | Definition Enterprise project that the Prometheus instance belongs to. Range N/A. |
| project_id | String | Definition ID of the project that the Prometheus instance belongs to. Range N/A. |
| is_deleted_tag | Long | Definition Whether an instance has been deleted. Range N/A. |
| 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. |
| enable_downsample | Boolean | Whether to enable downsampling. Default: false (downsampling is disabled). |
| downsample_start_time | Long | Downsampling start time. |
| application | ApplicationModel object | Application details. |
| aggr_prometheus_info | Array of AggrPrometheusInfo objects | List of accounts and Prometheus instances to be aggregated. Only AGGR_REMOTE_READ involves this parameter. |
| description | String | Description. |
| prom_tags | Object | Prometheus tag. |
| agency_spec_config | Object | Metric forwarding configuration. |
| 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. |
Example Requests
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-****-*.***.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
} ]
} 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 | 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"); 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(); ListPromInstanceRequest request = new ListPromInstanceRequest(); 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 | # 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 = ListPromInstanceRequest() 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 44 45 46 47 48 49 | 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("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := aom.NewAomClient(hcClient) request := &model.ListPromInstanceRequest{} 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.
What is your overall rating for this page?
Thank 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