DescribeGlobalDesktops - 查询全地域云电脑详细信息_无影云电脑企业版-阿里云帮助中心

查询多个地域的云电脑详细信息。目前仅支持中国内地对应的地域查询（不包含：南京-本地地域-关停中）。

接口说明

此接口为中心化域名，接入点为上海，不支持其他地域调用。
此接口中的云电脑状态信息与实际值有 1~3 秒的延迟。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。枚举值： cn-shanghai：华东2（上海）。	cn-shanghai
DirectoryId	string	否	办公网络 ID。说明该参数即将停用，请使用`OfficeSiteId`。	cn-hangzhou+dir-880841****
OfficeSiteId	string	否	办公网络 ID。说明 `DirectoryId`参数即将停用，请使用该字段。	cn-hangzhou+dir-880841****
ClientId	string	是	客户端生成的唯一 ID。	c213150d-7ac3-432c-b749-6e1e090b****
SessionId	string	是	会话 ID。通过登录接口 GetLoginToken 获取，返回参数：SessionId。	5c456a41-1e65-4e72-ab4d-5dcfff52****
LoginToken	string	是	登录凭证。通过 GetLoginToken 接口登录获取，或登录后通过更新接口 RefreshLoginToken 获取。返回参数：LoginToken。	v147c9114a180489f89691663893169****
DesktopStatus	string	否	云电脑状态。枚举值： Stopped：已关机。 Starting：启动中。 Rebuilding：重建中。 Running：运行中。 Stopping：停止中。 Expired：已过期。 Deleted：已删除。 Pending：等待中。	Running
MaxResults	integer	否	分页查询时每页行数。最大值：500 默认值：10	500
NextToken	string	否	下一个查询开始的 Token，NextToken 为空表示没有下一个。	eyJkZWZhdWx0IjpbIjk2MjEy****
DesktopName	string	否	云电脑名称。	DesktopTest
DesktopId	array	否	云电脑 ID。可设置一个或多个，取值范围：1~20。
	string	否	云电脑 ID。	ecd-hkbl45il187d6****
SearchRegionId	string	否	搜索地域 ID。用于过滤出指定地域的云电脑信息。	cn-shanghai
DesktopAccessType	string	否	连接云电脑时允许使用的接入方式。说明 VPC 连接方式依赖于阿里云私网连接（PrivateLink）服务，该服务不收取费用。该参数设置为 VPC 或者 Any 时，系统将自动为您开通私网连接服务。枚举值： INTERNET：只允许客户端通过公网连接云电脑 [默认值]。 VPC：只允许处于VPC网络内的客户端连接云电脑。 Any：使用客户端连接云电脑时可以自行选择连接方式。	INTERNET
QueryFotaUpdate	boolean	否	是否查询镜像更新信息。	true
WithoutLatency	boolean	否	是否查询实时云电脑信息。当前接口中云电脑状态信息有 1~3 秒延迟，如果需要准确信息可将此值设为`true`。	true
OrderBy	string	否	排序字段。若不指定则按照创建时间倒序排列。枚举值： AssignTime：按照分配时间排序。	AssignTime
SortType	string	否	排序方式。枚举值： ASC：升序 [默认值]。 DESC：降序。	ASC
Keyword	string	否	关键字。支持模糊搜索云电脑 ID、云电脑名称和终端用户自定义的云电脑名称。	ecd
LoginRegionId	string	否	办公网络所在的地域 ID，使用组织 ID 登录时置为空。使用办公网络 ID 登录时，该参数必填。使用组织 ID 登录时，该参数可为空。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object
NextToken	string	下一个查询开始的 Token，NextToken 为空表示没有下一个。	eyJkZWZhdWx0IjpbIjIwMjItMDgtMTdUM****
RequestId	string	请求 ID。	4686A731-D601-548C-83E2-4CB6371E****
Desktops	array<object>	云电脑详细信息。
Desktop	object	云电脑详细信息。
CreationTime	string	云电脑的创建时间。	2020-11-06T08:28Z
ChargeType	string	付费类型。枚举值： PostPaid：按量付费。 PrePaid：包年包月。	PostPaid
DesktopName	string	云电脑名称。	testDesktopName
HostName	string	主机名称。	testName
DesktopGroupId	string	共享型云电脑 ID。	dg-3uiojcc0j4kh7****
DesktopId	string	云电脑 ID。	ecd-gx2x1dhsmucyy****
RegionId	string	地域 ID。	cn-hangzhou
LastStartTime	string	上次开机时间，即最近一次的开机时间。	2021-07-13T15:59Z
Cpu	integer	CPU 个数。	2
EndUserId	string	终端用户名称。	alice
ExpiredTime	string	云电脑的过期时间。对于包年包月云电脑，该返回值有实际意义。对于按量付费云电脑，均返回`2099-12-31T15:59Z`。	2021-12-31T15:59Z
DesktopStatus	string	云电脑状态。	Running
DesktopType	string	云电脑规格。	ecd.basic.large
ConnectionStatus	string	终端节点连接状态。枚举值： Connected：已连接。 Disconnecting：断开连接中。 Pending：修改中。 Connecting：连接中。 Disconnected：未连接。 Deleting：删除中。	Disconnected
Memory	long	云电脑的内存。单位：MiB。	4096
ImageId	string	镜像 ID。	m-4zfb6zj728hhr****
DirectoryId	string	办公网络 ID，同`OfficeSiteId`。	cn-hangzhou+dir-jedbpr4sl9l37****
Disks	array<object>	磁盘信息。
Disk	object	磁盘信息。
DiskType	string	磁盘类型。枚举值： SYSTEM：系统盘。 DATA：数据盘。	SYSTEM
DiskId	string	磁盘 ID。	d-jedbpr4sl9l37****
DiskSize	integer	磁盘大小。单位：GiB。	80
OsType	string	操作系统类型。枚举值： Linux：Linux。 Windows：Windows。	Windows
Sessions	array<object>	会话信息列表。
Session	object	会话信息。
EndUserId	string	终端用户信息。	alice
EstablishmentTime	string	会话创建时间。	2021-03-07T08:23Z
PolicyGroupId	string	云电脑策略 ID。	pg-9cktlowtxfl6****
EndUserIds	array	终端用户列表。
endUserId	string	终端用户名。	alice
GpuMemory	integer	显存大小。对于 GPU 型云电脑，该返回值有实际意义。单位：MB。	2048
FotaUpdate	object	镜像的更新信息。
Project	string	项目名称。	testProject
Channel	string	订阅通道。	Enterprise
CurrentAppVersion	string	云电脑当前版本号。	0.0.0-D-20220102.xxxx
NewAppVersion	string	更新后的应用版本号。	0.0.0-R-20220307.xxxx
Force	boolean	是否强制升级。	false
ReleaseNote	string	可升级的版本描述。	测试升级包03-07
Size	string	可升级的版本安装包大小。单位：MiB。	100
ReleaseNoteEn	string	可升级的版本英文描述。	Release note
ReleaseNoteJp	string	可升级的版本日文描述。	リリースノート
ProtocolType	string	协议类型。枚举值： HDX：HDX协议。 ASP：阿里云自研ASP协议。	ASP
OfficeSiteId	string	办公网络 ID。	cn-hangzhou+dir-363353****
NetworkInterfaceIp	string	网卡 IP。	192.168.XX.XX
UserCustomName	string	用户自定义的云电脑名称。	testDesktop
ManagementFlags	array	云电脑管理状态列表。
ManagementFlag	string	云电脑管理状态。枚举值： UNDER_MAINTENANCE：维护模式中。 MIGRATING：办公网络迁移中。 ASSIGNING：分配用户中。 MIGRATING_PROTOCOL：协议迁移中。 NO_FLAG：无状态。 ENTER_MAINTENANCE：进入维护模式中。 UPDATING：升级中。	UPDATING
LocalName	string	地域名称。	华东2（上海）
RealDesktopId	string	如果是共享型云电脑并且已分配真实云电脑，则显示云电脑 ID。	ecd-gx2x1dhsm****
DesktopTimers	array<object>	云电脑定时器对象。
DesktopTimer	object
TimerType	string	定时任务类型。枚举值： NoOperationDisconnect：无操作断连。 NoConnectShutdown：无连接关机。 TimerBoot：定时开机。 TimerReset：定时重置。 NoOperationShutdown：无操作关机。 TimerShutdown：定时关机。 NoOperationReboot：无操作重启。 TimerReboot：定时重启。	NoConnectShutdown
CronExpression	string	定时任务 Cron 表达式。例如：`0 0 4 1/1 * ?`表示从每月第一天上午 4 时开始，每天执行操作。	0 0 0 ? * 1
Interval	integer	时间间隔，单位为秒。	60
Enforce	boolean	是否强制执行。为`true`表示忽略云电脑及连接状态检测，强制执行定时任务。	false
ResetType	string	如果是重置任务，需设置重置类型。枚举值： RESET_TYPE_SYSTEM：重置系统盘。 RESET_TYPE_USER_DISK：重置数据盘。 RESET_TYPE_BOTH：重置系统盘和数据盘。	RESET_TYPE_BOTH
AllowClientSetting	boolean	是否允许客户端设置策略。	true
OperationType	string	定时任务类型。枚举值： HIBERNATE：休眠。 SHUTDOWN：关机。	SHUTDOWN
ExecutionTime	string	任务执行时间。	2021-12-31T15:59Z
Clients	array<object>	支持的客户端信息。
Client	object	支持的客户端信息。
Status	string	客户端状态。枚举值： OFF：不允许登录。 ON：允许登录。	ON
ClientType	string	客户端类型。枚举值： html5：Web客户端。 android：Android客户端。 linux：Linux客户端。 ios：iOS客户端。 windows：Windows客户端。 macos：macOS客户端。	windows
SupportHibernation	boolean	是否支持休眠。枚举值： true：支持。 false：不支持。	true
HibernationBeta	boolean	是否为休眠测试版本。	true
SessionType	string	会话类型。枚举值： SINGLE_SESSION：单会话。 MULTIPLE_SESSION：多会话。	SINGLE_SESSION
Platform	string	操作系统平台信息。枚举值： Ubuntu：Ubuntu。 UOS：UOS。 CentOS：CentOS。 Windows Server 2019：Windows Server 2019。 Windows Server 2016：Windows Server 2016。	Ubuntu
Os	string	操作系统类型	Windows

示例

正常返回示例

JSON格式

{
  "NextToken": "eyJkZWZhdWx0IjpbIjIwMjItMDgtMTdUM****",
  "RequestId": "4686A731-D601-548C-83E2-4CB6371E****",
  "Desktops": [
    {
      "CreationTime": "2020-11-06T08:28Z",
      "ChargeType": "PostPaid",
      "DesktopName": "testDesktopName",
      "HostName": "testName",
      "DesktopGroupId": "dg-3uiojcc0j4kh7****",
      "DesktopId": "ecd-gx2x1dhsmucyy****",
      "RegionId": "cn-hangzhou",
      "LastStartTime": "2021-07-13T15:59Z",
      "Cpu": 2,
      "EndUserId": "alice",
      "ExpiredTime": "2021-12-31T15:59Z",
      "DesktopStatus": "Running",
      "DesktopType": "ecd.basic.large",
      "ConnectionStatus": "Disconnected",
      "Memory": 4096,
      "ImageId": "m-4zfb6zj728hhr****",
      "DirectoryId": "cn-hangzhou+dir-jedbpr4sl9l37****\t",
      "Disks": [
        {
          "DiskType": "SYSTEM",
          "DiskId": "d-jedbpr4sl9l37****",
          "DiskSize": 80
        }
      ],
      "OsType": "Windows",
      "Sessions": [
        {
          "EndUserId": "alice",
          "EstablishmentTime": "2021-03-07T08:23Z"
        }
      ],
      "PolicyGroupId": "pg-9cktlowtxfl6****",
      "EndUserIds": [
        "alice"
      ],
      "GpuMemory": 2048,
      "FotaUpdate": {
        "Project": "testProject",
        "Channel": "Enterprise",
        "CurrentAppVersion": "0.0.0-D-20220102.xxxx",
        "NewAppVersion": "0.0.0-R-20220307.xxxx",
        "Force": false,
        "ReleaseNote": "测试升级包03-07",
        "Size": 100,
        "ReleaseNoteEn": "Release note",
        "ReleaseNoteJp": "リリースノート",
        "NewDcdVersion": ""
      },
      "ProtocolType": "ASP",
      "OfficeSiteId": "cn-hangzhou+dir-363353****",
      "NetworkInterfaceIp": "192.168.XX.XX",
      "UserCustomName": "testDesktop",
      "ManagementFlags": [
        "UPDATING"
      ],
      "LocalName": "华东2（上海）",
      "RealDesktopId": "ecd-gx2x1dhsm****",
      "DesktopTimers": [
        {
          "TimerType": "NoConnectShutdown",
          "CronExpression": "0 0 0 ? * 1",
          "Interval": 60,
          "Enforce": false,
          "ResetType": "RESET_TYPE_BOTH",
          "AllowClientSetting": true,
          "OperationType": "SHUTDOWN",
          "ExecutionTime": "2021-12-31T15:59Z"
        }
      ],
      "Clients": [
        {
          "Status": "ON",
          "ClientType": "windows"
        }
      ],
      "SupportHibernation": true,
      "HibernationBeta": true,
      "SessionType": "SINGLE_SESSION",
      "Platform": "Ubuntu",
      "Os": "Windows",
      "RegionLocation": "",
      "OsDescription": ""
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-11-09	OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-09-27	OpenAPI 返回结构发生变更	查看变更详情
2024-08-13	OpenAPI 返回结构发生变更	查看变更详情
2023-12-13	OpenAPI 返回结构发生变更	查看变更详情
2023-12-11	OpenAPI 返回结构发生变更	查看变更详情
2023-08-02	OpenAPI 返回结构发生变更	查看变更详情
2023-05-18	OpenAPI 返回结构发生变更	查看变更详情
2023-03-22	OpenAPI 入参发生变更	查看变更详情
2022-10-18	OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情