华为云用户手册

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 otp_devices Array of OtpDevice objects otp设备。 表4 OtpDevice 参数 参数类型 描述 id String 用户otp 信息id。 user_id String 用户id。 user_name String 用户名。 status String 用户otp设备状态 UNREGISTER: 未绑定 REGISTERED：已绑定 create_time String 用户otp设备绑定时间。 状态码：400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：405 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：503 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 site_id String 站点ID。 nat_on Boolean 是否开启nat映射。 vag_ips Array of strings vag Ip列表。 nat_vag_maps Array of NatMappingConfig objects NAT映射配置表。 表5 NatMappingConfig 参数 参数类型 描述 nat_map_type String NAT映射类型。 PORT:端口映射. HOST:地址映射. nat_map_value String nat_map_type为PORT时表示端口,取值9443/9445. nat_map_type为HOST时表示接入地址. nat_ip String nat Ip。 nat_port String nat端口。 vag_ip String vag Ip。 vag_port String vag端口。 access_filter_type Integer 0表示不开启，1表示开启。 enterprise_project_id String 企业项目ID。 tags Array of Tag objects 标签对象。 表6 Tag 参数 参数类型 描述 key String 标签的键，不能为空，最大长度128个unicode字符。标签的键可以包含任意语种字母、数字、空格和_.:=+-@，但首尾不能含有空格，不能以_sys_开头。 value String 标签的值，最大长度43个unicode字符。标签的值可以包含任意语种字母、数字、空格和_.:=+-@，但首尾不能含有空格。 状态码：400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：404 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应示例 状态码：200 正常。 { "tasks_records_details" : [ { "id" : "2b31e-d520xxxx-xxebedb6-e57xxxxxx", "record_id" : "2b31e-d520xxxx-xxebedb6-e57xxxxxx", "desktop_id" : "2b31e-d520xxxx-xxebedb6-e57xxxxxx", "desktop_name" : "desktop1", "exec_status" : "SUC CES S", "exec_script_id" : "string", "result_code" : "WKS.000x", "fail_reason" : "任务冲突", "start_time" : "2022-12-31 09:00:00", "end_time" : "2022-12-31 09:00:00", "time_zone" : "Asia/Shanghai" } ], "total_count" : 10 }

URI GET /v2/{project_id}/scheduled-tasks/{task_id}/records/{record_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 task_id 是 String 任务ID。 record_id 是 String 任务执行记录ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 是 Integer 用于分页查询，查询的起始记录序号，从0开始。 limit 是 Integer 用于分页查询，每页返回的个数，取值范围0~100。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 tasks_records_details Array of ScheduledTasksRecordsDetails objects 定时任务执行记录详情列表。 total_count Integer 总个数。 表5 ScheduledTasksRecordsDetails 参数 参数类型 描述 id String 任务执行记录详情id。 record_id String 任务执行记录id。 desktop_id String 桌面id。 desktop_name String 桌面名称。 exec_status String 执行状态。 exec_script_id String 执行脚本id。 result_code String 失败或者跳过原因的错误码。 fail_reason String 失败或者跳过原因。 start_time String 执行开始时间，格式为yyyy-MM-dd HH:mm:ss。 end_time String 执行结束时间，格式为yyyy-MM-dd HH:mm:ss。 time_zone String 时区。 状态码：400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应示例 状态码：200 查询会话列表响应成功。 { "session_types" : [ { "resource_spec_code" : "workspace.appstreamsession.premium", "session_type" : "GPU", "resource_type" : "hws.resource.type.workspace.appstreamsession", "cloud_service_type" : "hws.service.type.vdi" }, { "resource_spec_code" : "workspace.appstreamsession.standard", "session_type" : "CPU", "resource_type" : "hws.resource.type.workspace.appstreamsession", "cloud_service_type" : "hws.service.type.vdi" } ] }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 session_types Array of SessionTypeEntity objects 会话列表。 表4 SessionTypeEntity 参数 参数类型 描述 resource_spec_code String 资源规格编码。 session_type String 会话类型。 resource_type String 资源类型字段。 cloud_service_type 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 错误描述。 状态码：500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 is_lock Integer 云办公服务是否被锁定，0代表未锁定，1代表锁定。 lock_time String 云办公服务锁定时间，格式：yyyy-MM-dd HH:mm:ss，时区：UTC。 lock_reason String 云办公服务锁定原因。 状态码：400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：403 表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接口进行解密。

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 job_id String 任务id。 状态码：400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：503 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求示例 PUT /v2/fb2e5ec048384c8f9469d22db0037908/sites/fd5225ef-89f5-4921-9ab0-08fdbdd696fe/access-mode { "access_mode" : "string", "dedicated_cidrs" : "192.168.0.0/24;10.0.0.0/16", "apply_shared_vpc_dedicated_param" : { "address" : "string", "port" : 65535, "availability_zone" : [ "string" ] } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 是 String 发送的实体的MIME类型。 表3 请求Body参数 参数 是否必选 参数类型 描述 access_mode 否 String 接入模式。 INTERNET：互联网接入。 DEDICATED：专线接入。 BOTH：代表两种接入方式都支持。 dedicated_cidrs 否 String 专线接入网段列表，多个网段信息用分号隔开，列表长度不超过5。 apply_shared_vpc_dedicated_param 否 ApplySharedVpcDedicatedParam object 共享Vpc专线入参。 表4 ApplySharedVpcDedicatedParam 参数 是否必选 参数类型 描述 address 否 String 租户指定的共享Vpc专线地址。 port 否 Integer 租户指定共享Vpc专线地址端口。 availability_zone 否 Array of strings 开通服务资源使用的可用分区，默认随机使用2个可用区。

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

API概览 表1 云桌面 接口说明 类型 说明 云办公服务 查询、开通、注销云办公服务等接口。 租户配置 修改、获取云办公服务接入地址备份配置及查询、修改、更新租户配置等功能。 桌面 查询、创建、修改、删除桌面等接口。 桌面池 查询、创建、修改、删除桌面池等接口。 桌面名称策略 查询获取、创建、更新、删除桌面名称策略接口。 桌面标签 查询、创建、删除、添加桌面标签等接口。 协同桌面 桌面购买、删除附属资源等接口。 用户 查询、创建、删除用户等接口。 用户组 查询、创建、删除用户组等接口。 组织单元 查询OU、导入OU下用户信息接口。 磁盘 增加、扩容、删除磁盘接口。 快照 查询快照列表、批量创建、批量删除、批量恢复快照等接口。 连接信息 查询登录信息、登录人数、导出连接记录等接口。 策略组 查询、创建、更新、删除接入策略等接口。 终端与桌面绑定 查询、增加、修改、设置终端与桌面绑定开关及配置等接口。 订单 创建桌面订单、包周期桌面/桌面池批量变更下单等接口。 询价 查询包周期桌面/桌面池切换镜像询价、磁盘询价、变更规格询价等接口。 产品套餐 查询产品套餐列表接口。 定时任务 查询创建、修改、删除定时任务等接口。 报表统计 查询新增、更新、删除通知规则及查询用户和桌面统计数据等接口。 告警 查询告警列表、告警统计等接口。 用户操作日志 查询用户事件接口。 脚本 查询、新增、更新、删除脚本及查询脚本任务列表、脚本执行记录详情等接口。 配额 查询租户配额接口。 镜像 查询产品镜像列表接口。 可用分区 查询可用分区列表接口。 任务 查询任务及子任务接口。 网络 查询开通上网功能、已绑定桌面和未绑定的EIP、开通桌面上网功能、端口列表及创建、修改云办公带宽等接口。 委托 查询开通、查询委托功能等接口。 应用中心 查询、添加、修改、删除应用及设置应用权限等接口。 应用管控 创建、查询、修改、删除应用规则及增加、启用、禁用管控规则等接口。 表2 云应用接口说明 类型 说明 产品套餐管理 查询云应用套餐及会话套餐列表接口。 可用区管理 查询可用分区列表接口。 磁盘管理 查询磁盘接口。 服务器组管理 查询、创建、删除、修改服务器组列表等接口。 服务器管理 查询、创建、删除、修改、启动、重启服务器等接口。 应用组管理 查询、创建、删除、修改应用组等接口。 应用管理 查询发布应用、修改应用信息等接口。 应用授权管理 查询应用组授权、移除授权等接口。 使用记录 查询应用使用记录、用户会话注销等接口。 策略管理 查询、创建、删除、修改策略等接口。 存储管理 查询、创建、删除WKS存储等接口。 任务管理 查询任务的执行状态接口。 配额管理 查询配额校验接口。 服务器组标签管理 查询、创建、修改、删除应用仓库中的应用等接口。 应用仓库管理 查询、创建、修改、构建、删除镜像实例等接口。 镜像管理 查询镜像实例列表、创建镜像实例、修改镜像实例等接口。 订单 创建订单接口。 定时任务 查询新增、修改、删除定时任务等接口。 租户配置 查询企业系统配置、租户信息等接口。 CloudStorage 创建、修改、删除、查询个人文件夹及查询项目配置信息等接口。

响应参数 状态码：400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：401 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应参数 状态码：400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应参数 状态码：200 表9 响应Body参数 参数 参数类型 描述 job_id String 创建云桌面总任务id。 状态码：400 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：401 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：403 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：404 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：500 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 sysprep_version String sysprep版本。 support_create_image Boolean 是否支持创建镜像。 状态码：400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 job_id String 任务id。 状态码：default 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 type String 登录类型: novnc vnc url String 远程登录控制台地址。 protocol String 登录协议。 状态码：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 错误描述。

请求示例 POST /v2/fb2e5ec048384c8f9469d22db0037908/workspaces { "ad_domains" : { "domain_type" : "LITE_AS" }, "vpc_id" : "e8f985fa-5161-4cb8-bf5a-155058ea58c9", "subnet_ids" : [ { "subnet_id" : "067b30a9-1b73-4804-a808-699c5f6c4e09" } ], "access_mode" : "INTERNET", "is_send_email" : true } { "ad_domains" : { "domain_type" : "LOCAL_AD", "domain_admin_account" : "vdsadmin", "active_domain_ip" : "192.161.43.66", "standby_domain_ip" : "192.161.43.67", "domain_name" : "xxxx.xxxx.com", "domain_password" : "xxxxxxxxxx@", "active_domain_name" : "AD-xxx-0001.vdesktop.huawei.com", "active_dns_ip" : "192.161.43.66", "standby_domain_name" : "AD-xxx-0002.vdesktop.huawei.com", "standby_dns_ip" : "192.161.43.67" }, "vpc_id" : "27823fc4-5808-4f3b-a5bc-24c7a80742b8", "subnet_ids" : [ { "subnet_id" : "598d4599-059f-40ca-9cce-841b784d13e6" } ], "access_mode" : "INTERNET", "is_send_email" : true } { "ad_domains" : { "domain_type" : "LOCAL_AD", "domain_admin_account" : "vdsadmin", "active_domain_ip" : "192.161.43.66", "standby_domain_ip" : "192.161.43.67", "domain_name" : "xxxx.xxxx.com", "domain_password" : "xxxxxxxxxx@", "active_domain_name" : "AD-xxx-0001.vdesktop.huawei.com", "active_dns_ip" : "192.161.43.66", "standby_domain_name" : "AD-xxx-0002.vdesktop.huawei.com", "standby_dns_ip" : "192.161.43.67" }, "vpc_id" : "27823fc4-5808-4f3b-a5bc-24c7a80742b8", "subnet_ids" : [ { "subnet_id" : "598d4599-059f-40ca-9cce-841b784d13e6" } ], "access_mode" : "DEDICATED", "is_send_email" : true, "dedicated_subnets" : "192.168.0.0/24;10.0.0.0/16" }

响应参数 状态码：200 表8 响应Body参数 参数 参数类型 描述 job_id String 开通云办公服务的任务ID。 状态码：400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：401 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：403 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：404 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：500 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 是 String 发送的实体的MIME类型。 表3 请求Body参数 参数 是否必选 参数类型 描述 ad_domains 是 AdDomain object 域信息。 enterprise_id 否 String 企业ID。 企业ID是您在云桌面服务的唯一标识，终端用户登录时需要填写企业ID，若不自定义设置企业ID，系统将自动生成您的企业ID。格式为由半角数字、字母、_-组成，长度范围小于等于32个字符。 vpc_id 否 String VPC ID。 subnet_ids 否 Array of Subnet objects 指定业务子网的网络ID，子网不能与172.16.0.0/12冲突。 manage_subnet_cidr 否 String 管理子网网段。 注：不能与172.16.0.0/12以及subnet_ids参数下子网的网段冲突。 access_mode 否 String 接入方式。 INTERNET：表示Internet接入。 DEDICATED：表示专线接入。 BOTH：表示两种接入方式都支持。 apply_shared_vpc_dedicated_param 否 ApplySharedVpcDedicatedParam object 共享Vpc专线入参。 dedicated_subnets 否 String 专线接入网段列表，多个网段信息用分号隔开，列表长度不超过5。 is_send_email 否 Boolean 桌面退订是否发送邮件通知。 表4 AdDomain 参数 是否必选 参数类型 描述 domain_type 是 String 域类型。 LITE_AS：本地认证。 LOCAL_AD：本地AD。 说明：域类型为“LOCAL_AD”时，请确保所选VPC网络与AD所属网络可连通。 domain_name 否 String 域名 称。域类型为LOCAL_AD时需要配置。 域名必须为AD服务器上已经存在的域名，且长度不超过55。 domain_admin_account 否 String 域管理员帐号。域类型为LOCAL_AD时需要配置。 必须为AD服务器上已经存在的域管理员帐号。 domain_password 否 String 域管理员账号密码。域类型为LOCAL_AD时需要配置。 active_domain_ip 否 String 主域控制器IP地址。域类型为LOCAL_AD时需要配置。 active_domain_name 否 String 主域控制器名称。域类型为LOCAL_AD时需要配置。 standby_domain_ip 否 String 备域控制器IP地址。域类型为LOCAL_AD时且配置备节点时需要配置。 standby_domain_name 否 String 备域控制器名称。域类型为LOCAL_AD时且配置备节点时需要配置。 active_dns_ip 否 String 主DNS IP地址。域类型为LOCAL_AD时需要配置。 standby_dns_ip 否 String 备DNS IP地址。域类型为LOCAL_AD时且配置备节点时需要配置。 delete_computer_object 否 Integer 是否在删除桌面的同时删除AD上对应的计算机对象，0代表不删除，1代表删除。 use_ldaps 否 Boolean 是否开启LDAPS。 tls_config 否 TlsConfig object TLS信息。 表5 TlsConfig 参数 是否必选 参数类型 描述 cert_pem 否 String pem内容, 有则更新，无则上传。查询不返回。 cert_start_time 否 String 证书生效开始时间，时间参考样例 2022-01-25T09:24:27。 cert_end_time 否 String 证书生效截止时间，时间参考样例 2022-01-25T09:24:27。 表6 Subnet 参数 是否必选 参数类型 描述 subnet_id 是 String 子网的网络ID。 表7 ApplySharedVpcDedicatedParam 参数 是否必选 参数类型 描述 address 否 String 租户指定的共享Vpc专线地址。 port 否 Integer 租户指定共享Vpc专线地址端口。 availability_zone 否 Array of strings 开通服务资源使用的可用分区，默认随机使用2个可用区。

响应示例 状态码：200 成功响应。 { "count" : 2, "items" : [ { "id" : "682367396442275840", "app_id" : "682367396387749888", "tenant_id" : "a4da8115c9d8464ead3a38309130523f", "app_name" : "WeChat", "app_category" : "PRODUCTIVITY_AND_COLLABORATION", "os_type" : "Windows", "version_id" : "111", "version_name" : "000", "appfile_store_path" : "file/WeChatSetup_3.9.0.28.exe", "app_file_size" : "169179", "app_description" : "", "appicon_store_path" : "", "create_time" : "2024-03-26T06:16:57.321Z", "modify_time" : "2024-03-26T06:16:57.321Z", "verify_status" : "VERIFYING", "app_icon" : "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAF4AAABdCAIAAACjJEaXAAAA*******BVHhe7Vt7jFzXWb/Peb929mXv2rt27PhtJ47rmKQhRG0d2tKkJAqgQEEFJFClAir8V6FWQhVB9E+Q4A/+KSBoVQRqqVQFopImEhQanKR2ahs7dtZee70Pr3d2Z+dxn/zO+e6cPffemd1ZZ7zeKPubq7O/77u/e+ec73zncWdmVd/3lS20w0poQFzXdRzH87yteKmAiAKCYhgG8S0AWvCXhyZgW+BYCQ3GUcC2wLESmq35JYKV0Gwhgq3QdMRWaDpiZfFeXl7OZrPEewhHcWt+o+43bd/2VXSFaipGSk1m1JSh6IFoU6LHobEV57ZXueXPTbozc/4CeNWvu77r+Vj/X CS pirdUVE3VTFXLq7l+tTis9Y9og9u0/rJW0DZTFvcmNA3fuu5OX/CuXnInZv1Kw2vaKrbVju07vmgs9gbg9G6IkIc4abqqI4lw5NRUv9a3Xx87ZDywXR1IILfuN95vaKp+7Yxz4Q3npwhNXbEcxELBc0ZrEqNwECKhkWIEv+qj0BGphGqMacOPGkce0Q/mtDQX3R/cfWiW/frr1luvWW/cVhYdz+7hfhEBNFRzQOt7KnHipHG4pOWCExuLuwkNZtb/tS98t/naTXfORZpg8mC97qv8BUGchJxriYmAmsggffsnk489bO5LKhs9xNYdmhvu3D80Xj5rXfL4kAgas1ZrQ861xDJBmdTMU4mjzyafwITN7I3COkLjKd7Lzf/+dv3VutcIXBuIYb3865lPHjP2IJUC1z1GV6FBJ8+5lW/WX/mR9Y6jOm27V7zifpC4M2KuQsQrrSU/k/zo6dTJvJphg/geY+3QYKtyyZn8++WX33UmMdeKmuJUi7JaBhRhZAOGU6mRguMFHtAO4oCsnGQGDUNsfB5LHvmV9Me26eV7vQlaIzRN3zpjX/rH5VduuLdZ9mwOHDDHfy1zer+xU1fvYXRWCw3i8j/WhX+q/XDCmfFVtjq3OpF3ZIfuDYxwRqxLHDlJBuMtFzR7jZHPZZ9+OLGX3/ueoGNoXMX7cePCt+qvXrWnsBixakGNFwfV9d6RuJ+w4vf9vYnR38l95qA5Rqd6jvahgeuSPfl31X9/237X9Vm+oE4oW53IXsxs1wYish6E8a7FRCJKAjMl2ZHErt8rPL/DGKCzvUX7sXrbrbzSePOsNWGxrxcUl23+VX4QCZmu73OisCdIxlUQWSDzlpiZcbGLfqBbtVGKaqzof9Kc+NbyD/EEF9S7p2iTNZbv/Ef97W9U/23OWVRVlQ0mAAQAJ49kOg17cXJh6cYiiJE2CztKxZ1FzdBDypaYlUCYOE3nzpX56lQFzxt6Qi+MlUrjZc3g3SaUBDJRApzktNTvFj79dPoj/HQv0SY0mHT/qvK9M9ZlnArSVwwKYbdS2m7a8xdm71yates2ywFdNVJGec/gwNFhzdSFUr4WvEXZKWfZufnGRHVqyWu4zKfiDmZpb3no2Iiu60JJL3Ef6YbK4eT4l0svDuklOHuI6IDCLuad5sRbzatoqKP4yGEkMy/pCHs8rzqzdPv/Zuxlm0KME3bNnjs/vTS95Hqwoteye2KOb5kYFLM/vbU4WXGbTnAH37eXLSRR5fqCSxWQ9HHiKMpVe+a1xjmasHqIaGjm3eoP6m83PAspQAf7KjPMhcex3NpU1anxuLDtID8w41juwuV5j6VRoMQhOJu+WqZdd5auL/gW5hv+9ig5cZft6vUK+xo1rG9LFp36f9bOz7gVfoueIRQaBP49e/onjfeomVRParXMhcd1vGatyboLowR3QkkEe6KlhoNOjV3LiGTics/x2CVUkRbBPa2G5TpsdYy8aZwgPtft2beaV/gtegaqUQBHcX/UuFjzLCwUqBVKfqCJER54UC1F5zNiDKrB9ojtrhWElT6bjoJLImBfOqsrytjlITLjLWEeqPvN4OJeIBSapmf/V/0i7xBMz8Ehm8SFRzG0VF9Ow249yAR+gChKZriIm8evZQQp0TLNbMrMJtjehV8VpAGu1PVEX8ZjX8lH37QtsT33qjMzaeNppmcIheaaM3fTnmdDmO1RgkM2iQsPUiYxnEkMpOUBhdqahWRmd8nXIYxeK0hgql7h4JCWbj0qouREL5iZXSVZGbk8Tm5at6/Zs/wuvUEoNO9Y1xq+Q3sqH7VmbytvsQQXHsUopkvHRlJDOYRJ1TXFUMEHHt+lZRJhpcxDN0mPFMsndhr5hGog/zTcJ1nO9J/caRTSYWXk8iiZdpZuuvM9XKeQkMG9sK/5s9p3vl89Q+a6gHjalbpbc/SsaRZTLEbrhO961tyy23T1tJnsz/BvZdaNF4tPfKH0qYyWDOz3h1Ab3rWmXaQLpk/Mf2wD4gcmJ+JUIJCUvqHpA5nkzqJeTns0AcuCsJgIK8X9URqqOZxPjheNoYynqXFlWO/pqpZTU2U9N6yXRrXyDqN/VO/XPX3ZxcaRDbGgSe8Doax5ZvbP570qONIy/hyIkh4FqZTN+CWyAETwbsRtlZqi8lhkB9V8Sc/2q/myls2r6ayaTCrYd2tQFrXceHIAWWPiKQODU9OwzKFk96Rni/UgFJonp7+KPSmZmwdpNTGml/fqw7uNoTF9YJtWGtaLcAanOwPPGRQaAJzM4FwXCIXm0ak/Zq5W7xFks/XYwl7yKSIRU+hBQs61xILk1dQhc/Sk+cABc3RM7y9pWVPVsDdGCwHsktFm1B8gwq5t/QSPBGTy4DAYHCAQrIlQaE7d+gpuR+b9hakah4ztTyePHUvsHNH6KEfQTpSocFtCDYmQiJICZJpmNwEKheYTMy/NO1XqNHQmnKx7W30IBKdanoAKJRwd+l/wbsRFNfPZ9COnk4cxfNJaQtQw0s4IIRmRVZQoaWSlUikECGYnhELz4uxfXmhOkXm/sNPo+2L29PHEeEFNUxzvBRAaZA2igwyiqMURSqpdyWEPscJmnZeCoAwO4sLTIlFlnEi8kxiex1MPfr344keT+/p09vxBDUBJtScTBGWckEwmqyhBMHXU6/VmsymSIwKmFjiYHMWWgA5X8XAIkw5AlDLxsO8QXPILEuLtxKjes6mHvpx7drcxaCrsEQP1YW4Oqh5AXDhlwk7HPLIpiCgRHYSmVqu1nWHRWUwEYEC9qU5+/vpfuxs+E2PgPJM++of5T2FJClwbCCRRIpHIZDKUTQKhrDmQ3D5g5FmvsucSdC97/CMzONDDohQETzCkEZdEBDJvJ/5Y+sCXCiwukbQHBAH4yejoEERoBOlSCSB3Go3oF/lMLZDT0h9J7UEWeYrK9+bY8rM1g4jgwiOdau+XBJ3EygFj+Pdzpws8X1jSh9Oe0JbH9XGPbAoiTEB4EB3LCn0zEQqNqeofzx1iS6uLLkZs+IdFvKQDVJQrhH1GyU2URCKCzuKEZ/5B/ultaoGfhpMhQuRydULoRklENl3XxaSDMohFJDS6oj2UHj+S3umxj5aQ9lg7aJ0KDuLCEyGd/G2dKJHJv5F77LA5wh55Oqc9THTp1NTU1atXZ2dnbdsWfqbuMExA0OaFhQVcNTExgWZD1klJfgQIaxZKUoam4Ww2W/Osv51//U+nv2sjbZBswT6Mf/rL1Csv2YwoA9oSsCtjYo199zjyteJzDxgD7HNCntioaJzMzMycPXt2enoaXYrd2rZt206ePJnP5+N6ApmI5rlz5y5fvoxhAg9m2aNHj+7duxd3EJr4HRBN3BmzMkxWJxkZLfFk7sDx9DjLNVzBPiViJR0RjzDb+mUiOEoiCcV4JvXQNq2AYDJHDJTn6LCLFy8iZRyHfRuD6ExOTiJSyB2uWgEbGFRlzq9cuUJxoXYhHc6cOYMo01mSATIHoER+EYmGBtidGHyh79SgWeT7MaYiEvBWuUJo/yYpo4J24v3m8PHkeFZnHzuhi6jTIgRYWlpaXFxEXcFpCODsjRs3EJq2egL0iCYNPYAECC4uJE8E8q0QLApom9DgseWp3MHTucNJ1URIWVTZksuIzOOkrZNI3H8qsXs7TxkAbiBCqKReFacA8IhT1hM6CdreTZREACzk4G1CA4wYpV8tP/5oeo+OKQKXtQ7cmOUFvwf1f6cjSBOuZyQsLqrpA8Z2scGjOomayWaOg/pTYGhoCM8+Qk+QTUwoAwMDNK0IIOmGh4dBZKXgRKhEBDFy24dGV7Vj6bHf7P/ZfclRmKydNGWwi1ulmD7IonmkRSLKwNkSj+nlYb2ABRE3hzfSchlYGXbv3l0ul2kdgbK/v//QoUPyQzN/tyhw1Y4dOxBBMjGz7t+/n0ITR6QOCA0bjOK+tEIRJyx7zX9ZOPP16e9fs+YCEf7gDlTKJhAhsoAgiX8hc+RL+Y+PG2VUiCpAhOpHRPhRyzt37mDZRp6jhkgHilQnPRGgWq1i3q1UKnAioIODg3jUjisjBCV4MplcuVE8NEDVa3xn4c2Xpv/1evMOW4axIdFaJcCJWI/ZhzBoOoqwgJEW52L187lTX8g92a+zn5GL2sSJADy0JGGMAKvrZT/6H7MvONJHjmYE8VvhXdoPKIGclnq+dOIr254bTw20PoUKSkGw/0Hr436ZCA4x5i/cln7+S/VAGScoBUGJtqEnaYAwUWe97MG4Q6ZgNImAUhknKGXSca6RgQXrs6XjfzH6uQPJEVzHlhg0EnOGIGwe4SZNK3FBWIx3N330CUtY9CpslHGCsyQgAieZXeqFP06EQJC4Ev61QwMkVeOJ/IP/vOeLT+X28RrydYo1jRPeXr4G8SAIv0RWOLsc6cNugwL9A5s6KkL4OwddSuAnu9ULf5wIgSBtlV2FBsBqghX9qyPP5fU02sSax1sYlNRg2SObMufftFm+gzK49aYEotNtaACoh0z21TRayIZHkC2cRMwYkbnjeVW3yf6LDHnUddoD/GS3euGPEyEQJK7EnL2O0AAX67cqXp21UWNHQPAYjUdqmPSQLfwSWeEQKP6sv1z1LZ65LKtXJ3LZDemJkq1oMLrHq9ULtoeHFwwMNBAx5oQHR2f/Bsem1hW/TARnmeNfd+bvuOwprrdADQP2vsG+qKI2dwPHd39QOY+kY3VAhmCP4mMO0vv03PHMrudLj/x84ciR9OioWe4zMmklYWAb01KSmBE2ISvv2rdvOYsIFXUUQIR3WECECTAFB3HhlAk73cFDpSDCBIRHEJQYTOxzCUSITrTd8sm43Jz5mfNfW3Sb6H62TfGVrGYezY49Vzr+Qt+JnYkyNLfsyrn6jfONqSuN2SmnMm8vL3tWU3Esz2G/B8Xb+kpC1ZN64rfSp04n96c25f8zIy59fX3rCM3fzL3+R9e+WVccjAm08cH00KcLR3+57+SxzA7MzYGoBcf36p5V85p33HrFqdV8u+FZSDhD1bNaoqRncp6ZqPmqg/EVdBdqEiEy4mc76btXCsgClIVCAaHoNjSu4v32e9/49u0f2747kiicLh55pvTwz+X2FfW7/Kda1/eWlpYa9Toe5FdviVyuIovo71qJlCmVSms/KAgggOjtATP3QvnESzt+6U9GfvHZ4kN3HRcAD/fpVErXOg4o1DJgLS574ojrO6GtkggClMlkEBfGxbnVswZTJmaQCWv+weTQrsSA0Yv/0cJb403xfEx1QBnpw7boUgbElWteggeuYrFIe5puQ0Ngawp/UOwV8BRXqVSanb943kggWcrlsviIZ32d3/OfLqA2uVwOmwjqTLYH7fDlCZxkyoTOttXHlYIIgSDkz+fz8idkzHt/gV5CdECQOLRJJ4JSJoSIPy7rRFAKwt1RghGD0URVIqxvQN0joA6NRgMjC+MrcG0gkC9oOLqH0kfg/mcNgKym+Y9tzzukPcnE2TghmUy6UaLEkhSPCxC17xdQy3Q6jQ0FmZTLKAnkBIgLp0zY6ZhHNgWRTQQFU0w8LsCmGFAyMPLn5+fjP+noObACYNeL/mgbF2CzZI0AKooVFIMLVRdpTwAHSBMnQiPI6spkMolRTM626HjiPgLVRZL39/dT1dEMOMUQ6BXotqtg0w0oGaibZVm1Wg2lw38OQE462yV4iqgYp4HdArIGuYkysGPY1KEhoIaIC/1qCgQLPNqJ1oKgJAERApmUbhiVtIvDJbhcXAJAgFkfyxOZcXwAQiNAMSJQgACqPxoMLiYOEEREACYuQXCRgLZt0+4JTgzbtss24YMUmghQcwqNaAKAdlLKBHYYiAuig+UPBCaWJ9pM0dkIPsChuTsgmhhZaCySCBHEaphItP8nmQ9daAgYXwgQyCrr92ZcvDcAGEQYTavs94APaWgATElAYLTDhzc0a2IrNB2xFZqO2ApNR2yFpiNWQrP6dP0hxMqWjz6dpZ9MbsAnSZscqVTq/wFA/8Sn/CbPxwAAAABJRU5ErkJggg==" }, { "id" : "662803789908017152", "app_id" : "662803789585055744", "tenant_id" : "a4da8115c9d8464ead3a38309130523f", "app_name" : "notepad", "app_category" : "GAME", "os_type" : "Windows", "version_id" : "v", "version_name" : "v", "appfile_store_path" : "file/npp_7.4.2_Installer.exe", "app_file_size" : "2979", "app_description" : "notepad。", "appicon_store_path" : "", "create_time" : "2024-02-01T06:38:10.049Z", "modify_time" : "2024-02-01T06:38:10.049Z", "verify_status" : "VERIFYING", "app_icon" : "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACYAAAAgCAYAAAB+******rSURBVFhHpZdpbJRVFIYHYtToHxOioOxYFls" } ] }

URI GET /v1/{project_id}/app-warehouse/apps 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 单次查询的大小[1-100]，默认值10。 offset 否 Integer 查询的偏移量，默认值0。 verify_status 否 String 审核状态。 app_id 否 String 应用仓库中的应用记录ID。 app_name 否 String 应用名称。 app_category 否 String 应用分类： GAME- 游戏。 BUSSINESS_INTELLIGENCE- 商业智能。 SECURE_STORAGE- 安全与存储。 MULTIMEDIA_AND_CODING- 多媒体与编解码。 PROJECT_MANAGEMENT- 项目管理, PRODUCTIVITY_AND_COLLABORATION- 生产力与协作。 WEB_ADN_APPLICATION- 网页与应用开发。 GRAPHIC_DESIGN- 图形设计。 OTHER- 其它。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 否 String 发送的实体的MIME类型。 表3 请求Body参数 参数 是否必选 参数类型 描述 sub_resource_sku 是 String 桌面协同资源SKU码。 order_id 否 String 订单ID。 desktop_ids 是 Array of strings 桌面ID列表。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 job_id String 创建云桌面总任务id。 状态码：400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应示例 状态码：200 查询云办公服务详情响应。 { "id" : "8aa1908f74824d8701748bf039600065", "status" : "SUBSCRIBED", "config_status" : "0", "closable" : false, "ad_domains" : { "domain_type" : "LOCAL_AD", "domain_admin_account" : "vdsadmin", "active_domain_name" : "ecs-ad.vdesktop.com", "active_domain_ip" : "192.168.0.131", "standby_domain_name" : "", "standby_domain_ip" : "", "active_dns_ip" : "192.168.0.131", "standby_dns_ip" : "", "domain_name" : "vdesktop.com", "use_ldaps" : true, "tls_config" : { "cert_start_time" : "2022-01-25T09:24:27", "cert_end_time" : "2023-01-25T09:34:27" } }, "vpc_id" : "fd3b4069-ac1e-45d2-ba27-4c18cd692d26", "vpc_name" : "vpc-be75", "dedicated_access_address" : "https://192.168.0.53", "dedicated_subnets" : "192.168.0.0/24;10.0.0.0/16", "internet_access_address" : "https://172.16.25.134", "internet_access_port" : "443", "access_mode" : "BOTH", "subnet_ids" : [ { "subnet_id" : "5dee0216-2260-47c2-9368-98a27d910e55" } ], "management_subnet_cidr" : "192.168.0.0/24", "infrastructure_security_group" : { "id" : "ffba6eda-5170-4343-b8a3-c306e0f21c88", "name" : "WorkspaceManagerSecurityGroup" }, "desktop_security_group" : { "id" : "04abbdf6-e848-4c90-bdb1-6de856fa8a34", "name" : "WorkspaceUserSecurityGroup" }, "progress" : "100%", "access_status" : "openSuccess", "is_send_email" : true, "authorized_collect_log" : false, "authorized_hda_upgrade" : false, "vpc_config_infos" : [ { "vpc_id" : "04abbdf6-e848-4c90-bdb1-6de856favpc1", "subnet_ids" : [ "04abbdf6-e848-4c90-bdb1-6de85subnet1" ], "default_access_vpc" : true }, { "vpc_id" : "04abbdf6-e848-4c90-bdb1-6de856favpc2", "subnet_ids" : [ "04abbdf6-e848-4c90-bdb1-6de85subnet3" ] } ] }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 id String 唯一标识ID。 ad_domains AdInfo object 域信息。 vpc_id String VPC ID。 vpc_name String VPC名称。 access_mode String 接入方式。 INTERNET：表示互联网接入。 DEDICATED：表示专线接入。 BOTH：表示同时支持互联网接入和专线接入。 adn_conflict_network String ADN上网冲突网段列表，多个网段信息用分号隔开，列表长度不超过50。 dedicated_subnets String 专线接入网段，只有access_mode为“DEDICATED”或“BOTH”时才会返回该参数。 dedicated_access_address String 专线接入地址，只有access_mode为“DEDICATED”或“BOTH”时才会返回该参数。 internet_access_address String 互联网接入地址，只有access_mode为“INTERNET”或“BOTH”时才会返回该参数。 internet_access_port String 互联网接入端口。 status String 云办公服务的状态。 PREPARING：准备开通。 SUBSCRIBING：开通中。 SUBSCRIBED：已开通。 SUBSCRIPTION_FAILED：开通失败。 DEREGISTERING：销户中。 DEREGISTRATION_FAILED：销户失败。 RECYCLING：清理资源中。 RECYCLED：清理资源成功。 RECYCLE_FAILED：清理资源失败。 CLOSED：已销户未开通。 access_status String 互联网和专线切换任务的状态。 init： 初始化 - 开通服务后的初始状态。 available： 可用 - 执行过任务且成功后恢复的正常状态。 internetOpening： 开启中 - 开通互联网接入开启中。 dedicatedOpening： 开启中 - 开通专线接入开启中。 internetOpenFailed： 开启失败 - 开通互联网接入开启失败。 dedicatedOpenFailed： 开启失败 - 开通专线接入开启失败。 openSuccess： 开启成功 - 开通接入方式成功。 internetClosing： 关闭中 - 关闭互联网接入关闭中。 dedicatedClosing： 关闭中 - 关闭专线接入关闭中。 internetCloseFailed： 关闭失败 - 关闭互联网接入方式失败。 dedicatedCloseFailed： 关闭失败 - 关闭专线接入方式失败。 closeSuccess： 关闭成功 - 关闭接入方式成功。 internetAccessPortModifying： 互联网接入端口修改中。 internetAccessPortModifyFailed： 端口修改失败。 subnet_ids Array of SubnetInfo objects 业务子网，可以指定返回的网络ID订购桌面。 management_subnet_cidr String 管理组件的子网网段。 infrastructure_security_group SecurityGroup object 开通服务会在指定的VPC下创建管理组件的安全组。 desktop_security_group SecurityGroup object 开通服务会在指定的VPC下创建桌面的安全组。 closable Boolean 是否可以取消服务。 config_status String 配置状态。 "0"： 开通服务成功，且对接AD成功。 "1"： 开通服务成功，但AD配置失败。 "2"： 开通服务成功，但AD配置失败后存在其他错误。 "3"： 开通服务成功，AD未开启对接。 progress String 开通服务或注销服务的进度，格式为百分比，如：100%。 job_id String 开通服务或取消服务的任务ID。 fail_code Integer 失败错误码。 fail_reason String 失败原因。 enterprise_id String 企业ID。 enterprise_project_id String 企业项目ID。 is_send_email Boolean 桌面退订是否发送邮件通知。 authorized_collect_log Boolean 是否授权收集日志。 authorized_hda_upgrade Boolean 是否授权hda升级。 dc_vnc_ip String 自定义的专线VNC地址。 is_authorized_install_agent Boolean 是否授权桌面自动安装agent插件。 is_support_ipv6 Boolean 是否支持ipv6。 enable_user_create_snapshot Boolean 是否授权最终租户创建快照。 表4 AdInfo 参数 参数类型 描述 domain_type String 域类型。 LITE_AS：本地认证。 LOCAL_AD：本地AD。 domain_name String 域名，域类型为LOCAL_AD时有值。 domain_admin_account String 域管理员帐号，域类型为LOCAL_AD时有值。 active_domain_name String 主域控制器名称，域类型为LOCAL_AD时有值。 active_domain_ip String 主域控制器IP地址，域类型为LOCAL_AD时有值。 standby_domain_name String 备域控制器名称，域类型为LOCAL_AD时有值。 standby_domain_ip String 备域控制器IP地址，域类型为LOCAL_AD时有值。 active_dns_ip String 主DNS IP地址，域类型为LOCAL_AD时有值。 standby_dns_ip String 备DNS IP地址，域类型为LOCAL_AD时有值。 delete_computer_object String 是否在删除桌面的同时删除AD上对应的计算机对象，'0'代表不删除，'1'代表删除。 use_ldaps Boolean 是否开启LDAPS。 tls_config TlsConfig object TLS信息。 表5 TlsConfig 参数 参数类型 描述 cert_pem String pem内容, 有则更新，无则上传。查询不返回。 cert_start_time String 证书生效开始时间，时间参考样例 2022-01-25T09:24:27。 cert_end_time String 证书生效截止时间，时间参考样例 2022-01-25T09:24:27。 表6 SubnetInfo 参数 参数类型 描述 subnet_id String 子网的网络ID。 表7 SecurityGroup 参数 参数类型 描述 id String 安全组ID。 name String 安全组名称。 状态码：400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：401 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：403 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：404 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：500 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应示例 状态码：200 查询桌面池列表响应。 { "total_count" : 2, "desktop_pools" : [ { "id" : "ca689892-25f2-4c68-88cb-56be3565f3f5", "name" : "POOL1", "type" : "STATIC", "created_time" : "2023-01-04T07:10:56.696Z", "root_volume" : { "type" : "SAS", "size" : 80, "cluster_id" : "" }, "availability_zone" : "cn-north-4a", "product" : { "product_id" : "workspace.x86.ultimate.large2", "flavor_id" : "s6.large.2", "type" : "BASE", "cpu" : "2", "memory" : "4096", "descriptions" : "尊享办公|2核|4GB内存。", "charge_mode" : "1", "architecture" : "x86", "is_gpu" : false, "package_type" : "ultimate", "system_disk_type" : "SAS", "system_disk_size" : "80", "contain_data_disk" : false, "resource_type" : "hws.resource.type.workspace.desktop", "cloud_service_type" : "hws.service.type.vdi", "volume_product_type" : "workspace", "status" : "normal", "sub_product_list" : [ ] } }, { "id" : "2c2be3fb-0013-48d5-a081-0731f3473997", "name" : "POOL2", "type" : "DEDICATED", "created_time" : "2023-01-04T07:10:53.554Z", "root_volume" : { "type" : "SAS", "size" : 80, "cluster_id" : "" }, "data_volumes" : [ { "type" : "SAS", "size" : 80, "cluster_id" : "" }, { "type" : "SAS", "size" : 80, "cluster_id" : "" } ], "availability_zone" : "cn-north-4b", "product" : { "product_id" : "workspace.x86.ultimate.large2", "flavor_id" : "s6.large.2", "type" : "BASE", "cpu" : "2", "memory" : "4096", "descriptions" : "尊享办公|2核|4GB内存。", "charge_mode" : "1", "architecture" : "x86", "is_gpu" : false, "package_type" : "ultimate", "system_disk_type" : "SAS", "system_disk_size" : "80", "contain_data_disk" : false, "resource_type" : "hws.resource.type.workspace.desktop", "cloud_service_type" : "hws.service.type.vdi", "volume_product_type" : "workspace", "status" : "normal", "sub_product_list" : [ ] } } ] }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 total_count Integer 总数。 desktop_pools Array of SimpleDesktopPoolInfo objects 桌面池信息。 表5 SimpleDesktopPoolInfo 参数 参数类型 描述 id String 桌面池ID。 name String 桌面池名称。 type String 桌面池类型。DYNAMIC：动态池，STATIC：静态池。 description String 桌面池描述。 created_time String 创建时间，格式为：UTC格式，例如“2022-05-11T11:45:42.000Z”。 charging_mode String 计费模式，0：包周期，1：按需。 desktop_count Integer 桌面池总桌面数量。 desktop_used Integer 桌面池绑定用户的桌面个数。 availability_zone String 可用区。 subnet_id String 子网ID。 product ProductInfo object 产品信息。 image_id String 镜像ID。 image_name String 镜像名称。 image_os_type String 镜像OS类型。 image_os_version String 镜像OS版本。 image_os_platform String 镜像OS平台。 image_product_code String 镜像的productCode（specCode）。 root_volume VolumeInfo object 系统盘。 data_volumes Array of VolumeInfo objects 数据盘列表。 security_groups Array of SecurityGroup objects 桌面安全组。 disconnected_retention_period Integer 动态池桌面断连多少分钟内，保留用户与桌面的绑定关系，超时后自动解绑。 enable_autoscale Boolean 桌面池是否开启弹性伸缩类型，为false则表示不开启弹性伸缩，为true则表示开启弹性伸缩。 autoscale_policy AutoscalePolicy object 弹性伸缩策略。 status String 桌面池状态。 STEADY：稳态 TEMPORARY：临时态 EXIST_FROZEN：存在冻结桌面 UNKNOWN：未知态 enterprise_project_id String 企业项目ID。 in_maintenance_mode Boolean 桌面池是否处于管理员维护模式。 desktop_name_policy_id String 策略id，用于指定生成桌面名称策略。 表6 ProductInfo 参数 参数类型 描述 product_id String 产品ID。 flavor_id String 产品规格ID。 type String 产品类型。 BASE：表示产品基础套餐，套餐镜像中不包括除操作系统之外的其他商业软件，私有镜像场景只能使用此类套餐。 cpu String CPU。 memory String 内存。 descriptions String 产品描述。 charge_mode String 周期套餐标识，0表示包周期，1表示按需。 表7 VolumeInfo 参数 参数类型 描述 id String 批量操作磁盘的磁盘集合id。 type String 桌面数据盘对应的磁盘类型，需要与系统所提供的磁盘类型相匹配。 SAS：高IO。 SSD：超高IO。 size Integer 磁盘容量，单位GB。 resource_spec_code String 规格。 表8 SecurityGroup 参数 参数类型 描述 id String 安全组ID。 表9 AutoscalePolicy 参数 参数类型 描述 autoscale_type String 弹性伸缩类型，ACCESS_CREATED：接入时创建，AUTO_CREATED：弹性伸缩。 max_auto_created Integer 自动创建桌面上限。 min_idle Integer 空闲桌面低于多少时开始自动创建桌面。 once_auto_created Integer 一次自动创建桌面的数量。 状态码：400 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：401 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：403 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：404 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：500 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。