Automate Prometheus Add-on Deployment with InstallAddon API - ARMS - Alibaba Cloud - Application Real-Time Monitoring Service

Installs an add-on.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

arms:InstallAddon

none

*Environment

acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}

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 elements

Element	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	integer	The number of alert rules.	1
Conditions	array<object>	The installation phase.
	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	integer	The number of dashboards.	1
ExporterCount	integer	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

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.