ListAddons - 查询addon列表_应用实时监控服务(ARMS)-阿里云帮助中心

新版接入中心产品列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
arms:ListAddons	Write	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	地域 ID。	cn-hangzhou
Search	string	否	查询参数。	mysql
Regexp	boolean	否	查询字段，是否正则匹配, 默认为 false。	false
AliyunLang	string	否	语言环境，默认为中文 zh \| en。	zh
Category	string	否	标签筛选。	database

返回参数

名称	类型	描述	示例值
	object	response
RequestId	string	Id of the request	78901766-3806-4E96-8E47-CFEF59E4****
Code	integer	状态码, 200 为正常, 其他为异常。	200
Message	string	提示消息。	success
Success	boolean	业务是否成功。	true
Data	object []	Addon 列表数据。
Alias	string	Addon 别名。	MySQL
Categories	array	Addon 标签列表。
	string	标签。	cloud
Dashboards	object []	大盘列表。
Description	string	大盘描述。	MySQL监控大盘信息，监控了连接信息、使用信息等指标
Name	string	大盘名称。	mysql-overview
Url	string	大盘地址。	http://xxxx
Description	string	Addon 描述信息。	通过 MySQL Exporter 监控数据库指标
Environments	object []	支持的环境列表。
Dependencies	object	环境的依赖列表。
Features	object	环境依赖的 Feature。
	boolean	是否支持。	true
Services	array	服务列表。
	string	服务名称。	ResourceCenter
Description	string	环境描述信息。	MySQL 服务部署在 Kubernetes 集群中。
Enable	boolean	是否开启。	true
Label	string	环境标签。	容器环境
Name	string	环境名称。	CS
Policies	object	环境中的控制策略信息。
AlertDefaultStatus	string	默认告警状态。	default
DefaultInstall	boolean	默认安装状态。	false
TargetAddonName	string	Addon 的 Target 名称。	cloud-rds-mysql
Protocols	object []	支持的协议列表。
Name	string	协议名称。	arms
Label	string	协议标签。	ARMS
Icon	string	协议图标地址。	http://xxxxxxx
Description	string	协议描述。	ARMS
EnableServiceAccount	boolean	是否开启服务账户。
NeedRestartAfterIntegration	boolean	安装后是否需要重启。
MetricCheckRule	object	指标正常检查的规则。
PromQL	array	PromQL 查询语句。
	string	PromQL 查询语句。	scraper_up{scraper=\"ecs\"}==1
Icon	string	图标地址。	http://xxxx
Keywords	array	关键字集合。
	string	关键字。	Java
Language	string	语言。	zh
Name	string	Addon 名称。	mysql
Once	boolean	是否只能安装一次。	false
Scene	string	定位到的场景。	database
Version	string	插件版本。	0.0.1
Weight	string	权重。	857
LatestReleaseCreateTime	string	最后一次被创建时间。	2023-09-22T16:56:29+08:00

示例

正常返回示例

JSON格式

{
  "RequestId": "78901766-3806-4E96-8E47-CFEF59E4****",
  "Code": 200,
  "Message": "success",
  "Success": true,
  "Data": [
    {
      "Alias": "MySQL",
      "Categories": [
        "cloud"
      ],
      "Dashboards": [
        {
          "Description": "MySQL监控大盘信息，监控了连接信息、使用信息等指标",
          "Name": "mysql-overview",
          "Url": "http://xxxx"
        }
      ],
      "Description": "通过 MySQL Exporter 监控数据库指标",
      "Environments": [
        {
          "Dependencies": {
            "Features": {
              "key": true
            },
            "Services": [
              "ResourceCenter"
            ]
          },
          "Description": "MySQL 服务部署在 Kubernetes 集群中。",
          "Enable": true,
          "Label": "容器环境",
          "Name": "CS",
          "Policies": {
            "AlertDefaultStatus": "default",
            "DefaultInstall": false,
            "TargetAddonName": "cloud-rds-mysql",
            "Protocols": [
              {
                "Name": "arms",
                "Label": "ARMS",
                "Icon": "http://xxxxxxx",
                "Description": "ARMS"
              }
            ],
            "EnableServiceAccount": true,
            "NeedRestartAfterIntegration": true,
            "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"
    }
  ]
}

错误码

访问错误中心查看更多错误码。