通過調用DescribeDesktops API查詢雲電腦詳細資料-無影雲電腦企業版-阿里雲 - Elastic Desktop Service

查詢雲電腦的詳細資料。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

ecd:DescribeDesktops

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
BusinessChannel	string	否
RegionId	string	是	地區 ID。可以調用 DescribeRegions 擷取無影雲電腦支援的地區列表。	cn-hangzhou
GroupId	string	否	雲電腦池 ID。	dg-boyczi8enfyc5****
DesktopStatus	string	否	雲電腦狀態。枚舉值： Stopped : 已關機 Starting : 啟動中 Rebuilding : 重建中 Running : 運行中 Stopping : 停止中 Expired : 已到期 Deleted : 已刪除 Pending : 等待中	Running
MaxResults	integer	否	分頁查詢時每頁行數。最大值：100 預設值：10	10
NextToken	string	否	下一個查詢開始的 Token，NextToken 為空白表示沒有下一個。	caeba0bbb2be03f84eb48b699f0a4883
UserName	string	否	使用者名稱稱。	Alice
DesktopName	string	否	雲電腦名稱。	DemoComputer01
DirectoryId	string	否	目錄 ID。同辦公網路識別碼。	cn-hangzhou+dir-363353****
OfficeSiteId	string	否	辦公網路識別碼。	cn-hangzhou+dir-363353****
OfficeSiteName	string	否	辦公網路名稱。	default
PolicyGroupId	string	否	雲電腦策略 ID。	system-all-enabled-policy
ChargeType	string	否	雲電腦的計費方式。枚舉值： PostPaid : 隨用隨付 [預設值] PrePaid : 訂用帳戶	PostPaid
ExpiredTime	string	否	訂用帳戶雲電腦的到期時間。	2022-12-31T15:59:59Z
ProtocolType	string	否	協議類型。枚舉值： HDX : HDX 協議 ASP : 阿里雲自研 ASP 協議 [推薦]	ASP
DesktopId	array	否	雲電腦 ID。可設定 1~100 個。	ecd-gx2x1dhsmucyy****
	string	否	雲電腦 ID。	ecd-gx2x1dhsmucyy****
EndUserId	array	否	雲電腦的授權使用者列表。可設定 1~100 個。說明在同一時段內，只有一個使用者可以串連和使用該雲電腦。	alice
	string	否	雲電腦的授權使用者。	alice
ExcludedEndUserId	array	否	要排除的雲電腦授權使用者列表。可設定 1~100 個。	andy
	string	否	要排除的雲電腦授權使用者。	andy
FilterDesktopGroup	boolean	否	是否排除池化雲電腦（雲電腦池中的雲電腦）。枚舉值： true : 排除池化雲電腦 [預設值] false : 不排除池化雲電腦	false
ManagementFlag	string	否	管理標識。枚舉值： Migrating : 遷移中 Updating : 變更配置中 NoFlag : 無標識	NoFlag
QueryFotaUpdate	boolean	否	是否查詢雲電腦鏡像版本資訊。枚舉值： true : 查詢雲電腦鏡像升級資訊 false : 不查詢雲電腦鏡像升級資訊 [預設值]	false
Tag	array<object>	否	標籤列表。一個標籤由一對索引值對組成，用於標記資源。您可以使用標籤來分組管理雲電腦，便於搜尋和大量操作，詳情參見使用標籤管理雲電腦。
	object	否	標籤索引值對。可為每台雲電腦設定 1~20 個索引值對，一個標籤鍵只能對應一個標籤值。
Key	string	否	標籤鍵。如果傳入`Tag`，則`Key`是必填的。不可超過 128 個字元，不能以`aliyun`或`acs:`開頭，不能包含`http://`或者`https://`，也不能僅包含空格。	TestKey
Value	string	否	標籤值。不可超過 128 個字元，不能以`aliyun`或`acs:`開頭，不能包含`http://`或者`https://`。	TestValue
SnapshotPolicyId	string	否	快照策略 ID。	sp-hb12mclyne09xw***
OnlyDesktopGroup	boolean	否	是否只查詢池化雲電腦（雲電腦池中的雲電腦）。	true
DesktopGroupId	string	否	雲電腦池 ID。如果傳入了`DesktopId`，則忽略該`DesktopGroupId`；如果`DesktopId`為空白，則會根據`DesktopGroupId`去擷取該雲電腦池內所有雲電腦的`DesktopId`。	dg-2i8qxpv6t1a03****
OsTypes	array	否	作業系統類型。
	string	否	作業系統類型。枚舉值： Linux : Linux Windows : Windows	Windows
DesktopType	string	否	雲電腦規格。您可以調用 DescribeDesktopTypes 查詢雲電腦支援的規格 ID。	eds.general.2c8g
ImageId	array	否	鏡像 ID 列表。
	string	否	鏡像 ID。	m-2g65ljy3ynrdq****
DesktopStatusList	array	否	雲電腦狀態列表。
	string	否	雲電腦狀態。枚舉值： Stopped : 已關機 Starting : 啟動中 Rebuilding : 重建中 Running : 運行中 Stopping : 停止中 Expired : 已到期 Deleted : 已刪除 Pending : 等待中	Stopped
GpuInstanceGroupId	string	否	彈性顯卡池 ID。	gp-0bm2iz1v6m6nx****
QosRuleId	string	否	公網限速規則 ID。	qos-5605u0gelk200****
SubPayType	string	否	雲電腦購買方式。枚舉值： duration : 時間長度包 [白名單] postPaid : 按需購買 monthPackage : 按月購買（120 小時/250 小時） prePaid : 按月購買（不限時間長度）	monthPackage
ResourceGroupId	string	否	企業資源組 ID。	rg-4hsvzbbmqdzu3s****
FillResourceGroup	boolean	否	是否查詢企業資源組資訊。	true
PageNumber	integer	否	分頁查詢時，當前頁的頁碼。	1
PageSize	integer	否	分頁查詢時，每頁最大行數。	10
MultiResource	boolean	否	是否有多個資源。	false
IncludeAutoSnapshotPolicy	boolean	否

返回參數

名稱	類型	描述	樣本值
	object	返回資訊集合。
NextToken	string	下一個查詢開始的 Token，NextToken 為空白表示沒有下一個。	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	請求 ID。	484256DA-D816-44D2-9D86-B6EE4D5BA78C
TotalCount	integer	雲電腦總數量。	1
Desktops	array<object>	雲電腦詳細資料。
	array<object>	雲電腦詳細資料。
CreationTime	string	雲電腦建立時間。	2020-11-06T08:28Z
ChargeType	string	雲電腦的計費方式。枚舉值： PostPaid : 隨用隨付 [預設值] PrePaid : 訂用帳戶	PostPaid
DesktopName	string	雲電腦名稱。	DemoComputer01
PolicyGroupName	string	策略名稱稱。	All enabled policy
SystemDiskSize	integer	說明該參數正在邀測中，暫未開放使用。	0
PolicyGroupId	string	雲電腦策略 ID。	system-all-enabled-policy
DesktopStatus	string	雲電腦狀態。	Running
DesktopType	string	雲電腦規格。	ecd.basic.large
GpuCount	number	GPU 數量。	1
ProtocolType	string	協議類型。枚舉值： HDX : HDX 協議 ASP : 阿里雲自研 ASP 協議	ASP
Memory	integer	記憶體大小。單位：MiB。	4096
GpuSpec	string	GPU 規格。	NVIDIA T4
ImageId	string	鏡像 ID。	m-4zfb6zj728hhr****
DirectoryId	string	目錄 ID，同辦公網路識別碼（OfficeSiteId）。	cn-hangzhou+dir-363353****
ManagementFlag	string	管理標識。枚舉值： Migrating : 遷移中 Updating : 變更配置中 NoFlag : 無標識	NoFlag
DataDiskCategory	string	說明該參數正在邀測中，暫未開放使用。	null
SystemDiskCategory	string	說明該參數正在邀測中，暫未開放使用。	null
NetworkInterfaceId	string	雲電腦服務在 RAM 或 AD 使用者下建立的輔助網卡 ID，不可修改。	123456
OfficeSiteId	string	辦公網路識別碼。	cn-hangzhou+dir-363353****
DataDiskSize	string	說明該參數正在邀測中，暫未開放使用。	null
DesktopGroupId	string	雲電腦所屬的雲電腦池 ID。預設為`null`。	null
DesktopId	string	雲電腦 ID。	ecd-gx2x1dhsmucyy****
OfficeSiteName	string	辦公網路名稱。	default
StartTime	string	雲電腦初次開機時間。	2020-11-06T08:31Z
DirectoryType	string	說明該參數正在邀測中，暫未開放使用。	SIMPLE
Cpu	integer	vCPU 數量。	2
NetworkInterfaceIp	string	雲電腦服務在 RAM 或 AD 使用者下建立的輔助網卡 IP。	192.168.XX.XX
ExpiredTime	string	訂用帳戶雲電腦的到期時間。	2021-12-31T15:59Z
OsType	string	作業系統類型。	Windows
ConnectionStatus	string	使用者的串連狀態。枚舉值： Unknown : 未知 Connected : 已串連 Disconnected : 已中斷連線	Disconnected
BundleId	string	雲電腦使用的雲電腦模板 ID。	b-2g65ljy4291vl****
BundleName	string	雲電腦使用的雲電腦模板名稱。	TemplateName
OfficeSiteType	string	辦公網路的帳號系統類別型。枚舉值： SIMPLE : 便捷帳號 AD_CONNECTOR : 企業 AD 帳號	SIMPLE
HostName	string	主機名稱。	testName
Disks	array<object>	磁碟資訊。
	object	磁碟資訊。
DiskType	string	磁碟類型。枚舉值： SYSTEM : 系統硬碟 DATA : 資料盤	SYSTEM
DiskId	string	磁碟 ID。	d-jedbpr4sl9l37****
DiskSize	integer	磁碟大小。單位：GiB。	80
PerformanceLevel	string	當磁碟採用 ESSD 雲端硬碟時，ESSD 雲端硬碟的效能等級。關於各效能等級磁碟的差異，請參見 ESSD 雲端硬碟。枚舉值： PL1 : PL1 PL0 : PL0 PL3 : PL3 PL2 : PL2	PL0
DiskCategory	string	磁碟類型。 cloud_efficiency（高效雲端硬碟） cloud_auto（極速雲端硬碟） cloud_essd（增強型 SSD 雲端硬碟，僅部分規格支援）枚舉值： cloud_efficiency : 高效雲端硬碟 cloud_auto : 極速雲端硬碟 cloud_essd : 增強型 SSD 雲端硬碟，僅部分規格支援	cloud_auto
Tags	array<object>	標籤資訊。
	object	標籤資訊。
Key	string	標籤鍵。	TestKey
Value	string	標籤值。	TestValue
Sessions	array<object>	雲電腦使用者會話資訊。
	object	雲電腦使用者會話資訊。
EndUserId	string	串連雲電腦的使用者識別碼。	29615820929547****
EstablishmentTime	string	雲電腦會話串連的時間。	2021-03-07T08:23Z
ExternalUserName	string	外部使用者名稱。	Testname
EndUserIds	array	雲電腦的授權使用者 ID。
	string	雲電腦的授權使用者 ID。	alice
DowngradeQuota	integer	可以降配的次數。	3
DowngradedTimes	integer	已經降配的次數。	0
GpuCategory	integer	是否為 GPU 雲電腦。	0
GpuDriverVersion	string	雲電腦的 GPU 驅動版本號碼。	null
ZoneType	string	查詢可用性區域的類型。預設取值為`AvailabilityZone`，即普通雲上可用性區域。	AvailabilityZone
FotaUpdate	object	雲電腦的鏡像版本資訊。
CurrentAppVersion	string	雲電腦當前鏡像的版本號碼。	0.0.0-D-20220102.000000
NewAppVersion	string	雲電腦可升級的鏡像版本號碼。	0.0.0-R-20220307.190736
ReleaseNote	string	可升級鏡像的版本描述。	測試升級包03-07
Size	integer	可升級的版本安裝包大小。單位：KB。	108815097
ReleaseNoteEn	string	可升級的版本英文描述。	What's new
ReleaseNoteJp	string	可升級的版本日文描述。	リリースノート
Progress	string	雲電腦的建立進度。	100%
VolumeEncryptionEnabled	boolean	是否開啟磁碟加密。	false
VolumeEncryptionKey	string	開啟磁碟加密的情況下使用的 KMS 的金鑰識別碼。可通過 ListKeys 介面擷取。	08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****
OfficeSiteVpcType	string	辦公網路 VPC 類型。枚舉值： standard : 標準型 customized : 定製型 basic : 基礎型	basic
Platform	string	作業系統平台資訊。枚舉值： Ubuntu : Ubuntu Windows Server 2022 : Windows Server 2022 UOS : UOS CentOS : CentOS Windows Server 2019 : Windows Server 2019 Windows Server 2016 : Windows Server 2016	Ubuntu
SessionType	string	會話類型。枚舉值： SINGLE_SESSION : 單會話 MULTIPLE_SESSION : 多會話	SINGLE_SESSION
ManagementFlags	array	管理標識。
	string	雲電腦管理狀態。枚舉值： Migrating : 辦公網路遷移中 Hibernated : 已休眠 UnderMaintenance : 維護模式中 MigratingProtocol : 協議遷移中 EnterMaintenance : 進入維護模式中 WakingUp : 喚醒中 Updating : 升級中 NoFlag : 無狀態 Assigning : 分配使用者中 Hibernating : 休眠中	["NoFlag"]
SnapshotPolicyId	string	快照策略 ID。	sp-gi007jgyc3kce****
SnapshotPolicyName	string	快照策略名稱稱。	testSnapshotName
BindAmount	integer	多會話雲電腦池中，每台雲電腦允許的並發會話數。	2
PolicyGroupIdList	array	雲電腦策略 ID 集合。
	string	雲電腦策略 ID。	pg-dasffjkdf*****
PolicyGroupNameList	array	雲電腦策略名稱稱列表。
	string	雲電腦策略名稱稱。	測試策略01
HibernationOptionsConfigured	boolean	說明該參數正在邀測中，暫未開放使用。	true
SupportHibernation	boolean	是否支援休眠。	true
HibernationBeta	boolean	說明該參數正在邀測中，暫未開放使用。	true
DesktopDurationList	array<object>
	object
PackageId	string
PackageCreationTime	string
PackageExpiredTime	string
UsedDuration	integer
TotalDuration	integer
PackageStatus	string
PackageType	string
PeriodStartTime	string
PeriodEndTime	string
PostPaidLimitFee	number
PackageUsedUpStrategy	string
OrderInstanceId	string
ResourceGroups	array<object>	企業資源組資訊列表。
	object	企業資源組資訊。
Name	string	企業資源組名稱。	資源群組01
Id	string	企業資源組 ID。	rg-4hsvzbbmqdzu3s****
StandardStartTime	string
OsUpdate	object
CheckId	string
PackageCount	integer
Packages	array<object>
	object
Kb	string
Title	string
Description	string
IsLdap	boolean
DomainType	string
SerialNumber	string
AccountType	string
EntraDomainName	string
EnvType	string
EnvId	string
AgentProviderList	array
	string
PageNumber	integer	分頁查詢時，當前頁的頁碼。	1
PageSize	integer	分頁查詢時，每頁最大行數。	10

樣本

正常返回樣本

JSON格式

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "484256DA-D816-44D2-9D86-B6EE4D5BA78C",
  "TotalCount": 1,
  "Desktops": [
    {
      "CreationTime": "2020-11-06T08:28Z",
      "ChargeType": "PostPaid",
      "DesktopName": "DemoComputer01",
      "PolicyGroupName": "All enabled policy",
      "SystemDiskSize": 0,
      "PolicyGroupId": "system-all-enabled-policy",
      "DesktopStatus": "Running",
      "DesktopType": "ecd.basic.large",
      "GpuCount": 1,
      "ProtocolType": "ASP",
      "Memory": 4096,
      "GpuSpec": "NVIDIA T4",
      "ImageId": "m-4zfb6zj728hhr****",
      "DirectoryId": "cn-hangzhou+dir-363353****",
      "ManagementFlag": "NoFlag",
      "DataDiskCategory": "null",
      "SystemDiskCategory": "null",
      "NetworkInterfaceId": "123456",
      "OfficeSiteId": "cn-hangzhou+dir-363353****",
      "DataDiskSize": "null",
      "DesktopGroupId": "null",
      "DesktopId": "ecd-gx2x1dhsmucyy****",
      "OfficeSiteName": "default",
      "StartTime": "2020-11-06T08:31Z",
      "DirectoryType": "SIMPLE",
      "Cpu": 2,
      "NetworkInterfaceIp": "192.168.XX.XX",
      "ExpiredTime": "2021-12-31T15:59Z",
      "OsType": "Windows",
      "ConnectionStatus": "Disconnected",
      "BundleId": "b-2g65ljy4291vl****",
      "BundleName": "TemplateName",
      "OfficeSiteType": "SIMPLE",
      "HostName": "testName",
      "Disks": [
        {
          "DiskType": "SYSTEM",
          "DiskId": "d-jedbpr4sl9l37****",
          "DiskSize": 80,
          "PerformanceLevel": "PL0",
          "DiskCategory": "cloud_auto"
        }
      ],
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ],
      "Sessions": [
        {
          "EndUserId": "29615820929547****",
          "EstablishmentTime": "2021-03-07T08:23Z",
          "ExternalUserName": "Testname"
        }
      ],
      "EndUserIds": [
        "alice"
      ],
      "DowngradeQuota": 3,
      "DowngradedTimes": 0,
      "GpuCategory": 0,
      "GpuDriverVersion": "null",
      "ZoneType": "AvailabilityZone",
      "FotaUpdate": {
        "CurrentAppVersion": "0.0.0-D-20220102.000000",
        "NewAppVersion": "0.0.0-R-20220307.190736",
        "ReleaseNote": "測試升級包03-07",
        "Size": 108815097,
        "ReleaseNoteEn": "What's new",
        "ReleaseNoteJp": "リリースノート"
      },
      "Progress": "100%",
      "VolumeEncryptionEnabled": false,
      "VolumeEncryptionKey": "08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****",
      "OfficeSiteVpcType": "basic",
      "Platform": "Ubuntu",
      "SessionType": "SINGLE_SESSION",
      "ManagementFlags": [
        "[\"NoFlag\"]"
      ],
      "SnapshotPolicyId": "sp-gi007jgyc3kce****",
      "SnapshotPolicyName": "testSnapshotName",
      "BindAmount": 2,
      "PolicyGroupIdList": [
        "pg-dasffjkdf*****"
      ],
      "PolicyGroupNameList": [
        "測試策略01"
      ],
      "HibernationOptionsConfigured": true,
      "SupportHibernation": true,
      "HibernationBeta": true,
      "DesktopDurationList": [
        {
          "PackageId": "",
          "PackageCreationTime": "",
          "PackageExpiredTime": "",
          "UsedDuration": 0,
          "TotalDuration": 0,
          "PackageStatus": "",
          "PackageType": "",
          "PeriodStartTime": "",
          "PeriodEndTime": "",
          "PostPaidLimitFee": 0,
          "PackageUsedUpStrategy": "",
          "OrderInstanceId": ""
        }
      ],
      "ResourceGroups": [
        {
          "Name": "資源群組01",
          "Id": "rg-4hsvzbbmqdzu3s****"
        }
      ],
      "StandardStartTime": "",
      "OsUpdate": {
        "CheckId": "",
        "PackageCount": 0,
        "Packages": [
          {
            "Kb": "",
            "Title": "",
            "Description": ""
          }
        ]
      },
      "IsLdap": true,
      "DomainType": "",
      "SerialNumber": "",
      "AccountType": "",
      "EntraDomainName": "",
      "EnvType": "",
      "EnvId": "",
      "AgentProviderList": [
        ""
      ]
    }
  ],
  "PageNumber": 1,
  "PageSize": 10
}

錯誤碼

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

變更歷史

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