云桌面 WORKSPACE-查询桌面详情列表:URI
URI
GET /v2/{project_id}/desktops/detail
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
status |
否 |
String |
桌面状态。
|
user_name |
否 |
String |
桌面所属用户,当传user_names时,本字段不生效。 |
user_names |
否 |
Array of strings |
桌面所属用户,批量筛选,最多不超过100个用户。 |
sort_field |
否 |
String |
排序字段名称,需要结合sort_type字段一起使用。
|
sort_type |
否 |
String |
排序类型,默认升序,需要结合sort_field字段一起使用。
|
computer_name |
否 |
String |
桌面名。 |
desktop_ip |
否 |
String |
桌面IP地址。 |
offset |
否 |
Integer |
用于分页查询,查询的起始记录序号,从0开始。 |
limit |
否 |
Integer |
用于分页查询,取值范围0-500,默认值500。 |
desktop_id |
否 |
Array of strings |
桌面ID。 |
desktop_type |
否 |
String |
桌面类型,为空时查所有桌面。
|
tag |
否 |
String |
桌面的标签。样例:
|
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 |
查询可用区 |