查询桌面列表

project_id

是

String

项目ID。

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。

X-Auth-Token

否

String

用户Token。

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

Content-Type

否

String

发送的实体的MIME类型。

total_count

Integer

总数。

desktops

Array of SimpleDesktopInfo objects

桌面信息。

desktop_id

String

桌面ID。

computer_name

String

桌面名。

os_host_name

String

系统计算机名。

created

String

创建时间。

ip_address

String

桌面ip地址。

user_name

String

用户名。

attach_user_infos

Array of AttachInstancesUserInfo objects

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

user_group

String

权限组。

sid

String

桌面的SID信息。

ou_name

String

ou名称。

enterprise_project_id

String

企业项目ID。

tags

Array of Tag objects

标签列表。

in_maintenance_mode

Boolean

是否处于管理员维护模式。

share_resource_sku

String

桌面协同资源SKU码。

desktop_type

String

桌面类型。

subnet_id

String

桌面的子网ID。

bill_resource_id

String

桌面计费资源ID。

status

String

桌面的运行状态。

task_status

String

桌面的任务状态。

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：用户组。

key

String

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

value

String

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

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

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