ListHosts の呼び出しによるホストクエリ - 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:ListHosts

get

* インスタンス

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	ホストを照会したいバスティオンホストの ID です。説明 DescribeInstances API を呼び出して、バスティオンホストの ID を照会できます。	bastionhost-cn-st220aw****
RegionId	string	任意	ホストを照会したいバスティオンホストが属するリージョン ID です。説明リージョン ID とリージョン名のマッピングの詳細については、リージョンとゾーンをご参照ください。	cn-hangzhou
PageNumber	string	任意	返されるページ番号。デフォルト値：1。	1
PageSize	string	任意	各ページに返されるエントリ数。デフォルト値：10。説明このパラメーターは空のままにしないことを推奨します。	20
OSType	string	任意	照会するホストのオペレーティングシステム。有効な値： Linux Windows	Linux
HostName	string	任意	照会するホストの名前。完全一致のみサポートされます。	host
HostAddress	string	任意	照会するホストのアドレス。ドメイン名または IP アドレスに設定できます。完全一致のみサポートされます。	1.1.XX.XX
Source	string	任意	照会するホストのソース。有効な値： Local：データセンター内のホスト Ecs：Elastic Compute Service (ECS) インスタンス Rds：ApsaraDB MyBase 専用クラスター内のホスト	Local
SourceInstanceId	string	任意	照会する ECS インスタンスまたは ApsaraDB MyBase 専用クラスター内のホストの ID。完全一致のみサポートされます。	i-bp19ienyt0yax748****
SourceInstanceState	string	任意	照会するホストのステータス。有効な値： Normal：正常 Release：解放済み	Normal
HostGroupId	string	任意	照会対象のホストが属するホストグループの ID です。説明 ListHostGroups API を呼び出して、ホストグループの ID を照会できます。	1

レスポンスフィールド

フィールド	型	説明	例
	object
TotalCount	integer	返されたホストの総数。	1
RequestId	string	リクエスト ID。問題の特定とトラブルシューティングに使用されます。	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
Hosts	array<object>	返されたホストで構成される配列。
	object
Comment	string	ホストのコメント。	host
ActiveAddressType	string	ホストのアドレスタイプ。有効な値： Public：パブリックアドレス Private：プライベートアドレス	Public
HostPublicAddress	string	ホストのパブリックアドレス。値はドメイン名または IP アドレスです。	1.1.XX.XX
HostName	string	ホスト名。	name
HostAccountCount	integer	ホストアカウントの数。	1
Source	string	ホストのソース。有効な値： Local：データセンター内のホスト Ecs：ECS インスタンス RDS：ApsaraDB MyBase 専用クラスター内のホスト	Local
HostPrivateAddress	string	ホストのプライベートアドレス。値はドメイン名または IP アドレスです。	192.168.XX.XX
OSType	string	ホストのオペレーティングシステム。有効な値： Linux Windows	Linux
HostId	string	ホスト ID。	1
SourceInstanceState	string	ホストのステータス。有効な値： Normal：正常 Release：リリース済み	Normal
SourceInstanceId	string	ECS インスタンスまたは ApsaraDB MyBase 専用クラスター内のホスト ID。説明 Source パラメーターが Local に設定されている場合、このパラメーターには値が返されません。	i-bp19ienyt0yax748****

例

成功レスポンス

JSON JSON

{
  "TotalCount": 1,
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "Hosts": [
    {
      "Comment": "host",
      "ActiveAddressType": "Public",
      "HostPublicAddress": "1.1.XX.XX",
      "HostName": "name",
      "HostAccountCount": 1,
      "Source": "Local",
      "HostPrivateAddress": "192.168.XX.XX",
      "OSType": "Linux",
      "HostId": "1",
      "SourceInstanceState": "Normal",
      "SourceInstanceId": "i-bp19ienyt0yax748****"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParameter	引数が無効です。	引数が無効です。
500	InternalError	不明なエラーが発生しました。	不明なエラーが発生しました。

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

変更履歴

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