# 查询单个桌面详情 - ShowDesktopDetail #### 功能介绍 指定桌面Id查询详细信息。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/Workspace/doc?api=ShowDesktopDetail)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-workspace/workspace_09_0128.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | workspace:desktops:get | Read | desktop \* | - g:ResourceTag/\ - g:EnterpriseProjectId | - | - vpc:ports:get - vpc:ports:list - vpc:securityGroups:get - eip:publicIps:list - nat:snatRules:list | #### URI GET /v2/{project_id}/desktops/{desktop_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID。 | | desktop_id | 是 | String | 桌面ID。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表2响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | desktop | [DesktopDetailInfo] object | 桌面详情信息。 | 表3DesktopDetailInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | desktop_id | String | 桌面ID。 | | computer_name | String | 桌面名。 | | os_host_name | String | 系统计算机名。 | | addresses | Map\\> | 桌面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：专属桌面。 - SHARED: 多用户桌面 - POOLED: 池桌面 | | metadata | Map\ | 桌面元数据。 - image_name 创建桌面的镜像名称。 - image_cloud_service_type 镜像云服务类型。 - image_resource_type 镜像资源类型。 - image_spec_code 镜像规格编码。 - image_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: 切换网络中。 | | domain_status | Integer | 加域状态。\|- 1 正常。 2 脱域。 3 未上报。 | | in_maintenance_mode | Boolean | 是否处于维护模式,true表示维护模式，false表示不处于维护模式。 | | created | String | 桌面创建时间。 | | security_groups | Array of [SecurityGroupInfo] 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 | 桌面标签列表。 | | is_support_internet | Boolean | 是否开通互联网，true：已开通，false：未开通。 | | internet_mode | String | 上网方式。 - NAT：表示NAT上网方式。 - EIP：表示EIP上网方式。 - BOTH：表示两种上网方式都支持。 | | internet_mode_list | Array of strings | 桌面使用的上网方式列表。 - NAT：表示NAT上网方式。 - EIP：表示EIP上网方式。 | | 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 | 桌面小时包信息详情。 | | is_freeze | Boolean | 是否冻结 | | isolated | Boolean | 动态池桌面隔离状态，false表示未隔离，true表示已隔离。 | | domain | String | 桌面分配的域。 | | agent_version | String | agent版本。 | 表4AddressInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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地址。 | 表5FlavorInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 桌面对应的规格ID。 | | links | Array of [FlavorLinkInfo] objects | 桌面对应规格的相关标记快捷链接信息。 | 表6FlavorLinkInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | rel | String | 快捷链接标记名称。 | | hrel | String | 对应快捷链接。 | 表7SecurityGroupInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 安全组ID。 | | name | String | 安全组名称。 | 表8AttachInstancesUserInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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时：只能为中文、字母、数字及特殊符号-_。 | | domain | String | 用户所属域。 | | user_group | String | 桌面用户所属的用户组。 - sudo：Linux管理员组。 - default：Linux默认用户组。 - administrators：Windows管理员组。管理员拥有对该桌面的完全访问权，可以做任何需要的更改（禁用操作除外）。 - users：Windows标准用户组。标准用户可以使用大多数软件，并可以更改不影响其他用户的系统设置。 | | type | String | 对象类型，可选值为，默认值为USER： - USER：用户。 - GROUP：用户组。 | 表9VolumeDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | kms_id | String | 如果磁盘加密，传递的密钥。 | | type | String | 桌面数据盘对应的磁盘类型，需要与系统所提供的磁盘类型相匹配。 - SAS：高IO。 - SSD：超高IO。 | | size | Integer | 磁盘容量，单位GB。 | | iops | Integer | iops，云硬盘每秒进行读写的操作次数。 | | throughput | Integer | 吞吐量，云硬盘每秒成功传送的数据量，即读取和写入的数据量。 | | device | String | 挂载目录。 | | id | String | 磁盘唯一标识ID。 | | volume_id | String | 磁盘ID。 | | bill_resource_id | String | 磁盘计费资源ID。 | | desktop_pool_disk_id | String | 桌面池磁盘ID。 | | create_time | String | 磁盘的创建时间。 | | display_name | String | 磁盘名。 | | resource_spec_code | String | 规格。 | 表10ProductInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | product_id | String | 产品ID。 | | flavor_id | String | 产品规格ID。 | | type | String | 产品类型。 - BASE：表示产品基础套餐，套餐镜像中不包括除操作系统之外的其他商业软件，私有镜像场景只能使用此类套餐。 | | cpu | String | CPU。 | | memory | String | 内存。 | | descriptions | String | 产品描述。 | | charge_mode | String | 周期套餐标识，0表示包周期，1表示按需。 | | architecture | String | 产品架构。 | | is_gpu | Boolean | 是否是GPU类型的规格。 | | package_type | String | 套餐类型。 - ultimate：尊享版 - enterprise：企业版 - general: 通用办公版 - workstation: 云工作站 - dedicated: 专属办公版 - solver: 解算版 - agile: 敏捷办公版 | | system_disk_type | String | 系统盘类型。 | | system_disk_size | String | 系统盘大小。 | | contain_data_disk | Boolean | 套餐计费是否包含了数据盘,off-不包含。 | | resource_type | String | 资源类型。 | | cloud_service_type | String | 云服务类型。 | | volume_product_type | String | 磁盘产品类型。 | | status | String | 默认在售状态，normal代表正常，sellout代表售空，abandon代表下线。 | 表11Tag | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | 标签的键，不能为空，最大长度128个unicode字符。大小写字母，数字，可以包含中划线"-"，下划线"_"，不能包含以下字符"=","\*","\<","\>","\\",",","\|","/"。 | | value | String | 标签的值，最大长度43个unicode字符。大小写字母，数字，可以包含中划线"-"，下划线"_"，不能包含以下字符"=","\*","\<","\>","\\",",","\|","/"。 | 表12HourPackageInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | 小时包已用时长。 | **状态码：400** 表13响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | **状态码：401** 表14响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | **状态码：403** 表15响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | **状态码：404** 表16响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | **状态码：500** 表17响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | #### 请求示例 ``` GET /v2/0bec5db98280d2d02fd6c00c2de791ce/desktops/a130ab3a-72bf-4b71-baa9-af4987c8e338 ``` #### 响应示例 **状态码：200** 正常。 ``` { "desktop" : { "desktop_id" : "cb783682-323a-43fa-9f70-3e87eeed5524", "computer_name" : "tkms-test", "os_host_name" : "tkms-test", "addresses" : { "3596ca3f-0ea0-48ff-8010-3c87e72d9726" : [ { "addr" : "172.16.147.130", "version" : "4", "OS-EXT-IPS-MAC:mac_addr" : "fa:16:3e:36:b9:a8", "OS-EXT-IPS:type" : "fixed" } ], "016842ec-3d5e-41bd-8ef6-6b34acbec67e" : [ { "addr" : "172.26.204.111", "version" : "4", "OS-EXT-IPS-MAC:mac_addr" : "fa:16:3e:98:4a:ed", "OS-EXT-IPS:type" : "fixed" } ] }, "ip_addresses" : [ "172.16.147.130", "172.26.204.111" ], "ipv4" : "172.16.147.130", "ipv6" : "", "user_list" : [ ], "user_group_list" : [ ], "desktop_type" : "DEDICATED", "metadata" : { "image_name" : "WKS_WIN1064_UserImage", "metering.resourcespeccode" : "p1.2xlarge.8.win", "charging_mode" : "0", "metering.image_id" : "cc3bbc0b-9441-461b-b80b-48c52f3aed08", "metering.resourcetype" : "1", "os_type" : "Windows", "os_bit" : "64", "bill_resource_id" : "cb783682-323a-43fa-9f70-3e87eeed5524.workspace", "desktop_os_version" : "Version2009(OS Build 19041.1288)" }, "flavor" : { "id" : "p1.2xlarge.8", "links" : [ ] }, "status" : "ACTIVE", "task_status" : "", "in_maintenance_mode" : false, "created" : "2025-05-23T08:18:18.920Z", "security_groups" : [ { "id" : "ff2c8d48-c32a-4d25-8566-1d1db9119037", "name" : "WorkspaceUserSecurityGroup" } ], "login_status" : "REGISTERED", "product_id" : "workspace.x86.ultimate.2xlarge4", "root_volume" : { "type" : "SAS", "size" : 80, "device" : "/dev/vda", "id" : "76019ba137ae11f0ade6fa163e5a5e29", "volume_id" : "01643d58-af97-46f8-86c5-5c04cc2f23b4", "bill_resource_id" : "01643d58-af97-46f8-86c5-5c04cc2f23b4", "create_time" : "2025-05-23T08:18:09.213Z", "display_name" : "tkms-test-volume-0000", "resource_spec_code" : "workspace.volume.high" }, "data_volumes" : [ { "type" : "SAS", "size" : 10, "device" : "/dev/vdb", "id" : "7602c15137ae11f0ade6fa163e5a5e29", "volume_id" : "fe83ce9c-1556-41e3-a0c5-c9f978a3e0e8", "bill_resource_id" : "fe83ce9c-1556-41e3-a0c5-c9f978a3e0e8", "create_time" : "2025-05-23T08:18:09.220Z", "display_name" : "tkms-test-volume-0001", "resource_spec_code" : "workspace.volume.high" } ], "availability_zone" : "cn-north-7b", "site_type" : "CENTER", "site_name" : "华为云中心站", "product" : { "product_id" : "workspace.x86.ultimate.2xlarge4", "flavor_id" : "p1.2xlarge.8", "type" : "BASE", "cpu" : "8", "memory" : "32768", "descriptions" : "尊享办公|8核|32GB内存", "charge_mode" : "1", "architecture" : "x86", "is_gpu" : false, "package_type" : "ultimate", "system_disk_type" : "SAS", "system_disk_size" : "140", "contain_data_disk" : false, "resource_type" : "hws.resource.type.workspace.desktop", "cloud_service_type" : "hws.service.type.vdi", "volume_product_type" : "workspace", "status" : "normal" }, "os_version" : "Version2009(OS Build 19041.1288)", "sid" : "103fd06b-0b51-4a38-b322-ef48bf3010c6", "tags" : [ ], "is_support_internet" : true, "internet_mode_list" : [ "EIP" ], "is_attaching_eip" : false, "attach_state" : "UNATTACH", "enterprise_project_id" : "0", "subnet_id" : "c7f30df4-f3ac-4807-9599-18950b05455f", "bill_resource_id" : "cb783682-323a-43fa-9f70-3e87eeed5524" } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 正常。 | | 400 | 由于包含语法错误，当前请求无法被服务器理解。 | | 401 | 鉴权失败。 | | 403 | 没有操作权限。 | | 404 | 找不到资源。 | | 500 | 服务内部错误，具体返回错误码请参见错误码说明。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-workspace/ErrorCode.html)。