查询桌面详情列表

project_id

是

String

项目ID。

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

查询可用区。

X-Auth-Token

否

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

Content-Type

否

String

发送的实体的MIME类型。

desktops

Array of DesktopDetailInfo objects

桌面详情列表。

total_count

Integer

桌面总数。

desktop_id

String

桌面ID。

computer_name

String

桌面名。

os_host_name

String

系统计算机名。

addresses

Map<String,Array<AddressInfo>>

桌面IP地址列表。

ip_addresses

Array of strings

IP地址列表。

ipv4

String

系统计算机IPV4。

ipv6

String

系统计算机IPV6。

user_list

Array of strings

用户列表。

user_group_list

Array of strings

用户组列表。

desktop_type

String

桌面类型。

• DEDICATED：专属桌面。

resource_type

String

resource_type字段，分别表示：专属桌面（DEDICATED_DESKTOP）、池桌面（POOLED_DESKTOP）、渲染桌面（RENDER_DESKTOP）、专享主机（EXCLUSIVE_HOST）、多用户桌面(SHARED_DESKTOP)。

metadata

Map<String,String>

桌面元数据。

• charging_mode 周期套餐标识，1表示包周期，0表示按需。

• image_name 创建桌面的镜像名称。

• bill_resource_id 镜像计费资源ID。

• metering.image_id 镜像ID。

• metering.resourcespeccode 桌面资源编码。

• metering.resourcetype 桌面资源类型。

• os_bit 操作系统位数：32或64。

• os_type 操作系统类型：Linux、Windows或Others。

• desktop_os_version 操作系统版本。

flavor

FlavorInfo object

产品信息。

status

String

桌面状态。

task_status

String

任务状态。

• scheduling：创建中，正在进行调度。

• block_device_mapping：创建中，正在准备磁盘。

• networking：创建中，正在准备网络。

• spawning：创建中，正在内部创建。

• rebooting：重启中。

• reboot_pending：重启中，正在下发重启。

• reboot_started：重启中，开始内部重启。

• rebooting_hard：强制重启中。

• reboot_pending_hard：强制重启中，正在下发重启。

• reboot_started_hard：强制重启中，开始内部重启。

• rebuilding：重建中。

• rebuild_block_device_mapping：重建中，正在准备磁盘。

• rebuild_spawning：重建中，正在内部重建。

• migrating：热迁移中。

• resize_prep：调整规格中，正在准备阶段。

• resize_migrating：调整规格中，正在迁移阶段。

• resize_migrated：调整规格中，已经完成迁移。

• resize_finish：调整规格中，正在完成调整。

• resize_reverting：调整规格中，正在回退调整。

• powering-off：停止中。

• powering-on：启动中。

• deleting：删除中。

• deleteFailed：删除失败。

• updating: 更新中。

• desktopNetworkChanging: 切换网络中。

created

String

桌面创建时间。

security_groups

Array of SecurityGroup objects

桌面安全组。

login_status

String

桌面的登录状态。

• UNREGISTER：表示桌面未注册时的状态（桌面启动后，会自动注册）。关机后也会出现未注册的状态。

• REGISTERED：表示桌面注册以后，等待用户连接的状态。

• CONNECTED：表示用户已经成功登录，正在使用桌面。

• DISCONNECTED：表示桌面与客户端断开会话后显示的状态，可能为关闭客户端窗口，或客户端与桌面网络断开引起。

user_name

String

桌面所属用户。

attach_user_infos

Array of AttachInstancesUserInfo objects

桌面已分配的用户信息列表。

product_id

String

产品ID。

share_resource_sku

String

桌面协同资源SKU码。

root_volume

VolumeDetail object

系统盘。

data_volumes

Array of VolumeDetail objects

数据盘列表。

user_group

String

桌面用户所属的用户组。

• sudo：Linux管理员组。

• default：Linux默认用户组。

• administrators：Windows管理员组。管理员拥有对该桌面的完全访问权，可以做任何需要的更改（禁用操作除外）。

• users：Windows标准用户组。标准用户可以使用大多数软件，并可以更改不影响其他用户的系统设置。

availability_zone

String

可用分区。

site_type

String

站点类型。

site_name

String

站点名字。

product

ProductInfo object

产品信息。

ou_name

String

创建桌面时加入的OU名称。

os_version

String

操作系统版本号。

sid

String

SID。

order_id

String

包周期产品的订单ID。

tags

Array of Tag objects

桌面标签列表。

internet_mode

String

上网方式。

• NAT：表示NAT上网方式。

• EIP：表示EIP上网方式。

• BOTH：表示两种上网方式都支持。

internet_mode_list

Array of strings

桌面使用的上网方式列表。

is_attaching_eip

Boolean

桌面是否正在绑定EIP。

attach_state

String

分配状态。

• ATTACHED：已分配。

• UNATTACH：未分配 表示未关联。

• DEATTACHED：已解分配。

• ATTACHING：分配中。

• DEATTACHING：解分配中。

• ATTACHFAIL：分配失败。

• DEATTACHFAIL：解分配失败。

• WAITING：等待被分配中,描述从批量分配（解分配）下发到转入分配（解分配）的中间状态 同时方便单个关联流程的状态独立性。

• ATTACH_FAIL_CAN_ATTACH_AGAIN：分配失败,还可以再关联。

• DEATTACH_FAIL_CAN_DEATTACH_AGAIN：解分配失败,还可以再解分配。

enterprise_project_id

String

企业项目ID。

subnet_id

String

桌面的子网ID。

bill_resource_id

String

桌面计费资源ID。

process

Integer

桌面任务进度， 取值范围0-100以及null，null表示该桌面无任务，0-100表明该任务进度的百分比。

root_resource_id

String

整机实例根资源ID。

hour_package_info

HourPackageInfo object

桌面小时包信息详情。

addr

String

IP地址信息。

version

String

IP地址类型，值为4或6，分别表示IPV4和IPV6。

OS-EXT-IPS-MAC:mac_addr

String

MAC地址。

OS-EXT-IPS:type

String

IP地址分配方式。

-fixed 私有IP地址。

-floating 浮动IP地址。

id

String

桌面对应的规格ID。

links

Array of FlavorLinkInfo objects

桌面对应规格的相关标记快捷链接信息。

rel

String

快捷链接标记名称。

hrel

String

对应快捷链接。

id

String

安全组ID。

user_id

String

当type字段为USER时，填写用户id；当type字段为GROUP时，填写用户组id，后端服务会校验组id是否存在；

user_name

String

桌面分配对象的名称，当type类型USER时填写用户名字；当type类型GROUP时填写用户组名称。

• 当type类型USER时：桌面所属的用户，当桌面分配成功后此用户可以登录该桌面。只允许输入大写字母、小写字母、数字、中划线（-）和下划线（_）。域类型为LITE_AD时，使用小写字母或者大写字母开头，长度范围为[1-20]。当域类型为LOCAL_AD时，用户名可以使用小写字母或者大写字母或者数字开头，长度范围为[1-64]。Windows桌面用户最长支持20个字符，Linux桌面用户最长支持64个字符。后端服务会校验用户名是否存在，并且用户名不能与机器名重复。

• 当type类型GROUP时：只能为中文、字母、数字及特殊符号-_。

user_group

String

桌面用户所属的用户组。

• sudo：Linux管理员组。

• default：Linux默认用户组。

• administrators：Windows管理员组。管理员拥有对该桌面的完全访问权，可以做任何需要的更改（禁用操作除外）。

• users：Windows标准用户组。标准用户可以使用大多数软件，并可以更改不影响其他用户的系统设置。

type

String

对象类型，可选值为：

• USER：用户。

• GROUP：用户组。

type

String

桌面数据盘对应的磁盘类型，需要与系统所提供的磁盘类型相匹配。

• SAS：高IO。

• SSD：超高IO。

size

Integer

磁盘容量，单位GB。

device

String

挂载目录。

id

String

磁盘唯一标识ID。

volume_id

String

磁盘ID。

bill_resource_id

String

磁盘计费资源ID。

create_time

String

磁盘的创建时间。

display_name

String

磁盘名。

resource_spec_code

String

规格。

product_id

String

产品ID。

flavor_id

String

产品规格ID。

type

String

产品类型。

• BASE：表示产品基础套餐，套餐镜像中不包括除操作系统之外的其他商业软件，私有镜像场景只能使用此类套餐。

cpu

String

CPU。

memory

String

内存。

descriptions

String

产品描述。

charge_mode

String

周期套餐标识，0表示包周期，1表示按需。

key

String

标签的键，不能为空，最大长度128个unicode字符。大小写字母，数字，可以包含中划线“-”，下划线“_”，不能包含以下字符“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

value

String

标签的值，最大长度43个unicode字符。大小写字母，数字，可以包含中划线“-”，下划线“_”，不能包含以下字符“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

root_order_id

String

小时包根订单ID。

package_resource_id

String

小时包资源ID。

package_instance_id

String

小时包实例ID。

package_spec_code

String

小时包specCode。

combined_product_type_code

String

组合商品resourceTypeCode。

use_up_policy

String

小时包用完策略：SHUTDOWN_OR_HIBERNATE：自动关机/休眠；PAY_PER_USE：自动按需计费。

package_duration

Integer

小时包总时长。

use_duration

Integer

小时包已用时长。

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

200

查询云桌面详情列表响应。

400

由于包含语法错误，当前请求无法被服务器理解。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误，具体返回错误码请参见错误码说明。