すべてのプロダクト
Search

このプロダクト

    App Streaming:DescribeUsers

    ドキュメントセンター

    App Streaming:DescribeUsers

    最終更新日:Aug 19, 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    ecd:DescribeUsers

    list

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    MaxResults

    integer

    任意

    ページングクエリの 1 ページあたりのエントリ数。

    10
    NextToken

    string

    任意

    次のクエリのページネーショントークン。最初のリクエストではこのパラメーターを設定する必要はありません。単一のクエリで結果がすべて返されない場合、空ではない NextToken が返されます。後続のリクエストで返された NextToken を渡して、クエリを継続できます。

    caeba0bbb2be03f84eb48b699f0a****
    Filter

    string

    任意

    ユーザー名 (EndUserId) およびメール (Email) によるマッチングをサポートするあいまい検索文字列。このフィールドはワイルドカード (*) をサポートします。たとえば、このフィールドに a*m を設定すると、ユーザー名またはメールが a で始まり m で終わるすべての結果が返されます。

    a*m
    FilterMap

    object

    任意

    string

    任意

    EndUserIds

    array

    任意

    完全に一致させるユーザー名 (EndUserId) のリスト。

    string

    任意

    ユーザー名 (EndUserId) で完全に一致させ、一致するユーザー名のアカウント情報を照会します。

    alice
    ExcludeEndUserIds

    array

    任意

    除外するユーザー名 (EndUserId) のリスト（完全一致）。

    string

    任意

    指定されたユーザー名 (EndUserId) を完全に除外し、そのユーザー名を含まないアカウントリストを照会します。

    tony
    OrgId

    string

    任意

    組織 ID で完全に一致させ、指定された組織に属するアカウントのリストを照会します。

    org-4mdgc1cocc59z****
    GroupId

    string

    任意

    ユーザーグループ ID で完全に一致させ、指定されたユーザーグループに属するアカウントのリストを照会します。

    ug-12341234****
    ShowExtras

    object

    任意

    説明

    このパラメーターは一般公開されていません。

    null

    any

    任意

    キーは、応答に含める追加情報の種類を指定します。対応する値を true に設定すると、この情報が応答に含まれます。ユーザーグループおよび組織への所属情報はデフォルトで返されます。有効なキーは以下のとおりです。 - Group：ユーザーが所属するユーザーグループ。 - Org：ユーザーが所属する組織。 - ResourcesCount：割り当てられたリソースの数。 - Properties：ユーザー属性。

    ResourcesCount: true
    FilterWithAssignedResources

    object

    任意

    説明

    このパラメーターは一般公開されていません。

    null

    boolean

    任意

    キーはクラウドリソースの種類を指定します。値を true に設定すると、この種類のリソースが割り当てられているユーザーのみが返されます。有効なキーは以下のとおりです。 - Desktop：クラウドデスクトップ。 - DesktopGroup：共有クラウドデスクトップ。 - CloudDrive：エンタープライズクラウドドライブ（ユーザーの個人ドライブ）。 - App：クラウドアプリケーション。

    DesktopGroup: true
    IsQueryAllSubOrgs

    boolean

    任意

    拡張ユーザー情報を照会します。

    true
    FilterWithAssignedResource

    object

    任意

    クラウドリソースが割り当てられているかどうかに基づいてユーザーをフィルター処理します。

    string

    任意

    キーは以下のいずれかのタイプで、値はブール値です。指定されたクラウドリソースが割り当てられているユーザーをフィルター処理するには、値を true に設定します。

    DesktopGroup: true
    Status

    integer

    任意

    サブ組織内のユーザーをクエリするかどうかを指定します。

    true
    ExcludeGroupId

    string

    任意

    BusinessChannel

    string

    任意

    ステータス。

    ENTERPRISE

    任意

    任意

    チャンネル。

    ENTERPRISE

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメーター。

    RequestId

    string

    リクエスト ID。

    1CBAFFAB-B697-4049-A9B1-67E1FC5F****
    NextToken

    string

    次のクエリのページネーショントークン。NextToken が空の場合、これ以上結果がないことを示します。

    caeba0bbb2be03f84eb48b699f0a4883
    Count

    integer

    クエリ条件を満たすユーザーの総数。

    Users

    array<object>

    簡便アカウント情報のコレクション。

    array<object>

    簡便アカウント情報のコレクション。

    Id

    integer

    簡便アカウントの ID。

    4205**
    EndUserId

    string

    ユーザー名。

    alice
    Email

    string

    メールアドレス。

    username@example.com
    Phone

    string

    電話番号。このパラメーターが設定されていない場合は返されません。

    1381111****
    Status

    integer

    ステータス。

    列挙値:

    • 0 :

      正常。

    • 9 :

      ロック済み。

    0
    OwnerType

    string

    簡便アカウントのタイプ。以下のタイプがあります。

    列挙値:

    • CreateFromManager :

      管理者有効化。

    • Normal :

      ユーザー有効化。

    Normal
    Remark

    string

    簡便アカウントの備考。

    Test user
    OrgId

    string

    簡便アカウントが属する部門の ID。

    org-4mdgc1cocc59z****
    WyId

    string

    簡便アカウントのグローバル一意 ID。

    41fd1254d8f7****
    IsTenantManager

    boolean

    ユーザーがユーザー管理者であるかどうかを示します。簡便アカウントが管理者有効化タイプの場合、ユーザー管理者を指定する必要があります。エンドユーザーがクライアント経由で開始したパスワードリセットなどの通知は、ユーザー管理者のメールまたは電話に送信されます。詳細については、「簡便アカウントの作成」を参照してください。

    true
    Groups

    array<object>

    簡便アカウントが属するユーザーグループのコレクション。

    object

    簡便アカウントが属するユーザーグループのプロパティ。

    GroupId

    string

    ユーザーグループの ID。

    ug-12341234****
    GroupName

    string

    ユーザーグループ名。

    UserGroup1
    Orgs

    array<object>

    簡便アカウントが属する部門のコレクション。

    object

    簡便アカウントが属する部門のプロパティ。

    OrgId

    string

    部門の ID。

    org-4mdgc1cocc59z****
    OrgName

    string

    部門名。

    Department1
    OrgNamePath

    string

    Avatar

    string

    ユーザーのプロフィール画像の URL。

    https://cdn.*****
    Address

    string

    ユーザーの作業アドレス。

    Hangzhou ***
    NickName

    string

    ユーザーのニックネーム。値は以下の順序で決定されます。

    Li**
    RealNickName

    string

    ユーザーの表示名。

    Li**
    JobNumber

    string

    ユーザーの社員番号。

    A10000**
    Extras

    object

    拡張ユーザー情報。

    AssignedResourceCount

    object

    割り当てられたクラウドリソースの数。

    any

    サポートされているクラウドリソースタイプ:

    Desktop: 3
    ResourcePolicyList

    array<object>

    object

    PolicyId

    string

    PolicyName

    string

    ExternalName

    string

    外部ソースからインポートされたユーザー名。

    Ma**
    Properties

    array<object>

    ユーザープロパティ。

    object

    プロパティリスト。

    Key

    string

    プロパティ名。

    Role
    Value

    string

    プロパティ値。

    Student
    EnableAdminAccess

    boolean

    管理者アクセス権限が有効かどうかを示します。

    PasswordExpireDays

    integer

    PasswordExpireRestDays

    integer

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "Count": 0,
  "Users": [
    {
      "Id": 0,
      "EndUserId": "alice",
      "Email": "username@example.com",
      "Phone": "1381111****",
      "Status": 0,
      "OwnerType": "Normal",
      "Remark": "Test user.",
      "OrgId": "org-4mdgc1cocc59z****",
      "WyId": "41fd1254d8f7****",
      "IsTenantManager": true,
      "Groups": [
        {
          "GroupId": "ug-12341234****",
          "GroupName": "用户组1"
        }
      ],
      "Orgs": [
        {
          "OrgId": "org-4mdgc1cocc59z****",
          "OrgName": "部门1",
          "OrgNamePath": ""
        }
      ],
      "Avatar": "https://cdn.*****",
      "Address": "杭州市***",
      "NickName": "李**",
      "RealNickName": "李**",
      "JobNumber": "A10000**",
      "Extras": {
        "AssignedResourceCount": {
          "key": "Desktop: 3"
        },
        "ResourcePolicyList": [
          {
            "PolicyId": "",
            "PolicyName": ""
          }
        ]
      },
      "ExternalName": "马**",
      "Properties": [
        {
          "Key": "Role",
          "Value": "Student"
        }
      ],
      "EnableAdminAccess": false,
      "PasswordExpireDays": 0,
      "PasswordExpireRestDays": 0
    }
  ]
}

    エラーコード

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

    変更履歴

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