InstallAddon - Managed Service for Prometheus - Alibaba Cloud Documentation Center

Installs an add-on.

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:InstallAddon	none	Environment acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
Name	string	Yes	The name of the add-on.	mysql
AddonVersion	string	Yes	The version of the add-on.	0.0.1
AliyunLang	string	No	The language. Valid values: zh and en. Default value: zh.	zh
EnvironmentId	string	Yes	The environment ID.	env-xxx
Values	string	No	The metadata.	{"host":"mysql-service.default","port":3306,"username":"root","password":"roots"}
ReleaseName	string	No	The name of the add-on after it is installed. If you do not specify this parameter, a default rule name is generated.	mysql-xxxxx
DryRun	boolean	No	Specifies whether to perform only a dry run, without performing the actual request. Default value: false.	false
RegionId	string	No	The region ID.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object	response
RequestId	string	The ID of the request.	C21AB7CF-B7AF-410F-BD61-82D1567F****
Code	integer	The HTTP status code. The status code 200 indicates that the request was successful.	200
Success	boolean	Indicates whether the request was successful. Valid values: true and false.	true
Message	string	The returned message.	success
Data	object	The returned data.
AddonName	string	The name of the add-on.	mysql
AlertRuleCount	long	The number of alert rules.	1
Conditions	array<object>	The installation phase.
conditions	object	Condition information.
FirstTransitionTime	string	The first transition time.	2018-01-31T14:32:19Z
LastTransitionTime	string	The last transition time.	2018-01-31T14:32:19Z
Message	string	The returned message.	xxxx
Reason	string	The reason for the failure.	xxxx
Status	string	The status of the phase.	True
Type	string	The type of the phase.	Loaded
CreateTime	string	The time when the add-on was created.	2023-09-22T16:56:29+08:00
DashboardCount	long	The number of dashboards.	1
ExporterCount	long	The number of exporters.	2
HaveConfig	boolean	Indicates whether the configuration is available.	true
InstallUserId	string	The user ID.	123456
Language	string	The language.	zh
ReleaseId	string	The release ID after installation.	be29c093-3fd6-4fb6-9430-797030cc183a
ReleaseName	string	The name of the release.	mysql-1695372983039
Scene	string	The scenario.	database
Status	string	The status.	0
UpdateTime	string	The time when the add-on was updated.	2023-09-22T16:56:29+08:00
UserId	string	The user ID.	111
Version	string	The version of the add-on.	0.0.1
EnvironmentId	string	The environment ID.	env-xxxx
RegionId	string	The region ID.	cn-heyuan
Managed	boolean	Indicates whether the component is fully managed.	true

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

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