DescribeUsers - 查詢便捷帳號資訊 - Cloud Phone

查詢便捷帳號資訊，例如使用者名稱、郵箱地址、備忘名稱等。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ecd:DescribeUsers

list

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
MaxResults	integer	否	分頁查詢時每頁行數。取值範圍：1~500。預設值：200。	10
NextToken	string	否	下一次查詢的 Token。首次調用介面時無需設定該參數。如果一次查詢結果並沒有完整返回所有的結果，則返回的 NextToken 不為空白。您可以在查詢中上傳返回的 NextToken 繼續查詢。	caeba0bbb2be03f84eb48b699f0a****
Filter	string	否	模糊搜尋字串，支援匹配使用者名稱（EndUserId）和郵箱（Email）。該欄位支援使用萬用字元（），例如將該欄位設為`am`，則返回使用者名稱或郵箱以`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****
BizType	string	否	說明該參數不對外開放使用。	null
SolutionId	string	否	說明該參數不對外開放使用。	null
ShowExtras	object	否	查詢使用者擴充資訊。
	any	否	key 為以下類型，值為 Boolean 類型，傳 true 表示查詢指定的資訊。其中歸屬使用者組和部門預設返回。 Group: 歸屬的使用者組。 Org: 歸屬的部門。 ResourcesCount: 已指派的資源個數。 Properties: 使用者屬性。	ResourcesCount: true
FilterWithAssignedResources	object	否	根據否分配雲資源篩選使用者。
	boolean	否	key 為以下類型，值為 Boolean 類型，傳 true 表示篩選分配該雲資源的使用者。 Desktop: 雲電腦。 DesktopGroup: 共用型雲電腦。 CloudDrive: 企業網盤（使用者個人盤）。 App: 雲應用。	DesktopGroup: true
IsQueryAllSubOrgs	boolean	否	是否查詢子組織下的使用者。	true
FilterWithAssignedResource	object	否
	string	否	key 為以下類型，值為該雲資源的 ID。 DesktopGroup: 共用型雲電腦。 App: 雲應用交付組。	App:aig-jfgmanbo****
Status	integer	否	狀態
ExcludeGroupId	string	否
BusinessChannel	string	否	渠道	ENTERPRISE

返回參數

名稱	類型	描述	樣本值
	object	返回資訊集合。
RequestId	string	請求 ID。	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
NextToken	string	下一次查詢的 Token。NextToken 為空白表示沒有下一次。	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	使用者工號。	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

樣本

正常返回樣本

JSON格式

{
  "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": true,
      "PasswordExpireDays": 0,
      "PasswordExpireRestDays": 0
    }
  ]
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。