InstallManagedPrometheus - Application Real-Time Monitoring Service

Installs a Prometheus agent for serverless Kubernetes (ASK) clusters or Elastic Compute Service (ECS) clusters.

Operation description

You can call this operation only if the following conditions are met: The resources that you want to monitor are ASK clusters or ECS clusters. No Prometheus agents are installed in the ASK or ECS clusters. Take note that Prometheus agents can be installed only on the cloud service side, not in user clusters.

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:InstallManagedPrometheus	none	Prometheus acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-hangzhou
ClusterId	string	No	The ID of the ASK cluster.	cc7a37ee31aea4ed1a059eff8034b****
ClusterName	string	No	The name of the cluster. This parameter is required if the ClusterType parameter is set to ecs.	prd-ecs
ClusterType	string	Yes	The cluster type. Valid values: ecs: ECS one: ACK One ask: ASK pro: Container Monitoring Pro	ask
VpcId	string	Yes	The virtual private cloud (VPC) where the cluster resides.	vpc-xxxxxx
VSwitchId	string	Yes	The ID of the vSwitch that is used by the cluster.	vsw-bp1*********
SecurityGroupId	string	Yes	The ID of the security group to which the cluster belongs.	sg-bp1********
GrafanaInstanceId	string	No	The ID of the managed Grafana workspace that is associated with the cluster. If you set this parameter to free or leave this parameter empty, the cluster is associated with a shared Grafana workspace.	grafana-bp1*****
KubeConfig	string	No	This parameter is not supported.	-

Response parameters

Parameter	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	String 2A0CEDF1-06FE-44AC-8E21-21A5BE65****
Data	string	The response content. In most cases, the installation status of the Prometheus agent is returned.	success
Success	boolean	Indicates whether the Prometheus agent was installed.	true
Message	string	The error message returned if the Prometheus agent failed to be installed.	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": "String\t2A0CEDF1-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
2024-01-03	The Error code has changed	View Change Details
2023-09-10	The Error code has changed	View Change Details
2023-05-15	API Description Update. The Error code has changed	View Change Details
2022-11-28	The Error code has changed	View Change Details
2022-11-28	The Error code has changed	View Change Details
2022-01-04	Add Operation	View Change Details