云桌面 WORKSPACE-华为云

云桌面 WORKSPACE-重装服务器:响应参数

响应参数状态码： 200 表4 响应Body参数参数参数类型描述 job_id String 任务ID。状态码： 400 表5 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。状态码： 401 表6 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。状态码： 403 表7 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。状态码： 404 表8 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。状态码： 405 表9 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。状态码： 500 表10 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。状态码： 503 表11 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

云桌面 WORKSPACE

云桌面 WORKSPACE-查询用户登录记录:响应示例

响应示例状态码： 200 成功响应。 { "count" : 2, "items" : [ { "id" : "394", "connect_type" : "2", "user_name" : "user001@wksapp***.huawei.com", "pre_conn_time" : "2023-06-05T03:34:43Z", "start_time" : "2023-06-05T06:37:47Z", "machine_sid" : "S-1-5-21-1213649063-4191095369-2401105760-1418", "machine_name" : "APS-XS1QJ3TA7T", "failed_reason" : "", "failed_code" : "", "client_mac" : "c8-d9-d2-**-3a-57", "client_name" : "Y002516E2p1", "client_ip" : "10.*73.108.206", "client_version" : "23.2.2.0", "client_type" : "Windows 10", "agent_version" : "23.2.2.0423", "vm_ip" : "10.*.248.130", "connect_flag" : "0", "wi_ip" : "192.**.10.*00\\#192.**.10.23", "update_time" : "2023-06-05T06:37:47Z", "tenant_id" : "a4da8115c9d8464ead3a38309130523f", "virtual_ip" : "" }, { "id" : "112", "connect_type" : "2", "user_name" : "nas01@wksapp***.huawei.com", "pre_conn_time" : "2023-05-23T09:10:03Z", "start_time" : "2023-05-23T09:10:04Z", "end_time" : "2023-05-23T09:16:15Z", "machine_sid" : "S-1-5-21-1213649063-4191095369-2401105760-1395", "machine_name" : "APS-Z5OV9E157G", "failed_reason" : "", "failed_code" : "", "client_mac" : "68-05-ca-**-c7-98", "client_name" : "kdjhfkjhdghschd", "client_ip" : "10.**.**.151", "client_version" : "23.5.0.0", "client_type" : "Windows 10", "agent_version" : "23.5.0.0519", "vm_ip" : "10.*.83.5", "connect_flag" : "0", "wi_ip" : "192.**.10.*00\\#192.**.10.23", "update_time" : "2023-05-23T09:16:15Z", "tenant_id" : "a4da8115c9d8464ead3a38309130523f", "virtual_ip" : "" } ] }

云桌面 WORKSPACE

云桌面 WORKSPACE-查询用户登录记录:响应参数

响应参数状态码： 200 表5 响应Body参数参数参数类型描述 count Integer 总数。 items Array of UserConnectionInfo objects 应用使用记录列表。表6 UserConnectionInfo 参数参数类型描述 id String 主键。 connect_type String 连接类型。 user_name String 登录用户。 desktop_group_name String 桌面组名。 pre_conn_time String 预连接时间。 start_time String 开始时间。 end_time String 结束时间。 machine_sid String 应用服务器sid。 machine_name String 应用服务器名称。 failed_reason String 连接失败原因。 failed_code String 连接失败状态码。 client_mac String 客户端Mac。 client_name String 客户端名称。 client_ip String 客户端ip。 client_version String 客户端版本。 client_type String 客户端操作系统类型。 agent_version String aps hda版本。 vm_ip String 应用服务器ip。 connect_flag String 连接标志。 wi_ip String 连接IP。 update_time String 更新时间。 tenant_id String 租户id。 virtual_ip String 会话虚拟ip。 public_ip String 客户端出口ip。状态码： 400 表7 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。状态码： 401 表8 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。状态码： 403 表9 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。状态码： 404 表10 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。状态码： 405 表11 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。状态码： 415 表12 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。状态码： 500 表13 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。状态码： 503 表14 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

云桌面 WORKSPACE

云桌面 WORKSPACE-查询用户登录记录:请求参数

请求参数表3 请求Header参数参数是否必选参数类型描述 X-Auth-Token 否 String 用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。表4 请求Body参数参数是否必选参数类型描述 id 否 String 登录记录唯一标识ID。 connect_type 否 String 用户连接类别。 user_name 否 String 登录用户名称。 machine_sid 否 String 应用服务器sid。 machine_name 否 String 应用服务器名称。 failed_reason 否 String 连接失败原因。 failed_code 否 String 连接失败状态码。 client_name 否 String 客户端名称。 client_version 否 String 客户端版本。 client_type 否 String 客户端操作系统类型。 agent_version 否 String aps hda版本。 vm_ip 否 String 应用服务器ip。 connect_flag 否 String 连接标志，目前值为0。 wi_ip 否 String 连接IP。 public_ip 否 String 客户端出口ip。 update_time 否 String 登录应用开始时间，格式 2022-10-31 08:07:39。 tenant_id 否 String 租户id。 login_start_time 否 String 登录应用开始时间，格式 2022-10-31 08:07:39。 login_end_time 否 String 登录应用结束时间，格式 2022-10-31 08:07:39。 virtual_ip 否 String 会话虚拟ip。

云桌面 WORKSPACE

云桌面 WORKSPACE-删除终端与桌面绑定配置:响应参数

响应参数状态码： 200 表4 响应Body参数参数参数类型描述 result_list Array of DeleteTerminalsBindingDesktopsResult objects 需删除的策略ID列表。表5 DeleteTerminalsBindingDesktopsResult 参数参数类型描述 id String 需删除的策略ID。 delete_result_code String 删除操作的结果码。 delete_result_msg String 删除操作的结果信息。状态码： 400 表6 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。状态码： 404 表7 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。状态码： 500 表8 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

云桌面 WORKSPACE

云桌面 WORKSPACE-删除终端与桌面绑定配置:请求参数

请求参数表2 请求Header参数参数是否必选参数类型描述 Content-Type 否 String 发送的实体的MIME类型。 X-Auth-Token 否 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。表3 请求Body参数参数是否必选参数类型描述 id_list 否 Array of strings 绑定策略ID列表。

云桌面 WORKSPACE

云桌面 WORKSPACE-查询最近一次分发软件信息列表:响应参数

响应参数状态码： 200 表3 响应Body参数参数参数类型描述 items Array of AttachServerAppInfo objects 分发软件信息列表。表4 AttachServerAppInfo 参数参数类型描述 id String 分发软件版本ID。 app_id String 分发软件ID。状态码： 400 表5 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。状态码： 401 表6 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。状态码： 403 表7 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。状态码： 404 表8 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。状态码： 405 表9 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。状态码： 500 表10 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。状态码： 503 表11 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

云桌面 WORKSPACE 镜像管理

云桌面 WORKSPACE-查询协同套餐列表:响应示例

响应示例状态码： 200 查询协同套餐列表响应。 { "total_count" : 2, "products" : [ { "product_id" : "workspace.collaborativedesktop.6party.standard", "descriptions" : "协同资源|6方|标准版。", "resource_type" : "hws.resource.type.collaborativedesktop", "cloud_service_type" : "hws.service.type.vdi", "package_type" : "desktop_sharer", "share_space_size" : "6", "charge_mode" : "0", "is_gpu" : true }, { "product_id" : "workspace.collaborativedesktop.collabpartsubusers.1", "descriptions" : "协同参与方订阅|1用户。", "resource_type" : "hws.resource.type.collaborativedesktop", "cloud_service_type" : "hws.service.type.vdi", "package_type" : "user_sharer", "charge_mode" : "6" } ] }

云桌面 WORKSPACE 产品套餐

云桌面 WORKSPACE-查询协同套餐列表:URI

URI GET /v2/{project_id}/products/sharer 表1 路径参数参数是否必选参数类型描述 project_id 是 String 项目id。表2 Query参数参数是否必选参数类型描述 product_id 否 String 产品ID。 share_space_size 否 String 协同方数。该套餐支持的最大协同人数。 charge_mode 否 String 周期套餐标识。0表示包周期，1表示按需, 6表示一次性计费。 is_gpu 否 Integer 是否是GPU套餐。1表示GPU套餐，0表示非GPU套餐，默认null查询所有类型。 package_type 否 String 套餐系列。user_sharer表示用户协同套餐，desktop_sharer表示桌面协同套餐。 limit 否 Integer 每页数量，范围0-100，默认100。 offset 否 Integer 偏移量，默认0。

云桌面 WORKSPACE 产品套餐

云桌面 WORKSPACE-查询用户组中的用户:URI

URI GET /v2/{project_id}/groups/{group_id}/users 表1 路径参数参数是否必选参数类型描述 project_id 是 String 项目id。 group_id 是 String 用户组ID。表2 Query参数参数是否必选参数类型描述 user_name 否 String 用户名支持模糊查询。 description 否 String 用户描述支持模糊查询。 active_type 否 String 激活类型。 USER_ACTIVATE：用户激活 ADMIN_ACTIVATE：管理员激活 limit 否 String 用于分页查询，返回桌面数量限制。如果不指定或为0，默认2000，最大2000。 offset 否 String 用于分页查询，查询的起始记录序号，从0开始。

云桌面 WORKSPACE

云桌面 WORKSPACE-查询用户组中的用户:响应参数

响应参数状态码： 200 表4 响应Body参数参数参数类型描述 users Array of UserInGroup objects 组关联的用户列表。 total_count Integer 用户列表中用户总数。表5 UserInGroup 参数参数类型描述 id String 用户ID。 user_name String 桌面用户名。 user_email String 用户邮箱。 user_phone String 用户手机号。 total_desktops Integer 用户桌面数。 description String 用户描述。

云桌面 WORKSPACE

云桌面 WORKSPACE-查询用户组中的用户:响应示例

响应示例状态码： 200 组关联的用户列表响应。 { "total_count" : 2, "users" : [ { "user_name" : "user1", "user_email" : "xx1@mail.com", "user_phone" : "18818008887", "id" : "8357fd328c62447d94e452bf49xxxx" }, { "user_name" : "user2", "user_email" : "xx2@mail.com", "user_phone" : "18818008888", "id" : "8357fd328c62447d94e452bf495xxxx" } ] }

云桌面 WORKSPACE

云桌面 WORKSPACE-根据用户名查询当前会话:响应示例

响应示例状态码： 200 成功响应。 { "session_info_list" : [ { "id" : "a7db732e1ad511edaf56fa163ed8e03f", "session_stamp" : "S-1-5-21-1908276142-124560728-768171367-1358-zeng**long@wksapp.****huawei.com-HDP-_1", "protocol_type" : "Hdp", "login_user" : "zeng**long@wksapp.****huawei.com", "session_type" : "1", "pre_conn_time" : "2022-08-13 07:00:20", "start_time" : "2022-08-13 07:00:20", "end_time" : "0001-01-01 00:00:00", "machine_sid" : "S-1-5-21-1908276142-**4560728-768171367-1358", "session_state" : "AppcInit", "client_mac" : "3c-7c-3f-**-e4-04", "client_name" : "proven", "client_ip" : "10.**.**.239", "client_version" : "22.4.2.12888", "client_type" : "Windows 10 Enterprise", "agent_version" : "21.12.0.11461", "vm_ip" : "172.**.**.26", "failed_reason" : "success", "failed_code" : "WKS.00000000", "tenant_id" : "26a0420e9e284569a23f1b2f7d9b5011" }, { "id" : "9d123d5e0f36419c9b345efcd031a92e", "session_stamp" : "S-1-5-21-1908276142-124560728-768171367-3006-zeng**long@wksapp.****huawei.com-HDP-2", "os_session_id" : "2", "protocol_type" : "Hdp", "login_user" : "zeng**long@wksapp.****huawei.com", "session_type" : "2", "app_group_id" : "587004825166675968", "app_server_group_id" : "fb8a92be-ebc1-4dac-9a4c-1590518d140a", "pre_conn_time" : "2023-07-07 03:04:06", "start_time" : "2023-07-07 03:04:06", "end_time" : "0001-01-01 00:00:00", "machine_sid" : "S-1-5-21-1908276142-***560728-768171367-3006", "machine_name" : "APS-6NGU98Y4W4", "session_state" : "AppcInit", "app_name" : "HDTransmission,winlogon,HDTerminalExplorer,slui,HDTerminalAssist,fontdrvhost,TSTheme,ChsIME,ctfmon,csrss,HDTerminalSystem,dwm,ChsIME,sihost,HDTerminalDisplay,TabTip32,svchost,svchost,HDTerminalUser,taskhostw,TabTip", "client_mac" : "3c-7c-3f-**-e4-04", "client_name" : "proven", "client_ip" : "10.*.97.212", "client_version" : "23.2.2.0", "client_type" : "Windows 10 Enterprise", "agent_version" : "23.2.0.0314", "vm_ip" : "172.*.*.41", "failed_reason" : "success", "failed_code" : "WKS.00000000", "tenant_id" : "26a0420e9e284569a23f1b2f7d9b5011" } ] }

云桌面 WORKSPACE 使用记录

云桌面 WORKSPACE-根据用户名查询当前会话:响应参数

响应参数状态码： 200 表4 响应Body参数参数参数类型描述 session_info_list Array of AppSession objects 会话信息列表。表5 AppSession 参数参数类型描述 id String 主键ID。 session_stamp String 会话标识。 os_session_id String 会话在hda的os中会话id。 protocol_type String 协议类型。 login_user String 当前会话的登录用户。 session_type String 会话类型，1表示共享桌面，2表示应用。 app_group_id String App组ID。 app_server_group_id String AppServer组ID。 pre_conn_time String 预连接时间。 start_time String 会话开始时间。 end_time String 会话结束时间。 status_continue_time String 状态持续时间。 machine_sid String 服务器SID。。 machine_name String 服务器名称。 session_state String 会话状态。 app_name String 会话中的应用名称。 client_mac String 客户端Mac地址。 client_name String 客户端名称。 client_ip String 客户端IP。 public_ip String 客户端出口ip。 client_version String 客户端版本。 client_type String 客户端类型。 agent_version String agent版本。 vm_ip String 服务器IP。 failed_reason String 错误原因消息。 failed_code String 错误原因码。 last_update_status_time String 状态最后变化时间。 tenant_id String 租户ID。状态码： 400 表6 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。状态码： 401 表7 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。状态码： 403 表8 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。状态码： 404 表9 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。状态码： 405 表10 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。状态码： 415 表11 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。状态码： 500 表12 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。状态码： 503 表13 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

云桌面 WORKSPACE 使用记录

云桌面 WORKSPACE-创建用户组:请求参数

请求参数表2 请求Header参数参数是否必选参数类型描述 X-Auth-Token 否 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 是 String 发送的实体的MIME类型，如：application/json。表3 请求Body参数参数是否必选参数类型描述 group_name 是 String 用户组名称。 platform_type 是 String 用户组类型。 AD： AD域用户组 LOCAL：本地liteAs用户组 description 否 String 用户组描述。

云桌面 WORKSPACE 用户组

云服务器内容精选

云桌面 WORKSPACE

7*24

备案

专业服务

退订

建议反馈

售前咨询热线