調用DescribeUserResources API查詢使用者無影雲資源清單-無影雲電腦企業版-阿里雲

查詢使用者資源清單。

介面說明

請確保在使用該介面前，已充分瞭解無影產品的資源類型和產品類型。

調試

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

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱	類型	必填	描述	樣本值
ClientId	string	是	用戶端產生的唯一 ID，參考 UUID。該參數非敏感欄位，無需加密。	54c17e1d-2d72-4b87-aa33-25f3b3f2****
ClientType	string	否	用戶端的類型。枚舉值： html5 : 網頁用戶端 android : Android 用戶端 windows : Windows 用戶端 ios : iOS 用戶端 macos : macOS 用戶端	windows
ClientVersion	string	否	用戶端版本。	7.6.0-R-20241112.222305
LoginToken	string	是	登入憑證。通過`GetLoginToken`介面登入擷取，或登入後通過更新介面`RefreshLoginToken`擷取。返回參數：LoginToken。	v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****
SessionId	string	否	會話 ID。調用`GetLoginToken`介面擷取。	cd45e873-650d-4d70-acb9-f996187a****
LoginRegionId	string	否	登入的地區 ID，用於辦公網路識別碼登入情境。組織 ID 登入情境無需填寫。	cn-hangzhou
SearchRegionId	string	否	搜尋地區 ID。用於過濾出指定地區的雲資源資訊。	cn-hangzhou
OfficeSiteIds	array	否	辦公網路識別碼列表。AD 帳號登入時填寫。
	string	否	辦公網路識別碼。	cn-hangzhou+dir-5440****
ResourceTypes	array	否	資源類型列表，為空白則查詢所有資源類型。
	string	否	資源類型。枚舉值： App : 雲應用（含雲應用、雲手機、雲瀏覽器） Desktop : 雲電腦 DesktopGroup : 共用型雲電腦 CloudDrive : 企業網盤	Desktop
ProductTypes	array	否	產品類型列表，為空白則查詢所有產品類型。
	string	否	產品類型。枚舉值： CloudDesktop : 雲電腦（含雲電腦和共用型雲電腦） CloudApp : 雲應用 CloudBrowser : 雲瀏覽器 AndroidCloud : 雲手機	CloudApp
ResourceIds	array	否	資源 ID 列表。可設定 0~100 個。
	string	否	資源 ID。	ecd-00001
ResourceName	string	否	資源名稱，支援模糊搜尋。	testName
ProtocolType	string	否	協議類型。該參數僅用於過濾雲電腦。枚舉值： HDX : HDX 協議 ASP : 阿里巴巴自研 ASP 協議	ASP
AccessType	string	否	接入類型，不傳表示兩種都顯示。枚舉值： INTERNET : 互連網接入 VPC : 企業專網接入	INTERNET
Language	string	否	用戶端語言。枚舉值： en_US : 英語 zh_CN : 簡體中文 ja_JP : 日語	zh-CN
CategoryType	integer	否	資源一級類目。	1
CategoryId	integer	否	資源二級類目。	0
QueryFotaUpdate	boolean	否	是否查詢雲電腦鏡像版本資訊。	false
RefreshFotaUpdate	boolean	否	是否即時重新整理 OTA 資訊。	false
OrderBy	string	否	排序欄位，若不指定則按照建立時間倒序。枚舉值： CreateTime : 資源建立時間 AssignTime : 資源授權時間	AssignTime
SortType	string	否	排序方式。枚舉值： ASC : 升序 [預設值] DESC : 降序	ASC
MaxResults	integer	否	分頁查詢時每頁行數。預設值 500。	500
NextToken	string	否	下一頁 Token。	caeba0bbb2be03f84eb48b699f0a4883
AutoRefresh	boolean	否	是否立即重新整理。說明為了保證介面響應速度，建議傳入`false`。枚舉值： false : 不立即重新整理 true : 立即重新整理	false
Scene	string	否	用戶端情境，用於標識排序。請傳入`desktop`。枚舉值： desktop : 雲電腦	desktop
DualCenterForward `deprecated`	boolean	否	是否雙中心轉寄。請傳入`false`。枚舉值： false : 非雙中心轉寄	false
QueryDesktopTimers	boolean	否	是否查詢雲電腦定時任務資訊，預設為 true。枚舉值： true : 是，預設值 false : 否	true
QueryDesktopDurationList	boolean	否	是否查詢CloudDesktop套餐包資訊，預設為 true。枚舉值： true : 是，預設值 false : 否	true

返回參數

名稱	類型	描述	樣本值
	object
NextToken	string	下一頁查詢開始的 Token，NextToken 為空白表示沒有下一頁。	AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****
RequestId	string	請求 ID。	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
QueryFailedResourceTypes	array	查詢失敗的資源類型列表。
	string	資源類型枚舉值： CloudDesktop : 雲電腦（含雲電腦和共用型雲電腦） CloudApp : 雲應用（含雲應用、雲手機、雲瀏覽器） CloudDrive : 企業網盤	CloudDesktop
Resources	array<object>	資來源詳細資料列表。
	array<object>	資來源詳細資料。
AliUid	integer	阿里雲帳號 ID。	194101959****
ResourceType	string	資源類型。枚舉值： App : 雲應用（含雲應用、雲手機、雲瀏覽器） Desktop : 雲電腦 DesktopGroup : 共用型雲電腦 CloudDrive : 企業網盤	Desktop
RegionId	string	地區 ID。	cn-hangzhou
RegionLocation	string	地區位置。枚舉值： Mainland : 中國內地地區 Overseas : 海外地區（含中國香港）	Mainland
ResourceGroupId	string	資源群組 ID。	dg-0****
ResourceId	string	資源 ID。	ecd-d19tya8zi4****
ResourceLevel	string	資源層級。枚舉值： Center : 中心化資源 Region : 單元化資源	Center
CenterResourceId	string	中心化資源 ID。	ecds-0****
ResourceName	string	資源名稱。	testName01
CreateTime	string	資源建立時間。	2024-12-11T07:12:12Z
ProductType	string	產品類型。枚舉值： CloudDesktop : 雲電腦（含雲電腦和共用型雲電腦） CloudApp : 雲應用 CloudBrowser : 雲瀏覽器 AndroidCloud : 雲手機	AndroidCloud
OfficeSiteId	string	辦公網路識別碼。	cn-shanghai+dir-3367****
AccessType	string	接入類型。枚舉值： INTERNET : 互連網接入 VPC : 企業專網接入 ANY : 互連網接入和企業專網接入均可以	INTERNET
ProtocolType	string	協議類型。枚舉值： HDX : HDX 協議 ASP : 阿里巴巴自研 ASP 協議	ASP
OsType	string	作業系統類型。枚舉值： Linux : Linux Windows : Windows Android : Android	Windows
Os	string	作業系統平台資訊。	Windows Server 2022
OsDescription	string	作業系統平台描述資訊。	Windows 正版授權
SupportHibernation	boolean	是否支援休眠。枚舉值： true : 支援休眠 false : 不支援休眠	true
HibernationBeta	boolean	是否為休眠測試版本。枚舉值： true : 是休眠測試版本 false : 不是休眠測試版本	false
SessionType	string	會話類型。枚舉值： SINGLE_SESSION : 單會話 MULTIPLE_SESSION : 多會話	SINGLE_SESSION
ChargeType	string	計費方式。枚舉值： PostPaid : 隨用隨付 [預設值] PrePaid : 訂用帳戶	PrePaid
SubPayType	string	子計費方式。枚舉值： monthPackage : 按月預付費 PrePaid : 時間長度包	PrePaid
ExpiredTime	string	訂用帳戶付費類型資源的到期時間。	2025-02-22T16:00:00Z
AuthMode	string	雲應用授權模式。枚舉值： App : 應用授權 AppInstanceGroup : 交付組授權 Session : 會話授權	App
AppId	string	應用 ID。資源類型為 App 的資源特有參數。	app-0001
Version	string	資源版本。資源類型為 App 的資源特有參數。	資源版本。
CategoryType	integer	資源一級類目。資源類型為 App 的資源特有參數。	1
CategoryId	integer	資源二級類目。資源類型為 App 的資源特有參數。	0
Icon	string	資源表徵圖連結。資源類型為 App 的資源特有參數。	http://example.com/icon.png
ThemeColor	string	資源佈景主題色彩。資源類型為 App 的資源特有參數。	#FFFFFF
CdsName	string	網盤名稱。資源類型為 CloudDrive 的資源特有參數。	cn-shanghai+cds-695277****
ExternalDomainId	string	外部 Domain ID。資源類型為 CloudDrive 的資源特有參數。	stg114510
ExternalUserId	string	外部使用者 ID。資源類型為 CloudDrive 的資源特有參數。	test001
GlobalStatus	boolean	是否支援跨地區訪問。資源類型為 CloudDrive 的資源特有參數。	true
LocalName	string	地區名稱。	華東1（杭州）
DesktopTimers	array<object>	雲電腦定時任務設定列表。
	object	雲電腦定時任務設定。
TimerType	string	任務類型。	TimerBoot
CronExpression	string	定時任務的 Cron 運算式。	0 30 13 ? * 1-7
Interval	integer	定時任務間隔時間。	15
Enforce	boolean	是否強制執行。	false
ResetType	string	重設類型。	RESET_TYPE_SYSTEM
AllowClientSetting	string	是否允許用戶端設定。	false
OperationType	string	操作類型。	Hibernate
ExecutionTime	string	執行時間。	2025-01-21T11:37Z
Clients	array<object>	資源支援的用戶端類型列表。
	object	資源支援的單類用戶端類型設定資訊。
ClientType	string	用戶端類型。	windows
Status	string	支援狀態。枚舉值： OFF : 禁用 ON : 啟用	ON
ResourceStatus	string	資源狀態。枚舉值： Unknown : 未知 Stopped : 已關機 Failed : 建立失敗 Starting : 啟動中 Rebuilding : 變更中 Running : 運行中 Stopping : 停止中 FotaUpdating : 鏡像升級中 Pending : 等待中 Deleting : 刪除中 Unavailable : 不可用	Running
LastStartTime	string	資源上次啟動時間。	2025-01-24T03:12:04Z
OrderStatus	string	訂單狀態。枚舉值： Ceased : 後付費欠費 Released : 訂單關閉 Expired : 預付費停機 Normal : 正常	Normal
ManagementStatuses	array	管理狀態列表。
	string	管理狀態	NoFlag
ResourceSessionStatus	string	工作階段狀態。枚舉值： Unknown : 未知 Connected : 已串連 Disconnected : 已中斷連線	Connected
Sessions	array<object>	資源使用者會話資訊列表。
	object	資源使用者會話資訊。
UserId	string	登入資源的使用者名稱。	user001
UserPrincipalName	string	綁定資源的使用者的 UPN（如果有），只有當前查詢使用者的 Session 該值才可能有值。	benchmark_test@test.shenzhen
ResourceSessionStartTime	string	資源會話串連的時間。	2025-01-22T11:03:36Z
NickName	string	使用者的暱稱。	user-001
RealDesktopId	string	【共用型雲電腦】真實雲電腦 ID，當共用型雲電腦存在會話時存在。	ecd-0001
UserCustomName	string	使用者自訂名稱。	我的雲電腦
FotaUpdate	object	雲電腦升級資訊。
Project	string	專案名稱。	wuying-asp_single_session_desktop_win_x64
Channel	string	通道。	aliyun
CurrentAppVersion	string	雲電腦當前鏡像的版本號碼。	2.7.0-R-20250122.154826
NewAppVersion	string	雲電腦可升級的版本號碼。	2.7.0-R-20250125.154826
Force	boolean	是否強制升級。	false
ReleaseNote	string	可升級的版本描述。	新版本
Size	string	可升級的版本安裝包大小。單位：KB。	474981930
ReleaseNoteEn	string	可升級的版本英文描述。	new version
ReleaseNoteJp	string	可升級的版本日文描述。	新バージョン
NewDcdVersion	string	可升級的組件盤版本號碼。	2.6.9-R-20250123.153415
OsUpdate	object	作業系統升級資訊。
CheckId	string	校正 ID。	wua-1740652957251743***
PackageCount	integer	包數量。	1
Packages	array<object>	補丁包資訊列表。
	object	補丁包資訊。
Kb	string	補丁號。	KB2267***
Title	string	補丁標題。	用於****的補丁。
Description	string	補丁描述。	安裝此更新可修改用於檢測病毒、間諜軟體和其他潛在垃圾軟體的檔案。此項一旦安裝，便無法刪除。
KbListString	string	補丁號列表資訊。	KB2267***
UpdateCatalogUrl	string	更新分類 URL。	https://catalog.update.microsoft.com/home.aspx
HasUpgrade	boolean	是否存在更新。	true
DesktopDurationList	array<object>	雲電腦套餐包資訊列表。
	object	雲電腦套餐包資訊。
PackageCreationTime	string	建立時間。	2025-01-17T07:01Z
PackageStatus	string	狀態。	Available
UsedDuration	integer	已使用時間長度。	16850
PackageExpiredTime	string	到期時間。	2025-02-17T15:59Z
PackageId	string	套餐包 ID。	mdp-0bxls4qpi6bl6****
TotalDuration	integer	總時間長度。	432000
PackageType	string	時間長度包類型。枚舉值： FREE_PACKAGE : 免費包 NORMAL_PACKAGE : 付費包（120 小時包） POSTPAID_PACKAGE : 用於記錄後付費額度包（200 小時包） Duration : 時間長度包	NORMAL_PACKAGE
PeriodStartTime	string	當月包開始時間。	2025-01-17T07:01Z
PeriodEndTime	string	當月包結束時間。	2025-02-17T15:59Z
PostPaidLimitFee	number	第二階段包的封頂金額。說明僅 ResourceType 為`POSTPAID_PACKAG`和`FREE_PACKAGE`時會返回。	199
OrderInstanceId	string	訂單一實例 ID。	mdp-0bxls4qpi6bl6****
PackageUsedUpStrategy	string	套餐當月額度使用完畢後的雲電腦狀態策略。枚舉值： Shutdown : 關機或休眠 Postpaid : 繼續使用並隨用隨付	Postpaid
ConnectionProperties	string	串連屬性，JSON 字串，用戶端無需關心內容，當應用資源建聯時直接傳遞給中心資源管控。	{"authMode":"App"}
SupportedActions	array	支援的操作類型列表，目前只支援雲手機和雲電腦（含共用型雲電腦）。
	string	操作類型。枚舉值： WakeUp : 喚醒 Hibernate : 休眠 Start : 開機 Stop : 關機 Restart : 重啟	Start
RankVersion	integer	排序資料版本號碼。	1732869815062
TotalCount	integer	總數。	10
MaxResults	integer	返回最大數量。	100

返回參數並不是所有資源都擁有，請確保清楚每種資源擁有哪些參數欄位。

樣本

正常返回樣本

JSON格式

{
  "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "QueryFailedResourceTypes": [
    "CloudDesktop"
  ],
  "Resources": [
    {
      "AliUid": 0,
      "ResourceType": "Desktop",
      "RegionId": "cn-hangzhou",
      "RegionLocation": "Mainland",
      "ResourceGroupId": "dg-0****",
      "ResourceId": "ecd-d19tya8zi4****",
      "ResourceLevel": "Center",
      "CenterResourceId": "ecds-0****",
      "ResourceName": "testName01",
      "CreateTime": "2024-12-11T07:12:12Z",
      "ProductType": "AndroidCloud",
      "OfficeSiteId": "cn-shanghai+dir-3367****",
      "AccessType": "INTERNET",
      "ProtocolType": "ASP",
      "OsType": "Windows",
      "Os": "Windows Server 2022",
      "OsDescription": "Windows 正版授權",
      "SupportHibernation": true,
      "HibernationBeta": false,
      "SessionType": "SINGLE_SESSION",
      "ChargeType": "PrePaid",
      "SubPayType": "PrePaid",
      "ExpiredTime": "2025-02-22T16:00:00Z",
      "AuthMode": "App",
      "AppId": "app-0001",
      "Version": "資源版本。",
      "CategoryType": 1,
      "CategoryId": 0,
      "Icon": "http://example.com/icon.png",
      "ThemeColor": "#FFFFFF",
      "CdsName": "cn-shanghai+cds-695277****",
      "ExternalDomainId": "stg114510",
      "ExternalUserId": "test001",
      "GlobalStatus": true,
      "LocalName": "華東1（杭州）",
      "DesktopTimers": [
        {
          "TimerType": "TimerBoot",
          "CronExpression": "0 30 13 ? * 1-7",
          "Interval": 15,
          "Enforce": false,
          "ResetType": "RESET_TYPE_SYSTEM",
          "AllowClientSetting": "false",
          "OperationType": "Hibernate",
          "ExecutionTime": "2025-01-21T11:37Z"
        }
      ],
      "Clients": [
        {
          "ClientType": "windows",
          "Status": "ON"
        }
      ],
      "ResourceStatus": "Running",
      "LastStartTime": "2025-01-24T03:12:04Z",
      "OrderStatus": "Normal",
      "ManagementStatuses": [
        "NoFlag"
      ],
      "ResourceSessionStatus": "Connected",
      "Sessions": [
        {
          "UserId": "user001",
          "UserPrincipalName": "benchmark_test@test.shenzhen",
          "ResourceSessionStartTime": "2025-01-22T11:03:36Z",
          "NickName": "user-001"
        }
      ],
      "RealDesktopId": "ecd-0001",
      "UserCustomName": "我的雲電腦",
      "FotaUpdate": {
        "Project": "wuying-asp_single_session_desktop_win_x64",
        "Channel": "aliyun",
        "CurrentAppVersion": "2.7.0-R-20250122.154826",
        "NewAppVersion": "2.7.0-R-20250125.154826",
        "Force": false,
        "ReleaseNote": "新版本",
        "Size": "474981930",
        "ReleaseNoteEn": "new version",
        "ReleaseNoteJp": "新バージョン",
        "NewDcdVersion": "2.6.9-R-20250123.153415"
      },
      "OsUpdate": {
        "CheckId": "wua-1740652957251743***",
        "PackageCount": 1,
        "Packages": [
          {
            "Kb": "KB2267***",
            "Title": "用於****的補丁。",
            "Description": "安裝此更新可修改用於檢測病毒、間諜軟體和其他潛在垃圾軟體的檔案。此項一旦安裝，便無法刪除。"
          }
        ],
        "KbListString": "KB2267***",
        "UpdateCatalogUrl": "https://catalog.update.microsoft.com/home.aspx"
      },
      "HasUpgrade": true,
      "DesktopDurationList": [
        {
          "PackageCreationTime": "2025-01-17T07:01Z",
          "PackageStatus": "Available",
          "UsedDuration": 16850,
          "PackageExpiredTime": "2025-02-17T15:59Z",
          "PackageId": "mdp-0bxls4qpi6bl6****",
          "TotalDuration": 432000,
          "PackageType": "NORMAL_PACKAGE",
          "PeriodStartTime": "2025-01-17T07:01Z",
          "PeriodEndTime": "2025-02-17T15:59Z",
          "PostPaidLimitFee": 199,
          "OrderInstanceId": "mdp-0bxls4qpi6bl6****",
          "PackageUsedUpStrategy": "Postpaid"
        }
      ],
      "ConnectionProperties": "{\"authMode\":\"App\"}",
      "SupportedActions": [
        "Start"
      ]
    }
  ],
  "RankVersion": 1732869815062,
  "TotalCount": 10,
  "MaxResults": 100
}

錯誤碼

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

變更歷史

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