使用DescribeDesktopInfo查询云电脑基础信息-无影云电脑企业版-阿里云-无影云电脑企业版-阿里云帮助中心

查询云电脑的基础信息。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ecd:DescribeDesktopInfo

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
BusinessChannel	string	否
RegionId	string	是	地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。	cn-hangzhou
DesktopId	array	否	云电脑 ID。可设置 1~100 个。
	string	否	云电脑 ID。	["ecd-gx2x1dhsmucyy****"]
NeedExtraInfo	boolean	否

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	062B1439-709A-580E-85DF-CE97A1560565
Desktops	array<object>	云电脑基础信息。
	object	云电脑基础信息。
CurrentAppVersion	string	云电脑镜像版本号。	1.4.0-R-***
StartTime	string	云电脑首次启动时间。	2020-11-06T08:31Z
ConnectionStatus	string	用户的连接状态。枚举值： Connected : 已连接 Disconnected : 已断开连接	Disconnected
DesktopId	string	云电脑 ID。	ecd-gx2x1dhsmucyy****
DesktopStatus	string	云电脑状态。枚举值： Stopped : 已关机 Failed : 创建失败 Starting : 开机中 Running : 运行中 Stopping : 关机中 Expired : 已过期 Deleted : 已删除 Pending : 创建中	Running
ManagementFlag	array	管理标识。
	string	管理标识。枚举值： Migrating : 迁移中 Updating : 变配中 NoFlag : 无标识	NoFlag
NewAppVersion	string	云电脑可升级的镜像版本号。	1.6.0-R-***
ReleaseNote	string	可升级的镜像版本描述。	测试升级包03-07
NewAppSize	integer	升级包大小，单位为 KB。	568533470
DesktopGroupId	string	云电脑池 ID。	dg-3uiojcc0j4kh7****

示例

正常返回示例

JSON格式

{
  "RequestId": "062B1439-709A-580E-85DF-CE97A1560565",
  "Desktops": [
    {
      "CurrentAppVersion": "1.4.0-R-***",
      "StartTime": "2020-11-06T08:31Z",
      "ConnectionStatus": "Disconnected",
      "DesktopId": "ecd-gx2x1dhsmucyy****",
      "DesktopStatus": "Running",
      "ManagementFlag": [
        "NoFlag"
      ],
      "NewAppVersion": "1.6.0-R-***",
      "ReleaseNote": "测试升级包03-07\n",
      "NewAppSize": 568533470,
      "DesktopGroupId": "dg-3uiojcc0j4kh7****"
    }
  ]
}

错误码

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

变更历史

更多信息，参考变更详情。