ListEnvironmentAddons - 查询指定环境安装的Addon

查询指定环境安装的Addon信息。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
arms:ListEnvironmentAddonsnone
*Environment
acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}

请求参数

名称类型必填描述示例值
EnvironmentIdstring

环境 ID。

env-xxx
RegionIdstring

地域 ID。

cn-hangzhou

返回参数

名称类型描述示例值
object

response

RequestIdstring

Id of the request

32940175-181B-4B93-966E-4BB69176****
Codeinteger

状态码。

200
Messagestring

返回结果的提示信息。

message
Successboolean

操作是否成功:true:操作成功 false:操作失败。

true
Dataobject

返回结果。

Addonsarray<object>

Addon 列表。

addonsobject

Addon 信息。

Aliasstring

Addon 别名。

MySQL
Categoriesarray

Addon 标签列表。

categoriesstring

标签。

cloud
Dashboardsarray<object>

大盘列表。

dashboardsobject

大盘信息。

Descriptionstring

大盘描述。

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

大盘名称。

mysql-overview
Urlstring

大盘地址。

http://xxxx
Descriptionstring

Addon 描述信息。

通过 MySQL Exporter 监控数据库指标
Environmentsarray<object>

支持的环境列表。

environmentsobject

环境信息。

Dependenciesobject

环境的依赖列表。

Featuresobject

环境可安装的 Feature。

boolean

是否支持。

true
Servicesarray

服务列表。

servicesstring

服务名称。

ResourceCenter
ClusterTypesarray

集群类型。

clusterTypesstring

集群类型。

Edge
Descriptionstring

环境描述信息。

MySQL 服务部署在 Kubernetes 集群中。
Enableboolean

是否开启。

true
Labelstring

环境标签。

容器环境
Namestring

环境名称。

CS
Policiesobject

环境中的控制策略信息。

AlertDefaultStatusstring

默认告警状态。

default
DefaultInstallboolean

默认安装状态。

false
TargetAddonNamestring

Addon 的 Target 名称。

cloud-rds-mysql
Protocolsarray<object>

支持的协议列表。

protocolsobject

协议。

Namestring

协议名称。

arms
Iconstring

协议图标地址。

http://xxxxxxx
Labelstring

协议标签。

ARMS
Descriptionstring

协议描述。

ARMS
MetricCheckRuleobject

指标正常检查的规则。

PromQLarray

PromQL 查询语句。

promQLstring

PromQL 查询语句。

max(flink_taskmanager_job_task_operator_currentEmitEventTimeLag{deploymentId='983d8f2d-14a9-4af0-a23d-751a7818c239'}/1000) >= 600.0
NeedRestartAfterIntegrationboolean

安装后是否需要重启。

true
EnableServiceAccountboolean

是否开启服务账户。

true
Iconstring

图标地址。

http://xxxx
Keywordsarray

关键字集合。

keywordsstring

关键字。

Java
Languagestring

语言。

zh
Namestring

Addon 名称。

mysql
Onceboolean

是否只能安装一次。

false
Scenestring

定位到的场景。

database
Versionstring

插件版本。

0.0.1
Weightstring

权重。

857
LatestReleaseCreateTimestring

最后一次被创建时间。

2023-09-22T16:56:29+08:00
Totallong

总条数。

1

示例

正常返回示例

JSON格式

{
  "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
  }
}

错误码

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