文档

DescribeFotaPendingDesktops - 获取待升级镜像的云电脑信息

更新时间:

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecd:DescribeFotaPendingDesktopsget
  • 全部资源
    *

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。

cn-hangzhou
MaxResultsinteger

分页查询时,每页最大行数。

  • 最大值:100
  • 默认值:20
20
NextTokenstring

查询凭证(Token)。取值为上一次调用该接口返回的NextToken参数值,初次调用接口时无需设置该参数。

caeba0bbb2be03f84eb48b699f0a4883
TaskUidstring

镜像升级任务的信息。可调用 DescribeFotaTasks 获取该参数。

aot-c4khwrp9ocml4****
DesktopIdstring

云电脑 ID。

ecd-gx2x1dhsmucyy****
OfficeSiteIdstring

办公网络 ID。可调用 DescribeOfficeSites 获取该参数。

cn-shanghai+dir-428216****
DesktopNamestring

云电脑名称。

demo-computer

返回参数

名称类型描述示例值
object

返回信息集合。

NextTokenstring

下一个查询开始的 Token,NextToken 为空表示没有下一个。

caeba0bbb2be03f84eb48b699f0a4883
RequestIdstring

请求 ID。

1CBAFFAB-B697-4049-A9B1-67E1FC5F****
FotaPendingDesktopsarray<object>

可升级到TaskUid对应版本的镜像但尚未升级的云电脑列表。

object

可升级到TaskUid对应版本的镜像但尚未升级的云电脑。

DesktopIdstring

云电脑 ID。

ecd-bvdtu3jn97o1r****
DesktopNamestring

云电脑名称。

demo-computer
OfficeSiteIdstring

办公网络 ID。

cn-shanghai+dir-428216****
FotaProjectstring
说明 此参数不对外开放使用。
windows
CurrentAppVersionstring

云电脑当前的镜像版本。

0.0.1-D-20220513.143129
Statuslong

云电脑的状态。

枚举值:
  • 0创建中
  • 1开机中
  • 2运行中
  • 3关机中
  • 5已关机
  • 6已过期
  • 7已删除
  • 9创建失败
2
Sessionsarray<object>

连接的会话列表。

object

连接的会话。

EndUserIdstring

连接的用户 ID。

alice
Codestring

状态码。

200
Messagestring

信息。

成功

示例

正常返回示例

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-25API 内部配置变更,不影响调用查看变更详情
2023-07-14OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2022-03-15新增 OpenAPI查看变更详情