ListHostsForUserGroup API の呼び出しによるユーザーグループのホストのクエリ - Bastionhost - Alibaba Cloud - Bastionhost

バスティオンホスト用のユーザーグループの、承認済みまたは未承認のホストを一覧表示します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

yundun-bastionhost:ListHostsForUserGroup

get

* インスタンス

acs:yundun-bastionhost:{#regionId}:{#accountId}:instance/{#InstanceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	文字列	必須	ユーザーグループが含まれる Bastionhost インスタンスの ID です。説明 DescribeInstances API を呼び出してインスタンス ID を取得できます。	bastionhost-cn-st220aw****
RegionId	文字列	任意	Bastionhost インスタンスが配置されているリージョンの ID です。説明リージョンとその対応する ID の詳細については、「リージョンとアベイラビリティーゾーン」をご参照ください。	cn-hangzhou
Mode	文字列	任意	承認済みまたは未承認のホストを照会するかどうかを指定します。有効な値： Authorized (デフォルト) Unauthorized	Authorized
UserGroupId	文字列	必須	一覧表示するホストが含まれるユーザーグループの ID です。説明 ListUserGroups API を呼び出してユーザーグループ ID を取得できます。	1
PageNumber	文字列	任意	返すページ番号。デフォルト値： 1。	1
PageSize	文字列	任意	各ページで返すエントリ数。最大値： 100。デフォルト値： 20。説明このパラメーターを指定することを推奨します。	20
HostAddress	文字列	任意	ホストのアドレス。このパラメーターはドメイン名または IP アドレスに設定できます。完全一致がサポートされています。	192.168.XX.XX
HostName	文字列	任意	ホスト名。完全一致がサポートされています。	abc
OSType	文字列	任意	ホストのオペレーティングシステム。有効な値： Linux Windows	Linux

API 固有のパラメーターに加えて、リクエストには Alibaba Cloud API の共通リクエストパラメーターを含める必要があります。詳細な説明については共通パラメーターを、リクエストフォーマットについては本トピックのリクエスト例をご参照ください。

レスポンスフィールド

フィールド	型	説明	例
	オブジェクト	返されるデータです。
TotalCount	整数	ホストの合計数です。	10
RequestId	文字列	リクエストの ID です。	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
Hosts	オブジェクトの配列	ホストのリストです。
	オブジェクト	ホストに関する情報です。
Comment	文字列	ホストのコメントです。	comment
ActiveAddressType	文字列	ホストのアドレスタイプです。有効な値： Public：パブリック IP アドレス Private：プライベート IP アドレス	Public
HostPublicAddress	文字列	ホストのパブリック IP アドレスです。値はドメイン名または IP アドレスです。	120.42.XX.XX
HostName	文字列	ホスト名です。	host1
HostPrivateAddress	文字列	ホストのプライベート IP アドレスです。値はドメイン名または IP アドレスです。	192.168.XX.XX
OSType	文字列	ホストの OS タイプです。有効な値： Linux Windows	Linux
HostId	文字列	ホストの ID です。	h-cec6727289564037

例

成功レスポンス

JSONJSON

{
  "TotalCount": 1,
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "Hosts": [
    {
      "Comment": "comment",
      "ActiveAddressType": "Public",
      "HostPublicAddress": "10.158.XX.XX",
      "HostName": "host1",
      "HostPrivateAddress": "192.168.XX.XX",
      "OSType": "Linux",
      "HostId": "1"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParameter	The argument is invalid.	引数が無効です。
500	InternalError	An unknown error occurred.	内部エラーが発生しました。

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

変更履歴

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