调用DescribeFotaPendingDesktops获取待升级桌面信息_无影云电脑企业版(EDS)-阿里云帮助中心

获取可升级到指定版本镜像但尚未升级的云电脑信息。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。	cn-hangzhou
MaxResults	integer	否	分页查询时，每页最大行数。最大值：100 默认值：20	20
NextToken	string	否	查询凭证（Token）。取值为上一次调用该接口返回的`NextToken`参数值，初次调用接口时无需设置该参数。	caeba0bbb2be03f84eb48b699f0a4883
TaskUid	string	是	镜像升级任务的信息。可调用 DescribeFotaTasks 获取该参数。	aot-c4khwrp9ocml4****
DesktopId	string	否	云电脑 ID。	ecd-gx2x1dhsmucyy****
OfficeSiteId	string	否	办公网络 ID。可调用 DescribeOfficeSites 获取该参数。	cn-shanghai+dir-428216****
DesktopName	string	否	云电脑名称。	demo-computer

返回参数

名称	类型	描述	示例值
	object	返回信息集合。
NextToken	string	下一个查询开始的 Token，NextToken 为空表示没有下一个。	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	请求 ID。	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
FotaPendingDesktops	array<object>	可升级到`TaskUid`对应版本的镜像但尚未升级的云电脑列表。
FotaPendingDesktop	object	可升级到`TaskUid`对应版本的镜像但尚未升级的云电脑。
DesktopId	string	云电脑 ID。	ecd-bvdtu3jn97o1r****
DesktopName	string	云电脑名称。	demo-computer
OfficeSiteId	string	办公网络 ID。	cn-shanghai+dir-428216****
FotaProject	string	说明此参数不对外开放使用。	windows
CurrentAppVersion	string	云电脑当前的镜像版本。	0.0.1-D-20220513.143129
Status	long	云电脑的状态。枚举值： 0：创建中。 1：开机中。 2：运行中。 3：关机中。 5：已关机。 6：已过期。 7：已删除。 9：创建失败。	2
Sessions	array<object>	连接的会话列表。
Session	object	连接的会话。
EndUserId	string	连接的用户 ID。	alice
Code	string	状态码。	200
Message	string	信息。	成功

示例

正常返回示例

JSON格式

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "FotaPendingDesktops": [
    {
      "DesktopId": "ecd-bvdtu3jn97o1r****",
      "DesktopName": "demo-computer",
      "OfficeSiteId": "cn-shanghai+dir-428216****",
      "FotaProject": "windows",
      "CurrentAppVersion": "0.0.1-D-20220513.143129",
      "Status": 2,
      "Sessions": [
        {
          "EndUserId": "alice"
        }
      ]
    }
  ],
  "Code": "200",
  "Message": "成功"
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-07-25	API 内部配置变更，不影响调用	查看变更详情
2023-07-14	OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情
2022-03-15	新增 OpenAPI	查看变更详情