更新时间:2024-02-23 GMT+08:00
分享

查询桌面详情列表

功能介绍

查询桌面详情信息列表。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v2/{project_id}/desktops/detail

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

表2 Query参数

参数

是否必选

参数类型

描述

status

String

桌面状态。

  • ACTIVE:运行中。

  • SHUTOFF:关机。

  • ERROR:异常。

user_name

String

桌面所属用户,当传user_names时,本字段不生效。

user_names

Array

桌面所属用户,批量筛选,最多不超过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

桌面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

按照维护模式过滤

subnet_id

String

桌面的子网ID。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

Content-Type

String

发送的实体的MIME类型。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

desktops

Array of DesktopDetailInfo objects

桌面详情列表。

total_count

Integer

桌面总数。

表5 DesktopDetailInfo

参数

参数类型

描述

desktop_id

String

桌面ID。

computer_name

String

桌面名。

addresses

Map<String,Array<AddressInfo>>

桌面IP地址列表。

ip_addresses

Array of strings

IP地址列表。

user_list

Array of strings

用户列表

user_group_list

Array of strings

用户组列表

desktop_type

String

桌面类型。

  • DEDICATED:专属桌面。

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:删除失败。

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。

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:表示两种上网方式都支持。

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表明该任务进度的百分比。

表6 AddressInfo

参数

参数类型

描述

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地址。

表7 FlavorInfo

参数

参数类型

描述

id

String

桌面对应的规格ID。

links

Array of FlavorLinkInfo objects

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

表8 FlavorLinkInfo

参数

参数类型

描述

rel

String

快捷链接标记名称。

hrel

String

对应快捷链接。

表9 SecurityGroup

参数

参数类型

描述

id

String

安全组ID。

表10 AttachInstancesUserInfo

参数

参数类型

描述

user_id

String

用户id

user_name

String

桌面所属的用户,当桌面分配成功后此用户可以登录该桌面。只允许输入大写字母、小写字母、数字、中划线(-)和下划线(_)。域类型为LITE_AD时,使用小写字母或者大写字母开头,长度范围为[1-20]。当域类型为LOCAL_AD时,用户名可以使用小写字母或者大写字母或者数字开头,长度范围为[1-32]。Windows桌面用户最长支持20个字符,Linux桌面用户最长支持32个字符。

user_group

String

桌面用户所属的用户组。

  • sudo:Linux管理员组。

  • default:Linux默认用户组。

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

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

type

String

对象类型,可选值为:

  • USER:用户。

  • GROUP:用户组。

表11 VolumeDetail

参数

参数类型

描述

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

磁盘名

表12 ProductInfo

参数

参数类型

描述

product_id

String

产品ID。

flavor_id

String

产品规格ID。

type

String

产品类型。

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

cpu

String

CPU

memory

String

内存。

descriptions

String

产品描述。

charge_mode

String

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

表13 Tag

参数

参数类型

描述

key

String

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

value

String

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

状态码: 400

表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 401

表15 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 403

表16 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 404

表17 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 500

表18 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

请求示例

/v2/0bec5db98280d2d02fd6c00c2de791ce/desktops/detail

响应示例

状态码: 200

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

{
  "desktops" : [ {
    "desktop_id" : "21616aa6-061d-4b2f-bd83-b230d7a9a14c",
    "computer_name" : "CHENMIN01",
    "addresses" : [ {
      "addr" : "172.16.253.204",
      "version" : "4",
      "OS-EXT-IPS-MAC:mac_addr" : "fa:16:3e:2e:41:55",
      "OS-EXT-IPS:type" : "fixed"
    }, {
      "addr" : "10.0.9.55",
      "version" : "4",
      "OS-EXT-IPS-MAC:mac_addr" : "fa:16:3e:d5:b3:02",
      "OS-EXT-IPS:type" : "fixed"
    } ],
    "ip_addresses" : [ "172.16.253.204", "10.0.9.55" ],
    "desktop_type" : "DEDICATED",
    "metadata" : {
      "image_name" : "copy_uos-hjg1",
      "metering.resourcespeccode" : "rs3.large.2.linux",
      "charging_mode" : "0",
      "metering.image_id" : "39efed30-a0db-4520-8134-19a086e14c7e",
      "metering.resourcetype" : "1",
      "os_type" : "Linux",
      "os_bit" : "64",
      "desktop_os_version" : "20"
    },
    "flavor" : {
      "id" : "rs3.large.2",
      "links" : [ ]
    },
    "status" : "ACTIVE",
    "task_status" : "",
    "created" : "2022-01-21T06:57:47.459Z",
    "login_status" : "REGISTERED",
    "user_name" : "chenmin",
    "product_id" : "workspace.k.large2.uosv20pro",
    "share_resource_sku" : "workspace.collaborativedesktop.6party.standard",
    "root_volume" : {
      "type" : "SAS",
      "size" : 90,
      "device" : "/dev/vda",
      "id" : "e4406c227a8711ecaf56fa163ed8e03f",
      "volume_id" : "91b9457c-ef61-4058-9e82-c86b35f15934",
      "create_time" : "2022-03-28T00:00:00Z",
      "display_name" : "workspace002"
    },
    "data_volumes" : [ {
      "type" : "SATA",
      "size" : 10,
      "device" : "/dev/vdc",
      "id" : "fd4597cb80b311ecaf56fa163ed8e03f",
      "volume_id" : "230432f1-44a4-47a1-862e-cd0b65c04bd1",
      "create_time" : "2022-03-28T00:00:00Z",
      "display_name" : "workspace001"
    } ],
    "user_group" : "default",
    "availability_zone" : "cn-north-5a",
    "site_type" : "IES",
    "site_name" : "边缘小站",
    "product" : {
      "product_id" : "workspace.k.large2.uosv20pro",
      "flavor_id" : "rs3.large.2",
      "type" : "BASE",
      "cpu" : "2",
      "memory" : "3072",
      "descriptions" : "CPU:2vCPUs,Memory:4GB",
      "charge_mode" : "0"
    },
    "os_version" : "20",
    "sid" : "1f60adc1-941c-48b8-b5c8-64948329b7cb",
    "order_id" : "CS2201211457G0PUY",
    "tags" : [ ],
    "in_maintenance_mode" : false
  }, {
    "desktop_id" : "e7a27bad-323f-4ec8-9afe-e53d00171ba9",
    "computer_name" : "HJG01",
    "addresses" : [ {
      "addr" : "172.16.242.253",
      "version" : "4",
      "OS-EXT-IPS-MAC:mac_addr" : "fa:16:3e:20:14:00",
      "OS-EXT-IPS:type" : "fixed"
    }, {
      "addr" : "10.0.5.247",
      "version" : "4",
      "OS-EXT-IPS-MAC:mac_addr" : "fa:16:3e:29:c4:3f",
      "OS-EXT-IPS:type" : "fixed"
    } ],
    "ip_addresses" : [ "172.16.242.253", "10.0.5.247" ],
    "desktop_type" : "DEDICATED",
    "metadata" : {
      "image_name" : "UOS_20_PRO_chenmin",
      "metering.resourcespeccode" : "rs3.xlarge.2.linux",
      "charging_mode" : "0",
      "metering.image_id" : "6fe1cd9e-e997-4c02-8257-395c28de49b3",
      "metering.resourcetype" : "1",
      "os_type" : "Linux",
      "os_bit" : "64",
      "desktop_os_version" : "20"
    },
    "flavor" : {
      "id" : "rs3.xlarge.2",
      "links" : [ ]
    },
    "status" : "ACTIVE",
    "task_status" : "",
    "created" : "2022-01-18T07:53:25.815Z",
    "login_status" : "REGISTERED",
    "user_name" : "hjg",
    "product_id" : "workspace.k.large4.uosv20pro",
    "root_volume" : {
      "type" : "SAS",
      "size" : 80,
      "device" : "/dev/vda",
      "id" : "1791c183783411ecaf56fa163ed8e03f",
      "volume_id" : "703b49d6-794e-4474-a256-fb695fb46466"
    },
    "user_group" : "sudo",
    "availability_zone" : "cn-north-5a",
    "site_type" : "CENTER",
    "site_name" : "北京四中心站",
    "product" : {
      "product_id" : "workspace.k.large4.uosv20pro",
      "flavor_id" : "rs3.xlarge.2",
      "type" : "BASE",
      "cpu" : "4",
      "memory" : "7168",
      "descriptions" : "CPU:4vCPUs,Memory:7GB",
      "charge_mode" : "0"
    },
    "os_version" : "20",
    "sid" : "3f5cdbd5-9652-4339-9aab-70d0644f8abc",
    "order_id" : "CS220118155365RYV",
    "tags" : [ ],
    "in_maintenance_mode" : true
  } ],
  "total_count" : 2
}

状态码

状态码

描述

200

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

400

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

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

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

错误码

请参见错误码

相关文档