文档

DescribeDesktopInfo - 查询云电脑基础信息

更新时间:

查询云电脑的基础信息。

调试

您可以在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>

云电脑基础信息。

object

云电脑基础信息。

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

管理标识。

string

管理标识。

枚举值:
  • 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 返回结构发生变更查看变更详情