赛尔校园公共服务平台 Logo
平台使用
阿里云
百度云
移动云
智算服务
教育生态
登录 →
赛尔校园公共服务平台 Logo
平台使用 阿里云 百度云 移动云 智算服务 教育生态
登录
  1. 首页
  2. 阿里云
  3. 无影云电脑企业版
  4. 开发参考
  5. API参考(云电脑管控)
  6. API目录
  7. 云电脑
  8. 云电脑资源
  9. DescribeDesktopInfo - 查询云电脑基础信息

DescribeDesktopInfo - 查询云电脑基础信息

  • 云电脑资源
  • 发布于 2025-04-17
  • 0 次阅读
文档编辑
文档编辑

查询云电脑的基础信息。

调试

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

调试

授权信息

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

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

请求参数

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

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

cn-hangzhou
DesktopIdarray否

云电脑 ID。可设置 1~100 个。

string否

云电脑 ID。

["ecd-gx2x1dhsmucyy****"]

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

062B1439-709A-580E-85DF-CE97A1560565
Desktopsarray<object>

云电脑基础信息。

Desktopobject

云电脑基础信息。

CurrentAppVersionstring

云电脑镜像版本号。

1.4.0-R-***
StartTimestring

云电脑首次启动时间。

2020-11-06T08:31Z
ConnectionStatusstring

用户的连接状态。

枚举值:
  • Connected:已连接。
  • Disconnected:已断开连接。
Disconnected
DesktopIdstring

云电脑 ID。

ecd-gx2x1dhsmucyy****
DesktopStatusstring

云电脑状态。

枚举值:
  • Stopped:已关机。
  • Failed:创建失败。
  • Starting:开机中。
  • Running:运行中。
  • Stopping:关机中。
  • Expired:已过期。
  • Deleted:已删除。
  • Pending:创建中。
Running
ManagementFlagarray

管理标识。

mgtFlagstring

管理标识。

枚举值:
  • Migrating:迁移中。
  • Updating:变配中。
  • NoFlag:无标识。
NoFlag
NewAppVersionstring

云电脑可升级的镜像版本号。

1.6.0-R-***
ReleaseNotestring

可升级的镜像版本描述。

测试升级包03-07
NewAppSizelong

升级包大小,单位为 KB。

568533470
DesktopGroupIdstring

云电脑池 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****"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-05-07OpenAPI 返回结构发生变更查看变更详情
2024-01-04OpenAPI 返回结构发生变更查看变更详情
相关文章

CreateDesktops - 创建一台或多台云电脑 2025-04-17 11:22

创建一台或多台云电脑。创建时若传入用户信息,可直接完成云电脑的分配。

CreateDiskEncryptionService - 开启磁盘加密功能 2025-04-17 11:22

开启磁盘加密功能,在用户RAM下添加企业网盘加密的服务关联角色(SLR)。

DescribeKmsKeys - 查询用户KMS密钥列表 2025-04-17 11:22

查询用户KMS密钥列表。如果是第一次访问,将尝试创建一个EDS的服务密钥,并返回结果。

DescribeDesktopInfo - 查询云电脑基础信息 2025-04-17 11:22

查询云电脑的基础信息。

DescribeDesktops - 查询云电脑详细信息 2025-04-17 11:22

查询云电脑的详细信息。

DescribeDesktopTypes - 查询云电脑规格详细信息 2025-04-17 11:22

查询云电脑规格的详细信息。

目录
Copyright © 2025 your company All Rights Reserved. Powered by 赛尔网络.
京ICP备14022346号-15
gongan beian 京公网安备11010802041014号