Uninstalling a Hosted Prometheus Instance

Updated on 2025-01-07 GMT+08:00

Function

This API is used to uninstall a hosted Prometheus instance.

Calling Method

For details, see Calling APIs.

URI

DELETE /v1/{project_id}/aom/prometheus

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID obtained from IAM. Generally, a project ID contains 32 characters.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

prom_id

Yes

String

Prometheus instance ID.

Request Parameters

Table 3 Request header 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.

  • To query instances in an enterprise project, enter the enterprise project ID.

  • To query instances in all enterprise projects, enter all_granted_eps.

Response Parameters

Status code: 400

Table 4 Response body parameters

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

Delete 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.

{
  "08****2a-8**b-4**5-b**1-d1********79" : true
}

Status code: 400

No Prometheus instance is found.

{
  "error_code" : "AOM.11017014",
  "error_msg" : "prom instance not found",
  "trace_id" : ""
}

Status Codes

Status Code

Description

200

OK: The request is successful.

400

No Prometheus instance is found.

Error Codes

See Error Codes.

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback