InstallAddon - 安装Addon信息_可观测监控 Prometheus 版(Prometheus)-阿里云帮助中心

安装Addon信息。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
arms:InstallAddon	none	Environment acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}	无	无

请求参数

名称	类型	必填	描述	示例值
Name	string	是	Addon 名称。	mysql
AddonVersion	string	是	Addon 版本。	0.0.1
AliyunLang	string	否	语言环境，默认为中文 zh \| en。	zh
EnvironmentId	string	是	环境 ID。	env-xxx
Values	string	否	输入的元数据。	{"host":"mysql-service.default","port":3306,"username":"root","password":"roots"}
ReleaseName	string	否	安装后的插件名称，如果不指定则生成默认规则名称。	mysql-xxxxx
DryRun	boolean	否	是否试运行，默认为 false。	false
RegionId	string	否	地域 ID。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object	response
RequestId	string	Id of the request	C21AB7CF-B7AF-410F-BD61-82D1567F****
Code	integer	状态码。说明 200 表示成功。	200
Success	boolean	操作是否成功：true：操作成功 false：操作失败。	true
Message	string	返回信息。	success
Data	object	返回数据。
AddonName	string	组件名称。	mysql
AlertRuleCount	long	告警组数量。	1
Conditions	array<object>	安装阶段。
conditions	object	阶段信息。
FirstTransitionTime	string	第一次转换时间。	2018-01-31T14:32:19Z
LastTransitionTime	string	最后一次转换时间。	2018-01-31T14:32:19Z
Message	string	详细信息。	xxxx
Reason	string	原因。	xxxx
Status	string	阶段状态。	True
Type	string	阶段类型。	Loaded
CreateTime	string	创建时间。	2023-09-22T16:56:29+08:00
DashboardCount	long	大盘数量。	1
ExporterCount	long	插件数量。	2
HaveConfig	boolean	是否有配置。	true
InstallUserId	string	安装的用户 ID。	123456
Language	string	语言。	zh
ReleaseId	string	安装后的 ReleaseID。	be29c093-3fd6-4fb6-9430-797030cc183a
ReleaseName	string	Release 的名称。	mysql-1695372983039
Scene	string	定位到的场景。	database
Status	string	状态。	0
UpdateTime	string	更新时间。	2023-09-22T16:56:29+08:00
UserId	string	用户 ID。	111
Version	string	Addon 版本。	0.0.1
EnvironmentId	string	环境 ID。	env-xxxx
RegionId	string	地域 ID。	cn-heyuan
Managed	boolean	是否为托管组件。	true

示例

正常返回示例

JSON格式

{
  "RequestId": "C21AB7CF-B7AF-410F-BD61-82D1567F****",
  "Code": 200,
  "Success": true,
  "Message": "success",
  "Data": {
    "AddonName": "mysql",
    "AlertRuleCount": 1,
    "Conditions": [
      {
        "FirstTransitionTime": "2018-01-31T14:32:19Z",
        "LastTransitionTime": "2018-01-31T14:32:19Z",
        "Message": "xxxx",
        "Reason": "xxxx",
        "Status": "True",
        "Type": "Loaded"
      }
    ],
    "CreateTime": "2023-09-22T16:56:29+08:00",
    "DashboardCount": 1,
    "ExporterCount": 2,
    "HaveConfig": true,
    "InstallUserId": "123456",
    "Language": "zh",
    "ReleaseId": "be29c093-3fd6-4fb6-9430-797030cc183a",
    "ReleaseName": "mysql-1695372983039",
    "Scene": "database",
    "Status": "0",
    "UpdateTime": "2023-09-22T16:56:29+08:00",
    "UserId": "111",
    "Version": "0.0.1",
    "EnvironmentId": "env-xxxx",
    "RegionId": "cn-heyuan",
    "Managed": true
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-01-23	OpenAPI 返回结构发生变更	查看变更详情