ListEnvironmentAddons API Reference - ARMS - Alibaba Cloud - Application Real-Time Monitoring Service

Lists the add-ons installed in a specified environment.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

arms:ListEnvironmentAddons

none

*Environment

acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}

None

Request parameters

Parameter	Type	Required	Description	Example
EnvironmentId	string	Yes	The environment ID.	env-xxx
RegionId	string	No	The region ID.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	32940175-181B-4B93-966E-4BB69176****
Code	integer	The status code.	200
Message	string	The message returned.	message
Success	boolean	Indicates whether the operation was successful. Valid values are `true` if the operation succeeded and `false` if it failed.	true
Data	object	The returned data.
Addons	array<object>	The list of addons.
	array<object>	The addon details.
Alias	string	The alias of the addon.	MySQL
Categories	array	The list of addon tags.
	string	A tag for the addon.	cloud
Dashboards	array<object>	The list of dashboards.
	object	The dashboard details.
Description	string	The description of the dashboard.	MySQL监控大盘信息,监控了连接信息,使用信息等指标
Name	string	The name of the dashboard.	mysql-overview
Url	string	The URL of the dashboard.	http://xxxx
Description	string	The description of the addon.	通过 MySQL Exporter 监控数据库指标
Environments	array<object>	The list of supported environments.
	array<object>	The environment details.
Dependencies	object	The dependencies of the addon within the environment.
Features	object	The features available for installation in the environment.
	boolean	Indicates whether the feature is supported.	true
Services	array	The dependent services.
	string	The name of the service.	ResourceCenter
ClusterTypes	array	The required cluster types.
	string	The cluster type.	Edge
Description	string	The description of the environment.	MySQL 服务部署在 Kubernetes 集群中。
Enable	boolean	Indicates whether the addon is supported in this environment.	true
Label	string	The label of the environment.	容器环境
Name	string	The name of the environment.	CS
Policies	object	The policies related to the addon in this environment.
AlertDefaultStatus	string	The default status of the alert.	default
DefaultInstall	boolean	Indicates whether the addon is installed by default in the environment.	false
TargetAddonName	string	The target name of the addon.	cloud-rds-mysql
Protocols	array<object>	The list of supported protocols.
	object	A supported protocol.
Name	string	The name of the protocol.	arms
Icon	string	The URL of the protocol icon.	http://xxxxxxx
Label	string	The label of the protocol.	ARMS
Description	string	The description of the protocol.	ARMS
MetricCheckRule	object	The rules for checking metric status.
PromQL	array	The PromQL query statements.
	string	The PromQL query statement.	max(flink_taskmanager_job_task_operator_currentEmitEventTimeLag{deploymentId='983d8f2d-14a9-4af0-a23d-751a7818c239'}/1000) >= 600.0
NeedRestartAfterIntegration	boolean	Indicates whether a restart is required after the addon is installed.	true
EnableServiceAccount	boolean	Indicates whether a service account is enabled for the addon.	true
Icon	string	The URL of the addon icon.	http://xxxx
Keywords	array	The keywords for the addon.
	string	A keyword for the addon.	Java
Language	string	The language of the addon metadata.	zh
Name	string	The name of the addon.	mysql
Once	boolean	Indicates whether the addon can be installed only once per environment.	false
Scene	string	The application scenario of the addon.	database
Version	string	The addon version.	0.0.1
Weight	string	The weight of the addon, which is used for sorting in the UI.	857
LatestReleaseCreateTime	string	The creation time of the latest release of the addon.	2023-09-22T16:56:29+08:00
Total	integer	The total number of entries.	1
ContainsV2Addon	boolean	Indicates whether the list contains V2 addons.

Examples

Success response

JSON format

{
  "RequestId": "32940175-181B-4B93-966E-4BB69176****",
  "Code": 200,
  "Message": "message",
  "Success": true,
  "Data": {
    "Addons": [
      {
        "Alias": "MySQL",
        "Categories": [
          "cloud"
        ],
        "Dashboards": [
          {
            "Description": "MySQL监控大盘信息,监控了连接信息,使用信息等指标",
            "Name": "mysql-overview",
            "Url": "http://xxxx"
          }
        ],
        "Description": "通过 MySQL Exporter 监控数据库指标",
        "Environments": [
          {
            "Dependencies": {
              "Features": {
                "key": true
              },
              "Services": [
                "ResourceCenter"
              ],
              "ClusterTypes": [
                "Edge"
              ]
            },
            "Description": "MySQL 服务部署在 Kubernetes 集群中。",
            "Enable": true,
            "Label": "容器环境",
            "Name": "CS",
            "Policies": {
              "AlertDefaultStatus": "default",
              "DefaultInstall": false,
              "TargetAddonName": "cloud-rds-mysql",
              "Protocols": [
                {
                  "Name": "arms",
                  "Icon": "http://xxxxxxx",
                  "Label": "ARMS",
                  "Description": "ARMS"
                }
              ],
              "MetricCheckRule": {
                "PromQL": [
                  "max(flink_taskmanager_job_task_operator_currentEmitEventTimeLag{deploymentId='983d8f2d-14a9-4af0-a23d-751a7818c239'}/1000) >= 600.0"
                ]
              },
              "NeedRestartAfterIntegration": true,
              "EnableServiceAccount": true
            }
          }
        ],
        "Icon": "http://xxxx",
        "Keywords": [
          "Java"
        ],
        "Language": "zh",
        "Name": "mysql",
        "Once": false,
        "Scene": "database",
        "Version": "0.0.1",
        "Weight": "857",
        "LatestReleaseCreateTime": "2023-09-22T16:56:29+08:00"
      }
    ],
    "Total": 1,
    "ContainsV2Addon": false
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.