华为云用户手册

响应示例 状态码： 200 变更规格响应。 { "job_id" : "c566b960-69d1-44ec-9397-2172fdd01xxx", "jobs" : [ { "desktop_id" : "c566b960-69d1-44ec-9397-2172fdd015d9", "job_id" : "41162624-ba52-42f3-bdda-15c6d345ff60" } ] } 状态码： 202 变更规格响应。 { "job_id" : "c566b960-69d1-44ec-9397-2172fdd01xxx", "jobs" : [ { "desktop_id" : "c566b960-69d1-44ec-9397-2172fdd015d9", "job_id" : "41162624-ba52-42f3-bdda-15c6d345ff60" } ] }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 jobs Array of ResizeDesktopJobResponse objects 按需桌面变更规格返回的任务信息（jobs字段后续会下线，请使用job_id字段）。 job_id String 变更规格任务id。 表6 ResizeDesktopJobResponse 参数 参数类型 描述 desktop_id String 桌面ID。 job_id String 任务ID。 状态码： 202 表7 响应Body参数 参数 参数类型 描述 jobs Array of ResizeDesktopJobResponse objects 按需桌面变更规格返回的任务信息（jobs字段后续会下线，请使用job_id字段）。 job_id String 变更规格任务id。 表8 ResizeDesktopJobResponse 参数 参数类型 描述 desktop_id String 桌面ID。 job_id String 任务ID。 状态码： 400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 401 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 403 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 404 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 409 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 500 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 否 String 发送的实体的MIME类型。 表3 请求Body参数 参数 是否必选 参数类型 描述 desktops 是 Array of ResizeDesktopData objects 桌面数据。支持批量按需类型桌面变更为同一规格。 product_id 是 String 套餐id。批量变更时，则变更为同一规格的虚拟机。 mode 是 String 是否支持开机状态下执行变更规格操作。固定传值STOP_DESKTOP，如果桌面处于开机状态，会先关机再变更规格。 dedicated_host_id 否 String 专属主机ID。 表4 ResizeDesktopData 参数 是否必选 参数类型 描述 desktop_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 错误描述 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 503 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 policy 是 AccessPolicyInfo object 接入策略信息。 policy_objects_list 否 Array of AccessPolicyObjectInfo objects 策略应用对象列表。 表4 AccessPolicyInfo 参数 是否必选 参数类型 描述 policy_name 是 String 策略名，当前只支持专线接入策略名。 PRIVATE_ACCESS： 专线接入 blacklist_type 是 String 黑名单类型，当前黑名单只支持互联网。 INTERNET： 互联网 表5 AccessPolicyObjectInfo 参数 是否必选 参数类型 描述 object_id 是 String 黑名单中的对象id。 object_type 是 String 对象类型。 USER： 用户 USERGROUP： 用户组 object_name 否 String 对象名。后续此参数不会校验。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 否 String 发送的实体的MIME类型。 表3 请求Body参数 参数 是否必选 参数类型 描述 desktop_ids 否 Array of strings 计算机id列表。 image_type 否 String 镜像类型。 image_id 是 String 模板ID。 os_type 否 String os类型。 delay_time 否 Integer 立即重建时给用户预留的保存数据的时间（单位：分钟）。 message 否 String 下发重建系统盘任务时，给用户发送的提示信息。 order_id 否 String 订单ID，包周期桌面重建系统盘，涉及收费镜像时需传 enterprise_project_id 否 String 企业项目ID，默认"0"

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 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 错误描述。 状态码： 409 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

响应示例 状态码： 200 成功响应。 { "count" : 1, "items" : [ { "id" : "575772278315290631", "name" : "应用name2531691942", "version" : "V1.9202534394", "command_param" : "yQhK1urkWx0XR8ILGdSeFvqJYyMHURzP", "execute_path" : "C:\\Program Files (x86)\\Google应用\\appH7wqKcwpfk\\app0256aVegjU\\chrome.exe", "work_path" : "C:\\Users\\zhangssan\\AppData应用\\Local\\Google\\app5P521tF0RMkLrihaO0DR", "icon_path" : "C:\\Users\\zhangSan\\AppData\\Local应用\\Google\\appAXwSgdKA1FyDkbejBs2f.jpg", "icon_index" : 1499, "description" : "应用description256261241750805", "app_group_id" : "575772274859184144", "state" : "NORMAL", "tenant_id" : "a4da8115c9d8464ead3a38309130523f", "publish_at" : "2023-06-06T14:13:58.914Z", "source_type" : 2, "publisher" : "tPPgWwxy5T130lX", "icon_url" : "", "sandbox_enable" : false } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数。 items Array of App objects 查发布的应用列表。 表5 App 参数 参数类型 描述 id String 应用ID。 name String 应用名称。 version String 应用版本号。 command_param String 启动命令行参数。 execute_path String 执行路径。 work_path String 应用工作目录。 icon_path String 应用图标的路径。 icon_index Integer 应用图标的索引。 description String 应用描述。 app_group_id String 应用组标识Id。 state String 应用状态： NORMAL - 正常状态。 FORBIDDEN - 禁用状态。 tenant_id String 所在的租户ID。 publish_at String 发布时间。 source_type Integer 应用类型： '1':系统内置应用 '2':镜像应用 '3':自定义应用 publisher String 应用发布者。 icon_url String 图标url。 publishable Boolean 是否可发布应用： true: 可发布。 false: 不可发布。 sandbox_enable Boolean 是否使用沙箱模式运行，取值为： false: 表示不以沙箱模式运行。 true: 表示以沙箱模式运行。 状态码： 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 错误描述。 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 503 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

URI GET /v1/{project_id}/app-groups/{app_group_id}/apps 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 app_group_id 是 String 应用组ID。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 单次查询的大小[1-100]。 offset 否 Integer 查询的偏移量。 name 否 String 应用名称。 state 否 String 应用状态： NORMAL - 正常状态。 FORBIDDEN - 禁用状态。 app_id 否 String 应用ID。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 op_type 是 String 操作类型，可选值为： LOCK：锁定用户。 UNLOCK：解锁用户。 RESET_PWD：重置用户密码。

响应参数 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 405 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 503 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 computer_name String 桌面名称 computer_id String 桌面ID network_infos Array of NetworkInfo objects 桌面网络信息 表4 NetworkInfo 参数 参数类型 描述 vpc_info Vpc object vpc信息 subnet_info Subnet object 子网信息 port_info Port object 私有IP信息。 public_ip_info PublicIp object 弹性IP信息。 security_groups Array of SecurityGroup objects 桌面绑定的安全组列表 表5 Vpc 参数 参数类型 描述 id String 桌面所在vpcId name String 桌面所在vpc名称 cidr String 桌面所在vpc网段 表6 Subnet 参数 参数类型 描述 id String 桌面所在子网Id name String 桌面所在子网名称 cidr String 桌面所在子网网段 表7 Port 参数 参数类型 描述 id String 私有IP唯一标识 ip_address String 私有IP地址 表8 PublicIp 参数 参数类型 描述 id String 弹性IP唯一标识 public_ip_address String 弹性IP地址 表9 SecurityGroup 参数 参数类型 描述 id String 安全组ID。 状态码： 400 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 401 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 403 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 404 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 409 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 500 表15 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 id String 应用ID。 name String 应用名称。 version String 应用版本号。 command_param String 启动命令行参数。 execute_path String 执行路径。 work_path String 应用工作目录。 icon_path String 应用图标的路径。 icon_index Integer 应用图标的索引。 description String 应用描述。 app_group_id String 应用组标识Id。 state String 应用状态： NORMAL - 正常状态。 FORBIDDEN - 禁用状态。 tenant_id String 所在的租户ID。 publish_at String 发布时间。 source_type Integer 应用类型： '1':系统内置应用 '2':镜像应用 '3':自定义应用 publisher String 应用发布者。 icon_url String 图标url。 publishable Boolean 是否可发布应用： true: 可发布。 false: 不可发布。 sandbox_enable Boolean 是否使用沙箱模式运行，取值为： false: 表示不以沙箱模式运行。 true: 表示以沙箱模式运行。 状态码： 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 错误描述。 状态码： 415 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 503 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 policy_objects_list Array of AccessPolicyObject objects 查询接入策略应用对象响应。 total Integer 对象总数。 表5 AccessPolicyObject 参数 参数类型 描述 object_id String 黑名单中的对象id。 object_name String 对象名。 object_type String 对象类型。 USER： 用户 USERGROUP： 用户组 状态码： 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 错误描述 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 503 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 200 应用对象列表。 { "policy_objects_list" : [ { "object_id" : "8ac225c2781edb0d01781edde3f4xxxx", "object_name" : "test1", "object_type" : "USER" }, { "object_id" : "8ac225c2781edb0d01781edde3f4xxxx", "object_name" : "test2", "object_type" : "USER" } ], "total" : 2 }

URI GET /v2/{project_id}/access-policy/{access_policy_id}/objects 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id。 access_policy_id 是 String 接入策略id。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 每页数量,范围0-2000,默认10。 offset 否 Integer 偏移量,范围0-1999,默认0。

请求示例 PATCH /v1/a4da8115c9d8464ead3a38309130523f/app-groups/656582710889807872/apps/656599335839993860 { "version" : "19.0.0.1", "description" : "修改应用", "sandbox_enable" : false, "name" : "7-Zip File Manager", "work_path" : "C:\\Program Files\\7-Zip", "execute_path" : "C:\\Program Files\\7-Zip\\7zFM.exe", "command_param" : "" }

响应示例 状态码： 200 成功响应。 { "id" : "656599335839993860", "name" : "7-Zip File Manager", "version" : "19.0.0.1", "command_param" : "", "execute_path" : "C:\\Program Files\\7-Zip\\7zFM.exe", "work_path" : "C:\\Program Files\\7-Zip", "icon_path" : "C:\\Program Files\\7-Zip\\7zFM.exe", "icon_index" : 0, "description" : "", "app_group_id" : "656582710889807872", "state" : "NORMAL", "tenant_id" : "26a0420e9e284569a23f1b2f7d9b5011", "publish_at" : "2024-01-15T08:39:56.265Z", "source_type" : 2, "publisher" : "Igor Pavlov", "sandbox_enable" : false }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 id String 应用ID。 name String 应用名称。 version String 应用版本号。 command_param String 启动命令行参数。 execute_path String 执行路径。 work_path String 应用工作目录。 icon_path String 应用图标的路径。 icon_index Integer 应用图标的索引。 description String 应用描述。 app_group_id String 应用组标识Id。 state String 应用状态： NORMAL - 正常状态。 FORBIDDEN - 禁用状态。 tenant_id String 所在的租户ID。 publish_at String 发布时间。 source_type Integer 应用类型： '1':系统内置应用 '2':镜像应用 '3':自定义应用 publisher String 应用发布者。 icon_url String 图标url。 publishable Boolean 是否可发布应用： true: 可发布。 false: 不可发布。 sandbox_enable Boolean 是否使用沙箱模式运行，取值为： false: 表示不以沙箱模式运行。 true: 表示以沙箱模式运行。 状态码： 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 错误描述。 状态码： 409 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 503 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 否 String 应用名称,名称需满足如下规则: 名称允许可见字符或空格，不可为全空格。 长度1~64个字符。 version 否 String 应用版本号。 execute_path 否 String 执行路径。 work_path 否 String 应用工作目录。 description 否 String 应用描述。 command_param 否 String 启动命令行参数。 state 否 String 应用状态(正常、禁用)，只能修改正常的为禁用或者修改禁用状态的为正常。 sandbox_enable 否 Boolean 是否使用沙箱模式运行，取值为： false: 表示不以沙箱模式运行 true: 表示以沙箱模式运行

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 count Integer 总数。 group_images Array of strings 组下面的镜像ID列表。 items Array of PublishableApp objects 查询到的应用列表。 表4 PublishableApp 参数 参数类型 描述 id String 应用ID。 name String 应用名称。 version String 应用版本号。 command_param String 启动命令行参数。 execute_path String 执行路径。 work_path String 应用工作目录。 icon_path String 应用图标的路径。 icon_index Integer 应用图标的索引。 description String 应用描述。 app_group_id String 应用组标识Id。 state String 应用状态： NORMAL - 正常状态。 FORBIDDEN - 禁用状态。 tenant_id String 所在的租户ID。 publish_at String 发布时间。 source_type Integer 应用类型： '1':系统内置应用 '2':镜像应用 '3':自定义应用 publisher String 应用发布者。 icon_url String 图标url。 publishable Boolean 是否可发布应用： true: 可发布。 false: 不可发布。 sandbox_enable Boolean 是否使用沙箱模式运行，取值为： false: 表示不以沙箱模式运行。 true: 表示以沙箱模式运行。 source_image_ids Array of strings 镜像ids。 状态码： 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 错误描述。

响应示例 状态码： 200 成功响应。 { "count" : 1, "group_images" : [ "ad38efc4-113d-4ddc-bdbe-679fa50f0a58" ], "items" : [ { "name" : "Internet Explorer (x86)", "version" : "11.0.14393.0", "command_param" : "", "execute_path" : "C:\\Program Files (x86)\\Internet Explorer\\iexplore.exe", "work_path" : "", "icon_path" : "C:\\Program Files (x86)\\Internet Explorer\\iexplore.exe", "icon_index" : 0, "description" : "", "publisher" : "Microsoft Corporation", "publishable" : true, "source_image_ids" : [ "ad38efc4-113d-4ddc-bdbe-679fa50f0a58" ] } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 password String 密码。 状态码： 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 错误描述

URI GET /v2/{project_id}/users/{user_id}/random-password 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 user_id 是 String 用户ID。 表2 Query参数 参数 是否必选 参数类型 描述 notification_type 否 String 通知用户类型，现在有“email”和“phone”两种，用","分开，用户为用户激活模式时必须要带上通知类型，以便接收到密码通知。

修订记录 发布日期 修订记录 2024-01-11 第二十二次正式发布。 新增： 桌面名称策略。 2023-12-18 第二十一次正式发布。 修改： 批量注销桌面接口中的请求示例。 2023-11-29 第二十次正式发布。 修改： 设置终端与桌面绑定的开关配置接口中tc_bind_switch参数的描述。 2023-11-16 第十九次发布。 新增： 批量添加多个桌面标签。 批量删除多个桌面标签。 2023-11-10 第十八次正式发布。 新增： 查询桌面网络。 2023-11-06 第十七次正式发布。 新增： 重建桌面。 2023-10-09 第十六次正式发布。 新增： 可用分区。 2023-09-15 第十五次正式发布。 新增： 切换桌面网络。 2023-07-04 第十四次正式发布。 新增： 批量注销桌面、查询在指定时间段未使用的桌面、查询使用桌面的时长、查询用户列表、创建用户组、批量删除用户组、删除用户组、修改用户组信息、操作用户组、查询用户组中的用户接口。 2023-06-20 第十三次正式发布。 新增： 云应用APIAPI参考指导。 云应用错误码。 2023-06-06 第十二次正式发布。 修改： 创建桌面章节中email_notification参数的描述。 2022-12-23 第十一次正式发布。 修改： 镜像下各接口新增请求及响应示例。 2022-12-20 第十次正式发布。 新增： 策略组。 2022-12-08 第九次正式发布。 修改： 云办公服务中新增查询云办公服务是否被锁定、解除云办公服务锁定状态接口。 桌面统计中新增查询OTP设备、解绑OTP设备接口。 桌面名称策略中新增删除桌面数据盘接口。 新增： 用户组。 连接信息。 镜像。 2022-11-29 第八次正式发布。 修改： 终端节点中新增“西南-贵阳一”和“拉美-圣地亚哥”的终端节点信息。 2022-11-17 第七次正式发布。 删除： 删除“历史API”节点。 2022-11-14 第六次正式发布。 修改： 根据产品规划调整增加桌面磁盘中新增磁盘参数名称，由“addDesktopVolumesReq”变更为“desktop_volumes”。 根据产品规划调整扩容桌面磁盘中扩容磁盘参数名称，由“expandVolumesReq”变更为“desktop_volumes_expansion”。 优化创建用户和查询用户详情信息中时间格式。 新增： 新增“历史API”节点。将原参数名称的“增加桌面磁盘”、“扩容桌面磁盘”API接口归档至历史API节点下。 新增操作用户接口。 2022-10-27 第五次正式发布。 修改： 优化云桌面错误码。 2022-09-29 第四次正式发布。 修改： 优化查询产品套餐列表和查询可用分区列表参数描述。 优化云桌面错误码。 2022-09-15 第三次正式发布。 修改： 优化桌面统计中的示例。 2022-09-02 第二次正式发布。 新增： 变更规格。 2022-08-27 第一次正式发布。

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。

响应示例 状态码： 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 }

响应参数 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 405 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 503 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 200 成功响应。 { "count" : 1, "authorizations" : [ { "account" : "user000", "app_id" : "", "app_name" : "", "app_group_id" : "575772274859184146", "app_group_name" : "开放性API创建应用组测试", "authorization_type" : "APP_GROUP", "account_type" : "USER", "domain" : "wksapp***.huawei.com", "create_at" : "2023-06-06T14:14:05.576Z" } ] }