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 |
No |
String |
Content type, which is application/json. |
Enterprise-Project-Id |
Yes |
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. |
prom_limits |
PromLimits object |
Prometheus instance limitations. |
limits_update_time |
Long |
Time when the metric storage duration was modified. |
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-****-*.***.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 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