ListPluginsInstances - Alibaba Cloud Linux - Alibaba Cloud ドキュメントセンター

プラグインのインストール、更新、またはアンインストール用のインスタンスのリストを取得します。

操作説明

この操作で取得されるインスタンスリストには、SysOM で管理されているマシンのみが含まれます。ECS インスタンスが存在しても、SysOM で管理されていない場合はリストに表示されません。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

sysom:ListPluginsInstances

get

*すべてのリソース。

*

なし

リクエスト構文

GET /api/v1/am/agent/listPluginsInstances HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
operation_type	string	必須	プラグインのインストールステータスでインスタンスをフィルタリングします。	install
plugin_id	string	必須	指定したエージェントのインスタンスリストをフィルタリングするためのエージェント ID を指定します。	74a86327-3170-412c-8e67-da3389ec56a9
region	string	必須	リージョンでインスタンスをフィルタリングします。	cn-shenzhen
instance_id_name	string	任意	インスタンス ID またはインスタンス名でインスタンスをフィルタリングします。あいまい一致がサポートされています。	i-bpxx
instance_tag	string	任意	インスタンスのタグでインスタンスをフィルタリングします。	{"key":"app","value":"sysom-aliyun-com"}
current	integer	任意	ページ分割クエリのページ番号。このフィールドは現在のページを示します。	5
pageSize	integer	任意	ページサイズ。デフォルト値: 10。	20

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスのスキーマ。
code	string	状態コード。 code == Success は、権限付与が成功したことを示します。その他の状態コードは、権限付与が失敗したことを示します。詳細なエラー情報については、メッセージフィールドを確認してください。	Success
data	array<object>	返された結果。
	array<object>	返されたデータ。
instance_id	string	インスタンスの ID。	i-bp118piqcio9tiwgh84b
instance_name	string	コンポーネントのインスタンス名。	allowed-repos-qmf8w
instance_tag	array<object>	インスタンスのタグ。
	object	インスタンスのタグ。
tag_key	string	タグキー。	test_tag_key
tag_value	string	タグ値。	test_tag_value
os_name	string	インスタンスのオペレーティングシステム名。	Alibaba Cloud Linux 3.2104 LTS 64 bit
private_ip	string	非公開 IP アドレス。	1.1.1.1
public_ip	string	パブリック IP アドレス。	1.1.1.1
region	string	インスタンスが存在するリージョン。	cn-hangzhou
resource_group_id	string	リソースグループの ID。	rg-xxxx
resource_group_name	string	リソースグループ名。	デフォルトリソースグループ
message	string	説明。	SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict
request_id	string	リクエストの ID。	35F91AAB-5FDF-5A22-B211-C7C6B00817D0
total	integer	クエリ結果の総数。	42

例

成功レスポンス

JSONJSON

{
  "code": "Success",
  "data": [
    {
      "instance_id": "i-bp118piqcio9tiwgh84b",
      "instance_name": "allowed-repos-qmf8w",
      "instance_tag": [
        {
          "tag_key": "test_tag_key",
          "tag_value": "test_tag_value"
        }
      ],
      "os_name": "Alibaba Cloud Linux  3.2104 LTS 64 bit",
      "private_ip": "1.1.1.1",
      "public_ip": "1.1.1.1",
      "region": "cn-hangzhou",
      "resource_group_id": "rg-xxxx",
      "resource_group_name": "デフォルトリソースグループ"
    }
  ],
  "message": "SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict",
  "request_id": "35F91AAB-5FDF-5A22-B211-C7C6B00817D0",
  "total": 42
}

エラーコード

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

変更履歴

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