すべてのプロダクト
Search

このプロダクト

    Bastionhost:ListUsers

    ドキュメントセンター

    Bastionhost:ListUsers

    最終更新日: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:ListUsers

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    InstanceId

    string

    必須

    クエリ対象の堡垒ホストの ID です。

    説明

    DescribeInstances 操作を呼び出して、堡垒ホスト ID をクエリできます。

    bastionhost-cn-st220aw****
    RegionId

    string

    任意

    クエリ対象の堡垒ホストが存在するリージョン ID です。

    説明

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

    cn-hangzhou
    PageNumber

    string

    任意

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

    1
    PageSize

    string

    任意

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

    説明

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

    20
    UserName

    string

    任意

    クエリ対象のユーザーのログイン名です。完全一致のみサポートされています。

    abc
    DisplayName

    string

    任意

    クエリ対象のユーザーの表示名です。完全一致のみサポートされています。

    testuser
    Source

    string

    任意

    クエリ対象のユーザーの種類です。有効値：

    • Local：ローカルユーザー。

    • Ram：Resource Access Management (RAM) ユーザー。

    • AD：Active Directory (AD) 認証済みユーザー。

    • LDAP：Lightweight Directory Access Protocol (LDAP) 認証済みユーザー。

    Local
    Mobile

    string

    任意

    クエリ対象のユーザーの携帯電話番号です。完全一致のみサポートされています。

    1359999****
    UserState

    string

    任意

    クエリ対象のユーザーの状態です。有効値：

    • Normal：ユーザーは正常な状態です。

    • Frozen：ユーザーはロックされています。

    • Expired：ユーザーは期限切れです。

    Normal
    SourceUserId

    string

    任意

    クエリ対象のユーザーの一意の ID です。完全一致のみサポートされています。

    説明

    このパラメーターは、堡垒ホストの RAM ユーザーを一意に識別します。Source が Ram に設定されている場合にのみ有効です。RAM の ListUsers 操作を呼び出して、UserId レスポンスパラメーターからユーザーの一意の ID を取得できます。

    122748924538****
    UserGroupId

    string

    任意

    クエリ対象のユーザーが属するユーザーグループの ID です。

    説明

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

    1

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

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    返されたデータです。

    TotalCount

    integer

    返されたユーザーの総数です。

    1
    RequestId

    string

    リクエスト ID です。

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

    array<object>

    返されたユーザーです。

    object

    DisplayName

    string

    ユーザーの表示名です。

    Bob
    Email

    string

    ユーザーのメールアドレスです。

    1099**@qq.com
    Comment

    string

    ユーザーの備考です。

    comment
    MobileCountryCode

    string

    ユーザーの携帯電話番号が登録されている地域です。有効値：

    • CN：中国本土。国際ダイヤルコードは +86 です。

    • HK：香港 (中国)。国際ダイヤルコードは +852 です。

    • MO：マカオ (中国)。国際ダイヤルコードは +853 です。

    • TW：台湾 (中国)。国際ダイヤルコードは +886 です。

    • RU：ロシア。国際ダイヤルコードは +7 です。

    • SG：シンガポール。国際ダイヤルコードは +65 です。

    • MY：マレーシア。国際ダイヤルコードは +60 です。

    • ID：インドネシア。国際ダイヤルコードは +62 です。

    • DE：ドイツ。国際ダイヤルコードは +49 です。

    • AU：オーストラリア。国際ダイヤルコードは +61 です。

    • US：米国。国際ダイヤルコードは +1 です。

    • AE：アラブ首長国連邦。国際ダイヤルコードは +971 です。

    • JP: 日本。国際ダイヤルコードは +81 です。

    • GB：イギリス。国際ダイヤルコードは +44 です。

    • IN：インド。国際ダイヤルコードは +91 です。

    • KR：大韓民国。国際ダイヤルコードは +82 です。

    • PH：フィリピン。国際ダイヤルコードは +63 です。

    • CH：スイス。国際ダイヤルコードは +41 です。

    • SE：スウェーデン。国際ダイヤルコードは +46 です。

    CN
    Mobile

    string

    ユーザーの携帯電話番号です。

    1359999****
    UserId

    string

    ユーザー ID です。

    1
    Source

    string

    ユーザーの種類です。有効値：

    • Local：ローカルユーザー。

    • Ram：RAM ユーザー。

    • AD：AD 認証済みユーザー。

    • LDAP：LDAP 認証済みユーザー。

    Local
    UserName

    string

    ユーザーのログイン名です。

    abc_def
    SourceUserId

    string

    ユーザーの一意の ID です。

    説明

    このパラメーターは、堡垒ホストの RAM ユーザーを一意に識別します。Source が Ram に設定されている場合は、このパラメーターの値が返されます。Source が Local に設定されている場合は、このパラメーターの値は返されません。

    122748924538****
    UserState

    array

    ユーザーの状態をリストアップする配列です。

    string

    ユーザーの状態です。有効値：

    • Normal：ユーザーは正常な状態です。

    • Frozen：ユーザーはロックされています。

    • Expired：ユーザーは期限切れです。

    ["Normal"]
    EffectiveStartTime

    integer

    ユーザーの有効期間の開始時刻です。値は UNIX タイムスタンプで、単位は秒です。

    1669630029
    EffectiveEndTime

    integer

    ユーザーの有効期間の終了時刻です。値は UNIX タイムスタンプで、単位は秒です。

    1672502400
    NeedResetPassword

    boolean

    次回ログイン時にパスワードの再設定が必要かどうかを示します。有効値：

    • true

    • false

    true
    TwoFactorStatus

    string

    ユーザーに対して二要素認証が有効化されているかどうかを示します。有効値：

    • Global：グローバル設定が適用されます。

    • Disable：二要素認証は無効です。

    • Enable：二要素認証は有効です。ユーザー固有の認証方式設定が適用されます。

    Enable
    TwoFactorMethods

    array

    有効化された二要素認証方式の配列です。

    string

    有効化された二要素認証方式です。各ユーザーに対して 1 つの方式のみサポートされます。有効値：

    • sms: ショートメッセージベースの二要素認証。

    • email: メールベースの二要素認証。

    • dingtalk：DingTalk ベースの二要素認証。

    • totp：ワンタイムパスワード (OTP) トークンベースの二要素認証。

    • gmusbkey：SM ベースの USB キーによる二要素認証。

    [ "sms" ]
    LanguageStatus

    string

    通知をグローバル設定で指定された言語で送信するか、カスタム言語で送信するかを示します。

    • Global

    • Custom

    Custom
    Language

    string

    LanguageStatus が Custom に設定されている場合に必要となるパラメーターです。有効値：

    • zh-cn：簡体字中国語。

    • en：英語。

    en

    例

    成功レスポンス

    JSONJSON

    {
  "TotalCount": 1,
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "Users": [
    {
      "DisplayName": "Bob",
      "Email": "1099**@qq.com",
      "Comment": "comment",
      "MobileCountryCode": "CN",
      "Mobile": "1359999****",
      "UserId": "1",
      "Source": "Local",
      "UserName": "abc_def",
      "SourceUserId": "122748924538****",
      "UserState": [
        "[\"Normal\"]"
      ],
      "EffectiveStartTime": 1669630029,
      "EffectiveEndTime": 1672502400,
      "NeedResetPassword": true,
      "TwoFactorStatus": "Enable",
      "TwoFactorMethods": [
        "[\n      \"sms\"\n]"
      ],
      "LanguageStatus": "Custom",
      "Language": "en"
    }
  ]
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

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

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

    変更履歴

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