查询单个桌面详情
功能介绍
指定桌面Id查询详细信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/desktops/{desktop_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。 |
|
desktop_id |
是 |
String |
桌面ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
|
Content-Type |
否 |
String |
发送的实体的MIME类型。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
desktop |
DesktopDetailInfo object |
桌面详情信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
桌面类型。
|
|
resource_type |
String |
resource_type字段,分别表示:专属桌面(DEDICATED_DESKTOP)、池桌面(POOLED_DESKTOP)、渲染桌面(RENDER_DESKTOP)、专享主机(EXCLUSIVE_HOST)、多用户桌面(SHARED_DESKTOP)。 |
|
metadata |
Map<String,String> |
桌面元数据。
|
|
flavor |
FlavorInfo object |
产品信息。 |
|
status |
String |
桌面状态。 |
|
task_status |
String |
任务状态。
|
|
in_maintenance_mode |
Boolean |
是否处于维护模式,true表示维护模式,false表示不处于维护模式。 |
|
created |
String |
桌面创建时间。 |
|
security_groups |
Array of SecurityGroupInfo objects |
桌面安全组。 |
|
login_status |
String |
桌面的登录状态。
|
|
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 |
桌面用户所属的用户组。
|
|
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 |
上网方式。
|
|
internet_mode_list |
Array of strings |
桌面使用的上网方式列表。 |
|
is_attaching_eip |
Boolean |
桌面是否正在绑定EIP。 |
|
attach_state |
String |
分配状态。
|
|
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 |
桌面对应规格的相关标记快捷链接信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
user_id |
String |
当type字段为USER时,填写用户id;当type字段为GROUP时,填写用户组id,后端服务会校验组id是否存在; |
|
user_name |
String |
桌面分配对象的名称,当type类型USER时填写用户名字;当type类型GROUP时填写用户组名称。
|
|
user_group |
String |
桌面用户所属的用户组。
|
|
type |
String |
对象类型,可选值为:
|
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
type |
String |
桌面数据盘对应的磁盘类型,需要与系统所提供的磁盘类型相匹配。
|
|
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 |
产品类型。
|
|
cpu |
String |
CPU。 |
|
memory |
String |
内存。 |
|
descriptions |
String |
产品描述。 |
|
charge_mode |
String |
周期套餐标识,0表示包周期,1表示按需。 |
|
architecture |
String |
产品架构。 |
|
is_gpu |
Boolean |
是否是GPU类型的规格。 |
|
package_type |
String |
套餐类型。
|
|
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代表下线。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
小时包已用时长。 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码,失败时返回。 |
|
error_msg |
String |
错误描述。 |
|
error_detail |
String |
错误详情。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码:401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码,失败时返回。 |
|
error_msg |
String |
错误描述。 |
|
error_detail |
String |
错误详情。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码:403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码,失败时返回。 |
|
error_msg |
String |
错误描述。 |
|
error_detail |
String |
错误详情。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码:404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码,失败时返回。 |
|
error_msg |
String |
错误描述。 |
|
error_detail |
String |
错误详情。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码:500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码,失败时返回。 |
|
error_msg |
String |
错误描述。 |
|
error_detail |
String |
错误详情。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
请求示例
/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" : [ {
"osextipsmacmacAddr" : "fa:16:3e:36:b9:a8",
"osextipstype" : "fixed",
"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" : [ {
"osextipsmacmacAddr" : "fa:16:3e:98:4a:ed",
"osextipstype" : "fixed",
"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" : [ ],
"platform_kind" : 2,
"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 |
服务内部错误,具体返回错误码请参见错误码说明。 |
错误码
请参见错误码。