ListEnvironmentAddons - 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:ListEnvironmentAddons

none

*Environment

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
EnvironmentId	string	必須	環境 ID。	env-xxx
RegionId	string	任意	リージョン ID。	cn-hangzhou

レスポンスフィールド

フィールド	型	説明	例
	object	応答オブジェクト。
RequestId	string	リクエスト ID。	32940175-181B-4B93-966E-4BB69176****
Code	integer	ステータスコード。	200
Message	string	返されたメッセージ。	message
Success	boolean	操作が成功したかどうかを示します。有効な値は、操作が成功した場合は `true`、失敗した場合は `false` です。	true
Data	object	返されたデータ。
Addons	array<object>	アドオンのリスト。
	array<object>	アドオンの詳細。
Alias	string	アドオンのエイリアス。	MySQL
Categories	array	アドオンのタグのリスト。
	string	アドオンのタグ。	cloud
Dashboards	array<object>	ダッシュボードのリスト。
	object	ダッシュボードの詳細。
Description	string	ダッシュボードの説明。	MySQL监控大盘信息,监控了连接信息,使用信息等指标
Name	string	ダッシュボードの名前。	mysql-overview
Url	string	ダッシュボードの URL。	http://xxxx
Description	string	アドオンの説明。	通过 MySQL Exporter 监控数据库指标
Environments	array<object>	サポートされている環境のリスト。
	array<object>	環境の詳細。
Dependencies	object	環境内でのアドオンの依存関係。
Features	object	環境にインストール可能な特徴。
	boolean	特徴がサポートされているかどうかを示します。	true
Services	array	依存サービス。
	string	サービスの名前。	ResourceCenter
ClusterTypes	array	必要なクラスタータイプ。
	string	クラスタータイプ。	Edge
Description	string	環境の説明。	MySQL 服务部署在 Kubernetes 集群中。
Enable	boolean	この環境でアドオンがサポートされているかどうかを示します。	true
Label	string	環境のラベル。	容器环境
Name	string	環境の名前。	CS
Policies	object	この環境のアドオンに関連するポリシー。
AlertDefaultStatus	string	アラートのデフォルトステータス。	default
DefaultInstall	boolean	アドオンが環境にデフォルトでインストールされるかどうかを示します。	false
TargetAddonName	string	アドオンのターゲット名。	cloud-rds-mysql
Protocols	array<object>	サポートされているプロトコルのリスト。
	object	サポートされているプロトコル。
Name	string	プロトコルの名前。	arms
Icon	string	プロトコルアイコンの URL。	http://xxxxxxx
Label	string	プロトコルのラベル。	ARMS
Description	string	プロトコルの説明。	ARMS
MetricCheckRule	object	メトリックステータスをチェックするためのルール。
PromQL	array	PromQL クエリ文。
	string	PromQL クエリ文。	max(flink_taskmanager_job_task_operator_currentEmitEventTimeLag{deploymentId='983d8f2d-14a9-4af0-a23d-751a7818c239'}/1000) >= 600.0
NeedRestartAfterIntegration	boolean	アドオンのインストール後に再起動が必要かどうかを示します。	true
EnableServiceAccount	boolean	アドオンに対してサービスアカウントが有効になっているかどうかを示します。	true
Icon	string	アドオンアイコンの URL。	http://xxxx
Keywords	array	アドオンのキーワード。
	string	アドオンのキーワード。	Java
Language	string	アドオンメタデータの言語。	zh
Name	string	アドオンの名前。	mysql
Once	boolean	アドオンが環境ごとに一度しかインストールできないかどうかを示します。	false
Scene	string	アドオンのアプリケーションシナリオ。	database
Version	string	アドオンのバージョン。	0.0.1
Weight	string	アドオンの重み。UI でのソートに使用されます。	857
LatestReleaseCreateTime	string	アドオンの最新リリースの作成時間。	2023-09-22T16:56:29+08:00
Total	integer	エントリの総数。	1
ContainsV2Addon	boolean	リストに V2 アドオンが含まれているかどうかを示します。

例

成功レスポンス

JSONJSON

{
  "RequestId": "32940175-181B-4B93-966E-4BB69176****",
  "Code": 200,
  "Message": "message",
  "Success": true,
  "Data": {
    "Addons": [
      {
        "Alias": "MySQL",
        "Categories": [
          "cloud"
        ],
        "Dashboards": [
          {
            "Description": "MySQL监控大盘信息,监控了连接信息,使用信息等指标",
            "Name": "mysql-overview",
            "Url": "http://xxxx"
          }
        ],
        "Description": "通过 MySQL Exporter 监控数据库指标",
        "Environments": [
          {
            "Dependencies": {
              "Features": {
                "key": true
              },
              "Services": [
                "ResourceCenter"
              ],
              "ClusterTypes": [
                "Edge"
              ]
            },
            "Description": "MySQL 服务部署在 Kubernetes 集群中。",
            "Enable": true,
            "Label": "容器环境",
            "Name": "CS",
            "Policies": {
              "AlertDefaultStatus": "default",
              "DefaultInstall": false,
              "TargetAddonName": "cloud-rds-mysql",
              "Protocols": [
                {
                  "Name": "arms",
                  "Icon": "http://xxxxxxx",
                  "Label": "ARMS",
                  "Description": "ARMS"
                }
              ],
              "MetricCheckRule": {
                "PromQL": [
                  "max(flink_taskmanager_job_task_operator_currentEmitEventTimeLag{deploymentId='983d8f2d-14a9-4af0-a23d-751a7818c239'}/1000) >= 600.0"
                ]
              },
              "NeedRestartAfterIntegration": true,
              "EnableServiceAccount": true
            }
          }
        ],
        "Icon": "http://xxxx",
        "Keywords": [
          "Java"
        ],
        "Language": "zh",
        "Name": "mysql",
        "Once": false,
        "Scene": "database",
        "Version": "0.0.1",
        "Weight": "857",
        "LatestReleaseCreateTime": "2023-09-22T16:56:29+08:00"
      }
    ],
    "Total": 1,
    "ContainsV2Addon": false
  }
}

エラーコード

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

変更履歴

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