ListHostAccounts を使用してホストアカウントをクエリ - 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:ListHostAccounts

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	Bastionhost インスタンスの ID です。説明 DescribeInstances 操作を呼び出して、インスタンス ID を取得できます。	bastionhost-cn-st220aw****
RegionId	string	任意	Bastionhost インスタンスのリージョン ID です。説明リージョン ID とリージョン名の対応関係については、「リージョンとゾーン」をご参照ください。	cn-hangzhou
HostId	string	必須	ホストアカウントをクエリするホストの ID です。説明 ListHosts 操作を呼び出して、ホスト ID を取得できます。	1
PageNumber	string	任意	返されるページの番号です。デフォルト値は 1 です。	1
PageSize	string	任意	各ページに返されるエントリ数です。 PageSize パラメーターの最大値は 100 で、デフォルト値は 20 です。このパラメーターを空のままにすると、各ページに 20 件のエントリが返されます。説明このパラメーターを空にしないことを推奨します。	20
HostAccountName	string	任意	クエリするホストアカウントの名前です。名前の長さは最大 128 文字です。このパラメーターは完全一致検索のみをサポートします。	abc
ProtocolName	string	任意	クエリするホストアカウントのプロトコルです。有効な値： SSH RDP	SSH
HostIds	string	任意	ホストアカウントをクエリするホスト ID の配列です。説明このパラメーターは、HostId パラメーターの値が 0 の場合にのみ有効です。HostId パラメーターに 0 以外の値が指定されている場合、このパラメーターは無視されます。	["2","3"]

レスポンスフィールド

フィールド	型	説明	例
	object
TotalCount	integer	返されたホストアカウントの総数です。	1
RequestId	string	リクエストの ID です。	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
HostAccounts	array<object>	返されたホストアカウントの一覧です。
	object
HasPassword	boolean	ホストアカウントにパスワードが設定されているかどうかを示します。有効な値： true：パスワードが設定されています。 false：パスワードが設定されていません。	true
PrivateKeyFingerprint	string	ホストアカウントの秘密鍵の指紋です。	fe:ca:37:42:30:00:9d:95:e6:73:e5:b0:32:0a::
ProtocolName	string	ホストアカウントのプロトコルです。有効な値： SSH RDP	SSH
HostAccountName	string	ホストアカウントの名前です。	abc
HostAccountId	string	ホストアカウントの ID です。	1
HostId	string	ホストの ID です。	1
HostShareKeyId	string	ホストの共有キーの ID です。	1
RotationMode	string	アカウントのパスワード変更モードです。 Privileged：特権アカウントを使用してパスワードを変更します。 Self：特権アカウントを使用せずにパスワードを変更します。説明このパラメーターは、V3.2.47 以降の Bastionhost インスタンスでのみ使用できます。	Privileged
HostShareKeyName	string	ホストの共有キーの名前です。	name
PrivilegeType	string	アカウントの権限タイプです。 Privileged：特権アカウント Normal：通常アカウント説明このパラメーターは、V3.2.47 以降の Bastionhost インスタンスでのみ使用できます。	Normal

例

成功レスポンス

JSONJSON

{
  "TotalCount": 1,
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "HostAccounts": [
    {
      "HasPassword": true,
      "PrivateKeyFingerprint": "fe:ca:37:42:30:00:9d:95:e6:73:e5:b0:32:0a:**:**",
      "ProtocolName": "SSH",
      "HostAccountName": "abc",
      "HostAccountId": "1",
      "HostId": "1",
      "HostShareKeyId": "1",
      "RotationMode": "Privileged",
      "HostShareKeyName": "name",
      "PrivilegeType": "Normal"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParameter	The argument is invalid.
500	InternalError	An unknown error occurred.

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

変更履歴

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