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

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

URI

GET /v2/{project_id}/desktops

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

表2 Query参数

参数

是否必选

参数类型

描述

user_name

Array of strings

桌面所属用户。

computer_name

String

桌面名。

desktop_ip

String

桌面IP地址。

offset

Integer

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

limit

Integer

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

pool_id

String

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

enterprise_project_id

String

企业项目ID

desktop_type

String

桌面类型,为空时查所有桌面。查询多个类型时用,隔开。

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

  • SHARED: 多用户共享桌面。

is_share_desktop

Boolean

是否为协同桌面

subnet_id

String

桌面的子网ID。

status

String

桌面的运行状态。

desktop_id

Array of strings

桌面id,当前最多支持100个桌面id进行查询。

tag

String

桌面的标签。样例:

  • key1=value1。

  • key1=value1,key2=value2。

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