InstallCmsExporter - Application Real-Time Monitoring Service

Installs the cms-exporter collector.

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	Association operation
arms:InstallCmsExporter	Write	ARMS acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region.	cn-beijing
ClusterId	string	Yes	The ID of the cluster.	cc7a37ee31aea4ed1a059eff8034b****
CmsArgs	string	Yes	The cloud services that you want to monitor. The CmsArgs parameter is the startup parameter of the cms-exporter collector. Separate multiple cloud services with number signs (`#`).	hologres#cen
EnableTag	boolean	No	Specifies whether to collect the aliyun tags attached to each cloud service. Default value: false.	false
DirectArgs	string	Yes	The recently monitored cloud services. Separate multiple cloud services with number signs (`#`).	hologres#cen

Response parameters

Parameter	Type	Description	Example
	object	The struct returned.
RequestId	string	The ID of the request. You can query logs and troubleshoot issues based on the ID.	E7A04B0D-E2CA-59BB-8A9D-D5D349C22BF1
Data	string	Indicates whether the request was successful.	success

Examples

Sample success responses

JSONformat

{
  "RequestId": "E7A04B0D-E2CA-59BB-8A9D-D5D349C22BF1",
  "Data": "success"
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history