すべてのプロダクト
Search

このプロダクト

    Cloud Phone:DescribeUsers

    ドキュメントセンター

    Cloud Phone:DescribeUsers

    最終更新日:Apr 04, 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～500。

    • デフォルト値：200。

    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

    任意

    説明

    このパラメーターは利用できません。

    any

    任意

    キーは次のいずれかのタイプで、値はブール型です。true を渡すと、指定された情報が照会されます。デフォルトでは、ユーザーが属するグループと部門に関する情報が返されます。 - Group：ユーザーが属するグループ。 - Org：ユーザーが属する部門。 - ResourcesCount：割り当てられたリソースの数。 - Properties：ユーザー属性。

    ResourcesCount: true
    FilterWithAssignedResources

    object

    任意

    説明

    このパラメーターは利用できません。

    boolean

    任意

    キーは次のいずれかのタイプで、値はブール型です。true を渡すと、指定されたクラウドリソースが割り当てられているユーザーがフィルターされます。 - Desktop：クラウド PC。 - DesktopGroup：共有クラウド PC。 - CloudDrive：エンタープライズクラウドドライブ (ユーザーの個人用ドライブ)。 - App：クラウドアプリケーション。

    DesktopGroup: true
    IsQueryAllSubOrgs

    boolean

    任意

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

    true
    FilterWithAssignedResource

    object

    任意

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

    string

    任意

    キーは次のいずれかのタイプで、値はブール型です。true を渡すと、指定されたクラウドリソースが割り当てられているユーザーがフィルターされます。

    • Desktop：クラウド PC。

    • DesktopGroup：共有クラウド PC。

    • CloudDrive：エンタープライズクラウドドライブ (ユーザーの個人用ドライブ)。

    • App：クラウドアプリケーション。

    App:aig-jfgmanbo****
    Status

    integer

    任意

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

    ExcludeGroupId

    string

    任意

    クエリ結果からメンバーを除外するユーザーグループの ID。

    BusinessChannel

    string

    任意

    ステータス

    ENTERPRISE

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答オブジェクト。

    RequestId

    string

    リクエスト ID。

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

    string

    結果の次のページを取得するために使用されるトークン。空の値は、すべての結果が返されたことを示します。

    caeba0bbb2be03f84eb48b699f0a4883
    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

    ユーザーグループの名前。

    用户组1
    Orgs

    array<object>

    簡易ユーザーが属する組織。

    object

    組織の詳細。

    OrgId

    string

    組織の ID。

    org-4mdgc1cocc59z****
    OrgName

    string

    組織の名前。

    部门1
    OrgNamePath

    string

    Avatar

    string

    ユーザーアバターの URL。

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

    string

    ユーザーの勤務先住所。

    杭州市***
    NickName

    string

    ユーザーのニックネーム。
    値は、次のソースから利用可能な最初の名前で、優先順位に従います。

    • RealNickName

    • Remark

    • EndUserId

    李**
    RealNickName

    string

    ユーザーの表示名。

    李**
    JobNumber

    string

    従業員 ID。

    A10000**
    Extras

    object

    ユーザーに関する拡張情報。

    AssignedResourceCount

    object

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

    any

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

    • Desktop：クラウドデスクトップ。

    • DesktopGroup：共有クラウドデスクトップ。

    • CloudDrive：エンタープライズクラウドドライブ (ユーザーの個人用ドライブ)。

    • APP：クラウドアプリケーション。

    Desktop: 3
    ExternalName

    string

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

    説明

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

    马**
    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",
  "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"
        }
      },
      "ExternalName": "马**",
      "Properties": [
        {
          "Key": "Role",
          "Value": "Student"
        }
      ],
      "EnableAdminAccess": false,
      "PasswordExpireDays": 0,
      "PasswordExpireRestDays": 0
    }
  ]
}

    エラーコード

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

    変更履歴

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