ListEnvironmentFeatures - Managed Service for Prometheus

Queries the features in an environment.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:ListEnvironmentFeatures	none	Environment acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
EnvironmentId	string	Yes	The environment ID.	env-xxx
RegionId	string	No	The region ID.	cn-hangzhou
AliyunLang	string	No	The language. Default value: zh. Valid values: en: English. zh: Chinese.	en

Response parameters

Parameter	Type	Description	Example
	object	response
RequestId	string	Id of the request	40B10E04-81E8-4643-970D-F1B38F2E****
Code	integer	Status Code. Description 200 indicates success.	200
Message	string	The returned message.	success
Success	boolean	Indicates whether the alert rule was deleted. Valid values: `true`: The alert rule was deleted. `false`: The alert rule failed to be deleted.	true
Data	array<object>	The returned struct.
	object	The returned struct.
Config	object	The feature configuration.
	string	The feature configuration.	{}
Description	string	The description of the feature.	Collect Metric data using the Prometheus collection specification.
EnvironmentId	string	The ID of the environment instance.	env-xxxxx
Language	string	The language. Valid values: zh: Chinese en: English	zh
LatestVersion	string	The latest version number.	1.1.17
Name	string	The name of the feature.	metric-agent
Status	string	The status of the feature. Valid values: Installing: The agent is being installed. Success: The agent is installed. Failed: The agent failed to be installed. UnInstall: The agent is uninstalled. Uninstalling: The agent is being uninstalled. UnInstallFailed: The agent failed to be uninstalled.	Success
Version	string	The version of the feature.	1.1.17
Alias	string	The alias of the feature.	Prometheus Agent
Icon	string	The URL of the icon.	http://xxx
Managed	boolean	Indicates whether the component is fully managed.	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "40B10E04-81E8-4643-970D-F1B38F2E****",
  "Code": 200,
  "Message": "success",
  "Success": true,
  "Data": [
    {
      "Config": {
        "key": "{}"
      },
      "Description": "Collect Metric data using the Prometheus collection specification.",
      "EnvironmentId": "env-xxxxx",
      "Language": "zh",
      "LatestVersion": "1.1.17",
      "Name": "metric-agent",
      "Status": "Success",
      "Version": "1.1.17",
      "Alias": "Prometheus Agent",
      "Icon": "http://xxx",
      "Managed": true
    }
  ]
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-05-23	The request parameters of the API has changed	View Change Details
2024-01-23	The response structure of the API has changed	View Change Details