すべてのプロダクト
Search

このプロダクト

    Bastionhost:ListHostGroupsForUser

    ドキュメントセンター

    Bastionhost:ListHostGroupsForUser

    最終更新日:Jan 21, 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:ListHostGroupsForUser

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    InstanceId

    string

    必須

    クエリするユーザーが属する踏み台ホストの ID。

    説明

    DescribeInstances 操作を呼び出して、踏み台ホストの ID をクエリできます。

    bastionhost-cn-st220aw****
    RegionId

    string

    任意

    クエリするユーザーが属する踏み台ホストのリージョン ID。

    説明

    リージョン ID とリージョン名のマッピングの詳細については、「リージョンとゾーン」をご参照ください。

    cn-hangzhou
    Mode

    string

    任意

    クエリするホストグループのカテゴリ。 有効な値：

    • Authorized (デフォルト)：ユーザーに管理権限が付与されているホストグループをクエリします。

    • Unauthorized：ユーザーに管理権限が付与されていないホストグループをクエリします。

    Authorized
    UserId

    string

    必須

    ユーザー ID。

    説明

    ListUsers 操作を呼び出して、ユーザー ID をクエリできます。

    １
    PageNumber

    string

    任意

    ページ番号。 デフォルト値：1。

    １
    PageSize

    string

    任意

    1ページあたりのエントリ数。
    有効な値：1～100。 デフォルト値：20。 このパラメーターを空のままにした場合、1ページあたり 20 件のエントリが返されます。

    説明

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

    20
    HostGroupName

    string

    任意

    クエリするホストグループの名前。 名前は最大 128 文字です。 完全一致のみがサポートされます。

    group

    すべての Alibaba Cloud API 操作には、共通リクエストパラメーターを含める必要があります。 共通リクエストパラメーターの詳細については、「共通リクエストパラメーター」をご参照ください。 リクエスト例の詳細については、「リクエスト例」をご参照ください。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    TotalCount

    integer

    返されたホストグループの総数。

    1
    RequestId

    string

    リクエスト ID。

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

    array<object>

    返されたホストグループのリスト。

    object

    HostGroupId

    string

    ホストグループ ID。

    １
    Comment

    string

    ホストグループのコメント。

    comment
    HostGroupName

    string

    ホストグループの名前。

    group

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

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

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

    変更履歴

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