云桌面 WORKSPACE-查询桌面详情列表:URI

时间:2024-12-12 19:34:19

URI

GET /v2/{project_id}/desktops/detail

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

表2 Query参数

参数

是否必选

参数类型

描述

status

String

桌面状态。

  • ACTIVE:运行中。

  • SHUTOFF:关机。

  • ERROR:异常。

  • HIBERNATED:休眠。

user_name

String

桌面所属用户,当传user_names时,本字段不生效。

user_names

Array of strings

桌面所属用户,批量筛选,最多不超过100个用户。

sort_field

String

排序字段名称,需要结合sort_type字段一起使用。

  • created 创建时间。

  • computer_name 桌面名称。

sort_type

String

排序类型,默认升序,需要结合sort_field字段一起使用。

  • ASC 升序。

  • DESC 降序。

computer_name

String

桌面名。

desktop_ip

String

桌面IP地址。

offset

Integer

用于分页查询,查询的起始记录序号,从0开始。

limit

Integer

用于分页查询,取值范围0-500,默认值500。

desktop_id

Array of strings

桌面ID。

desktop_type

String

桌面类型,为空时查所有桌面。

  • DEDICATED:普通桌面,包括专享桌面、专属桌面等

  • POOLED:池桌面,即桌面池里的桌面

tag

String

桌面的标签。样例:

  • key1=value1。

  • key1=value1,key2=value2。

pool_id

String

桌面池ID,多个桌面池ID用逗号隔开。

user_attached

Boolean

是否分配了用户。

enterprise_project_id

String

企业项目ID

image_id

String

镜像ID

charge_mode

String

计费模式,0:包周期,1:按需。

in_maintenance_mode

Boolean

按照维护模式过滤

is_share_desktop

Boolean

是否为协同桌面

subnet_id

String

桌面的子网ID。

is_support_internet

Boolean

是否支持上网。

availability_zone

String

查询可用区

support.huaweicloud.com/api-workspace/ListDesktopsDetail.html