全部产品
Search
文档中心

应用实时监控服务ARMS:ListAddons - 查询addon列表

更新时间:Aug 28, 2026

新版接入中心产品列表。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

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

array<object>

Addon 列表数据。

array<object>

Addon 信息。

Alias

string

Addon 别名。

MySQL

Categories

array

Addon 标签列表。

string

标签。

cloud

Dashboards

array<object>

大盘列表。

object

大盘信息。

Description

string

大盘描述。

MySQL监控大盘信息,监控了连接信息、使用信息等指标

Name

string

大盘名称。

mysql-overview

Url

string

大盘地址。

http://xxxx

Description

string

Addon 描述信息。

通过 MySQL Exporter 监控数据库指标

Environments

array<object>

支持的环境列表。

array<object>

环境信息。

Dependencies

object

环境的依赖列表。

Features

object

环境依赖的 Feature。

boolean

是否支持。

true

Services

array

服务列表。

string

服务名称。

ResourceCenter

ClusterTypes

array

支持的集群类型。

string

集群类型。

ManagedKubernetes/Default

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

array<object>

支持的协议列表。

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"
            ],
            "ClusterTypes": [
              "ManagedKubernetes/Default"
            ]
          },
          "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"
    }
  ]
}

错误码

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

变更历史

更多信息,参考变更详情。