InstallAddon - Application Real-Time Monitoring Service - Alibaba Cloud ドキュメントセンター

アドオンをインストールします。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

arms:InstallAddon

none

*Environment

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Name	string	必須	アドオンの名前。	mysql
AddonVersion	string	必須	アドオンのバージョン。	0.0.1
AliyunLang	string	任意	言語。有効な値：zh および en。デフォルト値：zh。	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	応答
RequestId	string	リクエスト ID。	C21AB7CF-B7AF-410F-BD61-82D1567F****
Code	integer	HTTP ステータスコード。状態コード 200 は、リクエストが成功したことを示します。	200
Success	boolean	リクエストが成功したかどうかを示します。有効な値：true および false。	true
Message	string	返されたメッセージ。	success
Data	object	返されたデータ。
AddonName	string	アドオンの名前。	mysql
AlertRuleCount	integer	アラートルールの数。	1
Conditions	array<object>	インストールフェーズ。
	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	integer	ダッシュボードの数。	1
ExporterCount	integer	エクスポーターの数。	2
HaveConfig	boolean	構成が利用可能かどうかを示します。	true
InstallUserId	string	ユーザー ID。	123456
Language	string	言語。	zh
ReleaseId	string	インストール後のリリース ID。	be29c093-3fd6-4fb6-9430-797030cc183a
ReleaseName	string	リリースの名前。	mysql-1695372983039
Scene	string	シナリオ。	database
Status	string	ステータス。	0
UpdateTime	string	アドオンが更新された時間。	2023-09-22T16:56:29+08:00
UserId	string	ユーザー ID。	111
Version	string	アドオンのバージョン。	0.0.1
EnvironmentId	string	環境 ID。	env-xxxx
RegionId	string	リージョン ID。	cn-heyuan
Managed	boolean	コンポーネントがフルマネージドであるかどうかを示します。	true

例

成功レスポンス

JSONJSON

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

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。