查询单个桌面详情
功能介绍
指定桌面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 |
任务状态。
|
created |
String |
桌面创建时间。 |
security_groups |
Array of SecurityGroup 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 |
桌面标签列表。 |
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表示按需。 |
参数 |
参数类型 |
描述 |
---|---|---|
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 |
错误描述。 |
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,失败时返回。 |
error_msg |
String |
错误描述。 |
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,失败时返回。 |
error_msg |
String |
错误描述。 |
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,失败时返回。 |
error_msg |
String |
错误描述。 |
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,失败时返回。 |
error_msg |
String |
错误描述。 |
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
请求示例
/v2/0bec5db98280d2d02fd6c00c2de791ce/desktops/a130ab3a-72bf-4b71-baa9-af4987c8e338
响应示例
状态码: 200
正常。
{ "desktop" : { "desktop_id" : "string", "computer_name" : "string", "os_host_name" : "string", "addresses" : { "additionalProp1" : [ { "addr" : "string", "version" : "strin", "OS-EXT-IPS-MAC:mac_addr" : "string", "OS-EXT-IPS:type" : "string" } ], "additionalProp2" : [ { "addr" : "string", "version" : "strin", "OS-EXT-IPS-MAC:mac_addr" : "string", "OS-EXT-IPS:type" : "string" } ], "additionalProp3" : [ { "addr" : "string", "version" : "strin", "OS-EXT-IPS-MAC:mac_addr" : "string", "OS-EXT-IPS:type" : "string" } ] }, "ip_addresses" : [ "string" ], "ipv4" : "string", "ipv6" : "string", "user_list" : [ "string" ], "user_group_list" : [ "string" ], "desktop_type" : "string", "resource_type" : "string", "metadata" : { "additionalProp1" : "string", "additionalProp2" : "string", "additionalProp3" : "string" }, "flavor" : { "id" : "string", "links" : [ { "rel" : "string", "hrel" : "string" } ] }, "status" : "string", "task_status" : "string", "in_maintenance_mode" : true, "created" : "string", "security_groups" : [ { "id" : "string", "name" : "string" } ], "login_status" : "string", "user_name" : "string", "attach_user_infos" : [ { "user_id" : "string", "user_name" : "string", "user_group" : "string", "type" : "USER" } ], "product_id" : "string", "share_resource_sku" : "string", "root_volume" : { "encrypt_flag" : "strin", "kms_key" : "string", "key_alias" : "string", "type" : "string", "size" : 2147483647, "kms_grant_id" : "string", "device" : "string", "id" : "string", "volume_id" : "string", "bill_resource_id" : "string", "create_time" : "string", "display_name" : "string", "cluster_id" : "string", "resource_spec_code" : "string" }, "data_volumes" : [ { "encrypt_flag" : "strin", "kms_key" : "string", "key_alias" : "string", "type" : "string", "size" : 2147483647, "kms_grant_id" : "string", "device" : "string", "id" : "string", "volume_id" : "string", "bill_resource_id" : "string", "create_time" : "string", "display_name" : "string", "cluster_id" : "string", "resource_spec_code" : "string" } ], "user_group" : "string", "availability_zone" : "string", "site_type" : "string", "site_name" : "string", "product" : { "product_id" : "string", "flavor_id" : "string", "type" : "string", "cpu" : "string", "memory" : "string", "descriptions" : "string。", "charge_mode" : "s", "architecture" : "string", "cpu_desc" : "string", "is_gpu" : true, "package_type" : "string", "system_disk_type" : "SAS", "system_disk_size" : "80", "gpu_desc" : "string", "contain_data_disk" : true, "resource_type" : "string", "cloud_service_type" : "string", "volume_product_type" : "string", "status" : "string", "sub_product_list" : [ "string" ] }, "ou_name" : "string", "os_version" : "string", "sid" : "string", "join_domain" : "s", "order_id" : "string", "tags" : [ { "key" : "string", "value" : "" } ], "deh_id" : "string", "platform_kind" : 100, "is_support_internet" : true, "internet_mode" : "string", "internet_mode_list" : [ "string" ], "need_apply_adn" : true, "is_attaching_eip" : true, "desktop_isv" : "DEFAULT", "creation_type" : "string", "attach_state" : "string", "enterprise_project_id" : "string", "subnet_id" : "string", "bill_resource_id" : "string", "process" : 0, "root_resource_id" : "string", "hour_package_info" : { "root_order_id" : "string", "package_resource_id" : "string", "package_instance_id" : "string", "package_spec_code" : "string", "combined_product_type_code" : "string", "use_up_policy" : "string", "package_duration" : 0, "use_duration" : 0 } } }
状态码
状态码 |
描述 |
---|---|
200 |
正常。 |
400 |
由于包含语法错误,当前请求无法被服务器理解。 |
401 |
鉴权失败。 |
403 |
没有操作权限。 |
404 |
找不到资源。 |
500 |
服务内部错误,具体返回错误码请参见错误码说明。 |
错误码
请参见错误码。