UninstallManagedPrometheus - Application Real-Time Monitoring Service

Uninstalls a Prometheus agent.

Operation description

This operation is available only for ASK, ECS, and ACK One clusters. Before you call this operation, make sure that a managed Prometheus agent is installed for your cluster.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
arms:UninstallManagedPrometheus	none	Prometheus acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
ClusterId	string	No	The ID of the Container Service for Kubernetes (ACK) cluster. This parameter is required when the ClusterType parameter is set to ask or one.	cc7a37ee31aea4ed1a059eff8034b****
ResourceGroupId	string	No	The ID of the resource group to which the Prometheus instance belongs.	rg-acfmxyexli2****
ClusterType	string	Yes	The cluster type. Valid values: ask, ecs, and one.	ask
VpcId	string	No	The ID of the virtual private cloud (VPC) where the cluster resides.	vpc-rpn**********

Response parameters

Parameter	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	2A0CEDF1-06FE-44AC-8E21-21A5BE65****
Data	string	The response content. The status of the Prometheus instance is returned.	success
Success	boolean	Indicates whether the Prometheus instance was removed.	true
Message	string	The error message that is returned if the request fails.	vpcId is blank
Code	integer	The status code. The status code 200 indicates that the request was successful. If another status code is returned, the request failed.	200

Examples

Sample success responses

JSONformat

{
  "RequestId": "2A0CEDF1-06FE-44AC-8E21-21A5BE65****",
  "Data": "success",
  "Success": true,
  "Message": "vpcId is blank",
  "Code": 200
}

Error codes

HTTP status code	Error code	Error message
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-08-05	The API operation is deprecated. The Error code has changed	View Change Details
2023-12-06	The Error code has changed	View Change Details
2023-09-10	The Error code has changed	View Change Details
2023-05-15	The Error code has changed	View Change Details
2022-01-04	Add Operation	View Change Details