ListAddons - Application Real-Time Monitoring Service - Alibaba Cloud Documentation Center

List of access center products.

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:ListAddons	none	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-hangzhou
Search	string	No	A query field can be queried by name or description.	mysql
Regexp	boolean	No	Whether to enable regular matching.	false
AliyunLang	string	No	Language,the default language is Chinese.	zh
Category	string	No	Category filter.	database

Response parameters

Parameter	Type	Description	Example
	object	response
RequestId	string	Id of the request	78901766-3806-4E96-8E47-CFEF59E4****
Code	integer	Status code: 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 queried add-ons.
data	object	The details of the add-on.
Alias	string	The alias of the add-on.	MySQL
Categories	array	The tags of the add-on.
categories	string	The tags.	cloud
Dashboards	array<object>	The dashboards.
dashboards	object	Dashboard details.
Description	string	The description of the dashboard.	MySQL monitors the market information, monitoring the connection information, usage information and other indicators
Name	string	The name of the dashboard.	mysql-overview
Url	string	The URL of the dashboard.	http://xxxx
Description	string	The description of the add-on.	Monitor database indicators with MySQL Exporter
Environments	array<object>	The supported environments.
environments	object	The information about the environment.
Dependencies	object	The dependencies of the environment.
Features	object	The feature on which the environment depends.
	boolean	Indicates whether the feature is supported.	true
Services	array	The services.
services	string	The service name.	ResourceCenter
ClusterTypes	array	The supported cluster types.
clusterTypes	string	The cluster type.	ManagedKubernetes/Serverless
Description	string	The description of the environment.	The MySQL service is deployed in a Kubernetes cluster.
Enable	boolean	Indicates whether the feature is enabled.	true
Label	string	The tag of the environment.	Container
Name	string	The name of the environment.	CS
Policies	object	The control policies in the environment.
AlertDefaultStatus	string	The default alert status.	default
DefaultInstall	boolean	The default installation status.	false
TargetAddonName	string	The target name of the add-on.	cloud-rds-mysql
Protocols	array<object>	The supported protocols.
protocols	object	Protocol details.
Name	string	The name of the protocol.	arms
Label	string	The tag of the protocol.	ARMS
Icon	string	The URL of the protocol icon.	http://xxxxxxx
Description	string	The description of the protocol.	ARMS
EnableServiceAccount	boolean	Indicates whether a service account is enabled.	false.
NeedRestartAfterIntegration	boolean	Indicates whether a restart is required after the installation.	false
MetricCheckRule	object	The metric check rule.
PromQL	array	The PromQL statements.
promQL	string	PromQL statements are supported.	scraper_up{scraper=\"ecs\"}==1
Icon	string	The URL of the icon.	http://xxxx
Keywords	array	The collection of keywords.
keywords	string	The keyword.	Java
Language	string	The language.	zh
Name	string	The name of the add-on.	mysql
Once	boolean	Indicates whether the add-on can be installed only once.	false
Scene	string	The scenario.	database
Version	string	The version of the agent.	0.0.1
Weight	string	The weight.	857
LatestReleaseCreateTime	string	The time when the instance was last created.	2023-09-22T16:56:29+08:00

Examples

Sample success responses

JSONformat

{
  "RequestId": "78901766-3806-4E96-8E47-CFEF59E4****",
  "Code": 200,
  "Message": "success",
  "Success": true,
  "Data": [
    {
      "Alias": "MySQL",
      "Categories": [
        "cloud"
      ],
      "Dashboards": [
        {
          "Description": "MySQL monitors the market information, monitoring the connection information, usage information and other indicators",
          "Name": "mysql-overview",
          "Url": "http://xxxx"
        }
      ],
      "Description": "Monitor database indicators with MySQL Exporter",
      "Environments": [
        {
          "Dependencies": {
            "Features": {
              "key": true
            },
            "Services": [
              "ResourceCenter"
            ],
            "ClusterTypes": [
              "ManagedKubernetes/Serverless"
            ]
          },
          "Description": "The MySQL service is deployed in a Kubernetes cluster.",
          "Enable": true,
          "Label": "Container",
          "Name": "CS",
          "Policies": {
            "AlertDefaultStatus": "default",
            "DefaultInstall": false,
            "TargetAddonName": "cloud-rds-mysql",
            "Protocols": [
              {
                "Name": "arms",
                "Label": "ARMS",
                "Icon": "http://xxxxxxx",
                "Description": "ARMS"
              }
            ],
            "EnableServiceAccount": true,
            "NeedRestartAfterIntegration": false,
            "MetricCheckRule": {
              "PromQL": [
                "scraper_up{scraper=\\\"ecs\\\"}==1"
              ]
            }
          }
        }
      ],
      "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"
    }
  ]
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-06-07	The response structure of the API has changed	View Change Details