ListHostsForUser によるユーザーの授權済みまたは未授權ホストのクエリ - 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:ListHostsForUser

list

* インスタンス

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	文字列	必須	ユーザーに承認済みまたは未承認のホストを照会するための Bastionhost の ID です。説明 DescribeInstances API を呼び出して、Bastionhost の ID を照会できます。	bastionhost-cn-st220aw****
RegionId	文字列	任意	ユーザーに承認済みまたは未承認のホストを照会するための Bastionhost が所在するリージョンの ID です。説明リージョン ID とリージョン名のマッピングに関する詳細は、「リージョンとゾーン」をご参照ください。	cn-hangzhou
Mode	文字列	任意	照会するホストのカテゴリを指定します。有効な値： Authorized：ユーザーに承認済みのホストを照会します。これはデフォルト値です。 Unauthorized：ユーザーに未承認のホストを照会します。	Authorized
UserId	文字列	必須	ユーザーの ID です。説明 ListUsers API を呼び出して、ユーザーの ID を照会できます。	1
PageNumber	文字列	任意	ページ番号です。デフォルト値：1。	1
PageSize	文字列	任意	ページあたりのエントリ数です。最大値：100。デフォルト値：20。このパラメーターを省略した場合、ページあたり 20 件のエントリが返されます。説明このパラメーターを指定することを推奨します。	20
HostAddress	文字列	任意	照会するホストのエンドポイントです。このパラメーターには、ドメイン名または IP アドレスを設定できます。完全一致のみがサポートされます。	192.168.XX.XX
HostName	文字列	任意	照会するホストのホスト名です。完全一致のみがサポートされます。	abc
OSType	文字列	任意	照会するホストのオペレーティングシステムです。有効な値： Linux Windows	Linux

すべての Alibaba Cloud API オペレーションには、共通リクエストパラメーターが必要です。共通リクエストパラメーターの詳細については、「共通パラメーター」をご参照ください。サンプルリクエストの詳細については、このトピックの「例」セクションをご参照ください。

レスポンスフィールド

フィールド	型	説明	例
	オブジェクト
TotalCount	整数	返されたホストの総数です。	1
RequestId	文字列	リクエスト ID です。	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
Hosts	配列<オブジェクト>	返されたホストの配列です。
	オブジェクト
Comment	文字列	ホストのコメントです。	comment
ActiveAddressType	文字列	ホストのエンドポイントタイプです。有効な値： Public：パブリックエンドポイント Private：内部エンドポイント	Public
HostPublicAddress	文字列	ホストのパブリックエンドポイントです。値はドメイン名または IP アドレスです。	120.41.XX.XX
HostName	文字列	ホスト名です。	host01
HostPrivateAddress	文字列	ホストの内部エンドポイントです。値はドメイン名または IP アドレスです。	192.168.XX.XX
OSType	文字列	ホストのオペレーティングシステムです。有効な値： Linux Windows	Linux
HostId	文字列	ホスト ID です。	"1"

例

成功レスポンス

JSON JSON

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

エラーコード

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

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

変更履歴

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