すべてのプロダクト
Search

このプロダクト

    Bastionhost:ListHostGroups

    ドキュメントセンター

    Bastionhost:ListHostGroups

    最終更新日:Feb 11, 2026

    バスタイオンホストが管理する資産グループの一覧をクエリします。

    今すぐお試しください

    この 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:ListHostGroups

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    InstanceId

    string

    必須

    クエリ対象のバスタイオンホストの ID です。

    説明

    バスタイオンホストの ID は、DescribeInstances 操作を呼び出して取得できます。

    bastionhost-cn-st220aw****
    RegionId

    string

    任意

    ホストグループをクエリするバスタイオンホストのリージョン ID です。

    説明

    リージョン ID とリージョン名の対応関係については、「リージョンとゾーン」をご参照ください。

    cn-hangzhou
    PageNumber

    string

    任意

    ページ番号です。デフォルト値は 1 です。

    1
    PageSize

    string

    任意

    1 ページあたりの表示件数です。有効な値は 1～100 です。デフォルト値は 20 です。このパラメーターを指定しない場合、1 ページあたり 20 件が返されます。

    説明

    このパラメーターを空欄にしないことを推奨します。

    20
    HostGroupName

    string

    任意

    クエリ対象のホストグループの名称です。完全一致での検索のみサポートされます。

    HostGroup1

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    TotalCount

    integer

    返された資産グループの総数です。

    1
    RequestId

    string

    リクエスト ID です。

    EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
    HostGroups

    array<object>

    返された資産グループです。

    object

    MemberCount

    integer

    資産グループ内のホスト数です。

    1
    HostGroupId

    string

    資産グループの ID です。

    1
    Comment

    string

    資産グループの備考です。

    Comment
    HostGroupName

    string

    資産グループの名称です。

    HostGroup1

    例

    成功レスポンス

    JSONJSON

    {
  "TotalCount": 1,
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "HostGroups": [
    {
      "MemberCount": 1,
      "HostGroupId": "1",
      "Comment": "Comment",
      "HostGroupName": "HostGroup1"
    }
  ]
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidParameter The argument is invalid.
    500 InternalError An unknown error occurred.

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

    変更履歴

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