接口功能介紹

查詢云電腦列表

接口約束

無

URI

GET /v3/desktop/describe

路徑參數
無

Query參數

參數	是否必填	參數類型	說明	示例
regionId	是	String	資源池ID。	d8bbd132b53a11e9b0e40242ac110002
desktopOid	否	String	云電腦ID	D0023092701181644
pubUserOids	否	String	分配用戶ID。取值由用戶ID組成一個JSON數組，最多支持10個ID，ID之間用半角逗號（,）隔開。
["upg-xxx","upg-yyy"]
userAccount	否	String	用戶賬戶。全匹配模式。	1026199440@qq.com
status	否	String	運行狀態（Creating-創建中;Stopped-已關機;Starting-啟動中;Running-運行中;Rebooting-重啟中;Rebuilding-重裝中;Stopping-關閉中;Deleting-刪除中;Unhealthy-異常;RollingBack-回滾中;Resizing-變更中;Evacuating-遷移中;Rescuing-救援中;BackingUp-備份中;DeletingBackup-刪除備份中;Regaining-恢復中;Hibernating-休眠中;Hibernated-已休眠;WakingUp-喚醒中）	Running
pageNum	否	Integer	頁碼，至少1，默認1	1
pageSize	否	Integer	每頁數量，最大100，默認10	10

請求參數

請求頭header參數
無

請求體body參數
無

響應參數

參數	參數類型	說明	示例	下級對象
statusCode	Integer	狀態碼。可能值： - 800：請求成功。 - 900：請求失敗。	800
error	String	錯誤碼。	ECPC_1000
message	String	提示信息。	OK
returnObj	Object	返回數據對象		returnObj

表 returnObj

參數	參數類型	說明	示例	下級對象
total	Long	總記錄數
list	Array of Objects	數據列表		list

表 list

參數	參數類型	說明	示例	下級對象
desktopOid	String	云電腦ID	D0023092701181644
desktopName	String	云電腦名稱	0000ecae-BxvPeMkJUH
nickname	String	云電腦別名	null
osType	String	操作系統類型（Windows;Linux）	Windows
status	String	運行狀態（Creating-創建中;Stopped-已關機;Starting-啟動中;Running-運行中;Rebooting-重啟中;Rebuilding-重裝中;Stopping-關閉中;Deleting-刪除中;Deleted-已刪除;Unhealthy-異常;RollingBack-回滾中;Resizing-變更中;Evacuating-遷移中;Rescuing-救援中;BackingUp-備份中;DeletingBackup-刪除備份中;Regaining-恢復中;Hibernating-休眠中;Hibernated-已休眠;WakingUp-喚醒中）	Running
flavorType	String	規格類型。枚舉值范圍：[Common-通用型, Gpu-GPU型]。	Common
cpu	Integer	CPU個數	4
memory	Integer	內存大小（單位：GB）	8
gpuMemory	Integer	顯存大小（單位：GB）。僅對GPU規格云電腦有意義。	2
sysDisk	Object	系統盤		sysDisk
dataDisks	Array of Objects	數據盤		dataDisks
imageOid	String	鏡像ID	mi-xxljp5pe22329w9pp5834
osName	String	操作系統名稱	Windows 2016 Standard 64位中文版（生產）
org	Object	歸屬部門		org
vpcOid	String	VPC ID	vpc-xxdwpyq2jgc62h8fjd2e4
vpcName	String	VPC名稱	vpc-u9ck
subnets	Array of Objects	所在子網集合		subnets
eipAddress	Object	彈性IP	null	eipAddress
pubUserOid	String	分配用戶ID（當且僅當用戶與云電腦綁定成功時返回）	upg-68xjc1c655mmccohrq1m6
userName	String	分配用戶名稱（當且僅當用戶與云電腦綁定成功時返回）	陸小果
desktopPool	Object	歸屬桌面池。為空時代表不是桌面池的云電腦。		desktopPool
chargeType	String	計費方式。枚舉值范圍：[PrePaid-包年包月, ResourcePack-資源包]	ResourcePack
createTime	String	創建時間。以ISO 8601為標準，并使用UTC+0時間，格式為yyyy-MM-ddTHH:mm:ssZ。	2023-09-27T03:29:10Z
expireTime	String	到期時間。以ISO 8601為標準，并使用UTC+0時間，格式為yyyy-MM-ddTHH:mm:ssZ。	2023-11-13T02:34:07Z

表 sysDisk

參數	參數類型	說明	示例
diskOid	String	磁盤ID	D0023092701181641
diskType	String	磁盤類型（hio-高IO（high IO）；uhio-超高IO（ultra-high IO）	0000ecae-1bIessjYhZ
diskSize	Integer	磁盤大小。單位：GB	80
diskUuid	String	磁盤UUID	6b646e82-552f-4be7-aa93-27be0bdf96f3
availableBytes	String	磁盤剩余可用字節數。單位：B。注意：上報情況存在延遲，可能為空。

表 dataDisks

參數	參數類型	說明	示例
diskOid	String	磁盤ID	D0023092701181641
diskType	String	磁盤類型（hio-高IO（high IO）；uhio-超高IO（ultra-high IO）	0000ecae-1bIessjYhZ
diskSize	Integer	磁盤大小。單位：GB8	80
diskUuid	String	磁盤UUID	6b646e82-552f-4be7-aa93-27be0bdf96f3
availableBytes	String	磁盤剩余可用字節數。單位：B。注意：上報情況存在延遲，可能為空。

表 org

參數	參數類型	說明	示例	下級對象
orgOid	String	部門ID	org-18qnu7l41v8fr2xif6jdq
completeOrgName	String	完整部門名稱。由從根部門到當前部門的名稱，以半角斜線號（/）為分隔符拼接而成。	1026199440@qq.com#貴州測試/API_test

表 subnets

參數	參數類型	說明	示例	下級對象
subnetOid	String	子網ID		sn-59blq3pui5z53da4bmx7i
privateIpAddresses	Array of Objects	私有IP地址集合		privateIpAddresses

表 privateIpAddresses

參數	參數類型	說明	示例	下級對象
address	String	IP地址		192.168.100.174

表 eipAddress

參數	參數類型	說明	示例	下級對象
eipId	String	彈性IP ID		null
ipAddress	String	IP地址	null

表 desktopPool

參數	參數類型	說明	示例
desktopPoolOid	String	桌面池ID	dp-ybiqd3vedlt5u4cspy6vd
poolName	String	桌面池	API_test
poolType	String	桌面池類型。枚舉值范圍：[Common-池化, Concurrent-并發]。	Concurrent

枚舉參數

無

請求示例

請求url

無

請求頭header

無

請求體body

無

響應示例

{"statusCode":800,"message":"OK.","returnObj":{"total":1,"list":[{"desktopOid":"XXXXXXXXXXXXX6925","desktopName":"desktopName","nickname":"nickname","osType":"Windows","status":"Running","flavorType":"Common","cpu":1,"memory":2,"gpuMemory":2,"org":{"orgOid":"fooId","completeOrgName":"fooRootName/fooName"},"vpcOid":"vpc-xxx","vpcName":"fooName","subnets":[{"subnetOid":"sn-xxx","privateIpAddresses":[{"address":"192.168.1.99"}]}],"eipAddress":{"eipId":"XXX","ipAddress":"X.X.X.X"},"sysDisk":{"diskOid":"vol-xxx","diskType":"hio","diskSize":80},"dataDisks":[{"diskOid":"vol-yyy","diskType":"hio","diskSize":10}],"imageOid":"mi-xxx","osName":"Windows 2016 Standard 64位 中文版","pubUserOid":"upg-xxx","userName":"fooName","desktopPool":{"desktopPoolOid":"dp-xxx","poolName":"fooName","poolType":"Common"},"chargeType":"ResourcePack","createTime":"2099-09-09T00:00:00Z","expireTime":"2099-09-09T00:00:00Z"}]}}

狀態碼

請參考

錯誤碼

請參考

亚欧色一区w666天堂,色情一区二区三区免费看,少妇特黄A片一区二区三区,亚洲人成网站999久久久综合,国产av熟女一区二区三区

智算服務

應用商城

定價

合作伙伴

開發者

支持與服務

了解天翼云

天翼云電腦（政企版）

天翼云電腦（政企版）

接口功能介紹

接口約束

URI

請求參數

響應參數

枚舉參數

請求示例

響應示例

狀態碼

錯誤碼

亚欧色一区w666天堂,色情一区二区三区免费看,少妇特黄A片一区二区三区,亚洲人成网站999久久久综合,国产av熟女一区二区三区

活動

智算服務

應用商城

定價

合作伙伴

開發者

支持與服務

了解天翼云

天翼云電腦（政企版）

天翼云電腦（政企版）

接口功能介紹

接口約束

URI

請求參數

響應參數

枚舉參數

請求示例

響應示例

狀態碼

錯誤碼