InstallAddon - - Alibaba Cloud Dokümantasyon Merkezi

Bir eklenti yükler.

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	Eklentinin adı.	mysql
AddonVersion	string	Yes	Eklentinin sürümü.	0.0.1
AliyunLang	string	No	Dil. Geçerli değerler: zh ve en. Varsayılan değer: zh.	zh
EnvironmentId	string	Yes	Ortam kimliği.	env-xxx
Values	string	No	Meta veriler.	{"host":"mysql-service.default","port":3306,"username":"root","password":"roots"}
ReleaseName	string	No	Eklentinin yüklendikten sonraki adı. Bu parametreyi belirtmezseniz varsayılan bir kural adı oluşturulur.	mysql-xxxxx
DryRun	boolean	No	Yalnızca deneme çalıştırması yapılıp yapılmayacağını belirtir, gerçek istek gerçekleştirilmez. Varsayılan değer: false.	false
RegionId	string	No	Bölge kimliği.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	Yanıt.
RequestId	string	İsteğin kimliği.	C21AB7CF-B7AF-410F-BD61-82D1567F****
Code	integer	HTTP durum kodu. 200 durum kodu, isteğin başarılı olduğunu gösterir.	200
Success	boolean	İsteğin başarılı olup olmadığını gösterir. Geçerli değerler: true ve false.	true
Message	string	Döndürülen mesaj.	success
Data	object	Döndürülen veriler.
AddonName	string	Eklentinin adı.	mysql
AlertRuleCount	integer	Uyarı kurallarının sayısı.	1
Conditions	array<object>	Koşullar.
	object	Koşul bilgileri.
FirstTransitionTime	string	İlk geçiş zamanı.	2018-01-31T14:32:19Z
LastTransitionTime	string	Son geçiş zamanı.	2018-01-31T14:32:19Z
Message	string	Döndürülen mesaj.	xxxx
Reason	string	Neden.	xxxx
Status	string	Koşulun durumu.	True
Type	string	Koşulun türü.	Loaded
CreateTime	string	Eklentinin oluşturulduğu zaman.	2023-09-22T16:56:29+08:00
DashboardCount	integer	Panoların sayısı.	1
ExporterCount	integer	Dışa aktarıcıların sayısı.	2
HaveConfig	boolean	Yapılandırmanın kullanılabilir olup olmadığını gösterir.	true
InstallUserId	string	Kullanıcı kimliği.	123456
Language	string	Dil.	zh
ReleaseId	string	Yükleme sonrası yayın kimliği.	be29c093-3fd6-4fb6-9430-797030cc183a
ReleaseName	string	Yayının adı.	mysql-1695372983039
Scene	string	Senaryo.	database
Status	string	Durum.	0
UpdateTime	string	Eklentinin güncellendiği zaman.	2023-09-22T16:56:29+08:00
UserId	string	Kullanıcı kimliği.	111
Version	string	Eklentinin sürümü.	0.0.1
EnvironmentId	string	Ortam kimliği.	env-xxxx
RegionId	string	Bölge kimliği.	cn-heyuan
Managed	boolean	Bileşenin tamamen yönetilip yönetilmediğini gösterir.	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.