华为云用户手册

响应参数 状态码：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 错误描述。

响应参数 状态码：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接口进行解密。 状态码：405 表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接口进行解密。 状态码：503 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

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

响应参数 状态码：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 错误描述。

响应示例 状态码：200 成功响应。 { "enable" : true, "max_scaling_amount" : 10, "single_expansion_count" : 1, "scaling_policy_by_session" : { "session_usage_threshold" : 85, "shrink_after_session_idle_minutes" : 60 } }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 enable Boolean 是否启用策略,默认启用： 'true': 启用 'false': 禁用 max_scaling_amount Integer 最大扩容数量。 single_expansion_count Integer 单次扩容数量。 scaling_policy_by_session ScalingPolicyBySession object 基于会话的弹性策略。 表5 ScalingPolicyBySession 参数 参数类型 描述 session_usage_threshold Integer 分组的总会话使用率(达到该阈值后扩容)。 shrink_after_session_idle_minutes Integer 给定时间内无会话连接的的实例进行释放。 状态码：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的值）。 Content-Type 是 String 发送的实体的MIME类型，如：application/json。 表3 请求Body参数 参数 是否必选 参数类型 描述 group_name 是 String 用户组名称。 platform_type 是 String 用户组类型。 AD： AD域用户组 LOCAL： 本地liteAs用户组 description 否 String 用户组描述。

响应参数 状态码：201 表4 响应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接口进行解密。 状态码：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 表10 响应Body参数 参数 参数类型 描述 orders Array of OrderV5 objects 批量生成订单结果。 表11 OrderV5 参数 参数类型 描述 order_id String 订单id。 order_status Integer 订单状态:0:初始化; 1:待审核; 2:待退款; 3:处理中; 4:已取消; 5:已完成; 6:待支付; 7:补偿中; 8:待审批; 9:待确认; 10:待发货; 11:待收货; 12:待上门取货; 13:换新中; 14:待商家收货。 result String 结果，SUC CES S:成功； FAIL：失败。 result_code String result=FAIL时，必填，表示该订单失败原因。 result_msg String 失败信息，和result_code结对出现。 状态码：400 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：409 表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接口进行解密。

请求示例 { "type" : "string", "add_volume_param" : { "desktop_pool_id" : "string", "desktop_ids" : [ "string" ], "promotion_plan_id" : "string", "volume_type" : "string", "volume_size" : 8200 }, "extend_volume_param" : { "desktop_pool_id" : "string", "desktop_ids" : [ "string" ], "promotion_plan_id" : "string", "desktop_pool_disk_id" : "string", "new_size" : 8200 }, "resize_param" : { "desktop_pool_id" : "string", "desktop_ids" : [ "string" ], "promotion_plan_id" : "string", "product_id" : "string", "mode" : "string", "extend_param" : { "is_auto_pay" : "string" } }, "change_image_param" : { "desktop_pool_id" : "string", "desktop_ids" : [ "string" ], "promotion_plan_id" : "string", "image_spec_code" : "string", "image_id" : "string", "delay_time" : 15, "message" : "string" }, "add_sub_resources_param" : { "desktop_pool_id" : "string", "desktop_ids" : [ "string" ], "promotion_plan_id" : "string", "sub_resource_sku" : "string" }, "delete_sub_resources_param" : { "desktop_pool_id" : "string", "desktop_ids" : [ "string" ], "promotion_plan_id" : "string", "sub_resource_type" : "string" } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 否 String 发送的实体的MIME类型。 表3 请求Body参数 参数 是否必选 参数类型 描述 type 否 String 下单类型。 ADD_VOLUME：增加磁盘 EXTEND_VOLUME：扩容磁盘 RESIZE：变更规格 CHANGE_IMAGE：切换镜像 ADD_SUB_RESOURCES：购买桌面协同资源 DELETE_SUB_RESOURCES：退订桌面协同资源 add_volume_param 否 EstimateAddVolumeRequestBody object 包周期桌面池添加磁盘、切换镜像询价请求体。 extend_volume_param 否 EstimateExtendVolumeRequestBody object 包周期扩容磁盘询价请求体。 resize_param 否 CreateResizeOrderRequestBody object 包周期变更规格询价请求体。 change_image_param 否 CreateChangeImageOrderRequestBody object 包周期重建系统盘询价请求体。 add_sub_resources_param 否 EstimateAddSubResourcesRequestBody object 包周期新增附属资源询价请求体。 delete_sub_resources_param 否 CreateDeleteSubResourcesOrderRequestBody object 包周期删除附属资源询价请求体。 表4 EstimateAddVolumeRequestBody 参数 是否必选 参数类型 描述 desktop_pool_id 否 String 桌面池ID。当desktop_pool_id与desktop_ids同时存在时，取desktop_ids的值，两者不可同时为空。 desktop_ids 否 Array of strings 包周期桌面ID列表。 不可同时存在普通桌面和池桌面ID。 promotion_plan_id 否 String 促销计划ID。 volume_type 是 String 新增磁盘类型。 volume_size 是 Integer 新增磁盘大小。 表5 EstimateExtendVolumeRequestBody 参数 是否必选 参数类型 描述 desktop_pool_id 否 String 桌面池ID。当desktop_pool_id与desktop_ids同时存在时，取desktop_ids的值，两者不可同时为空。 desktop_ids 否 Array of strings 包周期桌面ID列表。 不可同时存在普通桌面和池桌面ID。 promotion_plan_id 否 String 促销计划ID。 desktop_pool_disk_id 是 String 需要扩容的桌面池磁盘ID。 new_size 是 Integer 扩容后的磁盘大小。 表6 CreateResizeOrderRequestBody 参数 是否必选 参数类型 描述 desktop_pool_id 否 String 桌面池ID。当desktop_pool_id与desktop_ids同时存在时，取desktop_ids的值，两者不可同时为空。 desktop_ids 否 Array of strings 包周期桌面ID列表。 不可同时存在普通桌面和池桌面ID。 promotion_plan_id 否 String 促销计划ID。 product_id 是 String 目标规格产品ID。 mode 否 String 是否支持开机状态下执行变更规格操作。固定传值STOP_DESKTOP，如果桌面处于开机状态，会先关机再变更规格。 表7 CreateChangeImageOrderRequestBody 参数 是否必选 参数类型 描述 desktop_pool_id 否 String 桌面池ID。当desktop_pool_id与desktop_ids同时存在时，取desktop_ids的值，两者不可同时为空。 desktop_ids 否 Array of strings 包周期桌面ID列表。 不可同时存在普通桌面和池桌面ID。 promotion_plan_id 否 String 促销计划ID。 image_spec_code 否 String 云市场镜像的specCode，即将停用。image_spec_code与image_id同时存在时取image_id的值，两者不可同时为空。 image_id 否 String 云市场镜像ID，建议使用image_id。 delay_time 否 Integer 立即重建时给用户预留的保存数据的时间（单位：分钟）。 message 否 String 下发重建系统盘任务时，给用户发送的提示信息。 表8 EstimateAddSubResourcesRequestBody 参数 是否必选 参数类型 描述 desktop_pool_id 否 String 桌面池ID。当desktop_pool_id与desktop_ids同时存在时，取desktop_ids的值，两者不可同时为空。 desktop_ids 否 Array of strings 包周期桌面ID列表。 不可同时存在普通桌面和池桌面ID。 promotion_plan_id 否 String 促销计划ID。 sub_resource_sku 是 String 新增附属资源SKU码。 表9 CreateDeleteSubResourcesOrderRequestBody 参数 是否必选 参数类型 描述 desktop_pool_id 否 String 桌面池ID。当desktop_pool_id与desktop_ids同时存在时，取desktop_ids的值，两者不可同时为空。 desktop_ids 否 Array of strings 包周期桌面ID列表。 不可同时存在普通桌面和池桌面ID。 promotion_plan_id 否 String 促销计划ID。 sub_resource_type 是 String 待删除附属资源类型：DESKTOP_SHARER(桌面协同资源)。

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

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”两种，用","分开，用户为用户激活模式时必须要带上通知类型，以便接收到密码通知。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 project_id String 租户ID 同tenant_id。 service_status String 企业是否激活：active(激活)，inactive(未激活)。 状态码：400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：503 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

请求示例 { "availability_zone" : "cn-north-5a", "subnet_id" : "085ca7d8-4474-4c32-bff0-31254d98c4a9", "nics" : [ { "subnet_id" : "085ca7d8-4474-4c32-bff0-31254d98c4a9" } ], "product_id" : "workspace.appstream.general.xlarge.2", "flavor_id" : "c3.large.4", "os_type" : "Windows", "root_volume" : { "type" : "SAS", "size" : 80 }, "server_group_id" : "f309fa65-881a-4f49-8c06-31e20437ae20", "vpc_id" : "d987ecf7-c6a4-4753-8b66-135dcc3eed79", "ou_name" : "", "update_access_agent" : false, "type" : "createApps", "subscription_num" : 1, "create_server_extend_param" : { "charging_mode" : "prePaid", "period_type" : 3, "period_num" : 2, "is_auto_renew" : false, "is_auto_pay" : false } }

响应参数 状态码：200 表8 响应Body参数 参数 参数类型 描述 job_id String 对于创建云应用服务器命令下发后会返回job_id，通过job_id可以查询任务的执行状态,按需购买返回该参数。 order_id String 订单号，创建包年包月的弹性云服务器时返回该参数。 状态码：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 错误描述。 状态码：500 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 type 是 String 创建云服务类型，当前仅支持创建云应用：createApps。 server_group_id 是 String 服务器组唯一标识。 availability_zone 否 String 可用分区。 说明： 将服务创建到指定的可用分区，如果不指定则使用系统随机的可用分区。 获取方式详见可用区管理ListAvailabilityZone："GET /v1/{project_id}/availability-zone"。 subscription_num 是 Integer 订购数量。 nics 否 Array of Nic objects 服务对应的网卡信息，当前未使用该字段。 ou_name 否 String OU名称，在对接AD时使用，需提前在AD中创建OU。 product_id 是 String 产品ID。 说明： 获取方式详见产品套餐管理ListProduct："GET /v1/{project_id}/product"。 flavor_id 否 String 规格ID。 os_type 否 String 操作系统类型，当前仅支持Windows。 root_volume 是 Volume object 系统盘： 磁盘容量，磁盘容量最大只支持1024G, 且为10的倍数。 scheduler_hints 否 WdhParam object 专属主机： 专属主机只支持按需模式，包周期模式不支持专属主机。 subnet_id 是 String 网卡对应的子网ID。 vpc_id 是 String 虚拟私有云ID。 update_access_agent 否 Boolean 是否自动升级hda版本。 create_server_extend_param 否 CreateServerExtendParam object 创建云服务器附加信息。 表4 Nic 参数 是否必选 参数类型 描述 ip_address 否 String IP地址。 subnet_id 否 String 网卡对应的子网ID。 表5 Volume 参数 是否必选 参数类型 描述 type 是 String 磁盘类型，获取可用磁盘类型详见接口磁盘管理ListVolumeType。 ESSD - 极速型SSD SSD - 超高IO GPSSD - 通用型SSD SAS - 高IO SATA - 普通IO size 是 Integer 磁盘容量，单位GB，数值约束为10的倍数。 系统盘 minLength: 10，maxLength: 1024 数据盘 minLength: 10，maxLength: 32768 cluster_id 否 String 云服务器系统盘对应的存储池的ID。 表6 WdhParam 参数 是否必选 参数类型 描述 dedicated_host_id 否 String 云办公主机id。 tenancy 否 String 专属主机类型，目前只支持dedicated。 - dedicated：专属型 - shared： 共享型。 表7 CreateServerExtendParam 参数 是否必选 参数类型 描述 charging_mode 否 String 计费模式，取值范围： prePaid-预付费，即包年包月； postPaid-后付费，即按需付费； period_type 否 Integer 周期类型 2：包月；3：包年* chargingMode为prePaid时生效且为必选值。 period_num 否 Integer 订购周期数，chargingMode为prePaid时生效且为必选值，periodNum为正整数，取值范围： 说明： periodType=2（周期类型为月）时，取值为[1，9]。 periodType=3（周期类型为年）时，取值为[1，3]。 is_auto_renew 否 Boolean 是否是自动续订，默认不填为false。 说明： false 不自动续订。 true 自动续订。 is_auto_pay 否 Boolean 下单订购后，是否自动从客户的账户中支付，而不需要客户手动去进行支付。chargingMode为prePaid时生效，不传该字段时默认为客户手动支付。 说明： true ：是（自动支付）。 false：否（需要客户手动支付）。

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 enable Boolean 是否启用策略,默认启用： 'true': 启用 'false': 禁用 max_scaling_amount Integer 最大扩容数量。 single_expansion_count Integer 单次扩容数量。 scaling_policy_by_session ScalingPolicyBySession object 基于会话的弹性策略。 表6 ScalingPolicyBySession 参数 参数类型 描述 session_usage_threshold Integer 分组的总会话使用率(达到该阈值后扩容)。 shrink_after_session_idle_minutes Integer 给定时间内无会话连接的的实例进行释放。 状态码：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 错误描述。 状态码：500 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：503 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

响应示例 状态码：200 成功响应。 { "enable" : true, "max_scaling_amount" : 10, "single_expansion_count" : 1, "scaling_policy_by_session" : { "session_usage_threshold" : 85, "shrink_after_session_idle_minutes" : 60 } }

请求示例 { "enable" : true, "max_scaling_amount" : 10, "single_expansion_count" : 1, "scaling_policy_by_session" : { "session_usage_threshold" : 85, "shrink_after_session_idle_minutes" : 60 }, "server_group_id" : "1c873056-9f4d-11ec-b909-0242ac120002" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 enable 否 Boolean 是否启用策略,默认启用： 'true': 启用 'false': 禁用 max_scaling_amount 是 Integer 最大扩容数量。 single_expansion_count 是 Integer 单次扩容数量。 scaling_policy_by_session 是 ScalingPolicyBySession object 基于会话的弹性策略。 server_group_id 是 String 服务器组唯一标识(仅按需服务器组支持该操作)。 表4 ScalingPolicyBySession 参数 是否必选 参数类型 描述 session_usage_threshold 是 Integer 分组的总会话使用率(达到该阈值后扩容)。 shrink_after_session_idle_minutes 是 Integer 给定时间内无会话连接的的实例进行释放。

响应参数 状态码：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接口进行解密。

请求示例 put /v2/0e973a948e8091232f25c00673f168b7/access-policy/20b726affecc4411bcdc49a66e3e8f63/objects { "policy_objects_list" : [ { "object_id" : "8ac225c2781edb0d01781edde3f4xxxx", "object_type" : "USER" }, { "object_id" : "8ac225c2781edb0d01781edde3f4xxxx", "object_type" : "USER" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 是 String 发送的实体的MIME类型。 表3 请求Body参数 参数 是否必选 参数类型 描述 policy_objects_list 否 Array of AccessPolicyObjectInfo objects 更新策略应用对象列表请求。 表4 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列表。 op_type 是 String 操作类型。 -os-start 启动。 -reboot 重启。 -os-stop 关机。 -os-hibernate 休眠。 type 否 String SOFT：普通操作；HARD：强制操作。例如type为HARD，op_type为os-stop代表强制关机。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 failed_operation_list Array of VmOperateResult objects 操作失败桌面列表。 job_id String 任务ID，冷迁移启动时返回。 表5 VmOperateResult 参数 参数类型 描述 desktop_id String 桌面ID。 desktop_name String 桌面名称。 error_code String 操作失败的错误码。 error_msg String 操作失败的原因描述。 状态码：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接口进行解密。 状态码：409 表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 表3 响应Body参数 参数 参数类型 描述 bucket_name 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 错误描述。

响应示例 状态码：200 响应成功。 { "rule_id" : "xxxx-xxxx-xxxx", "metric_name" : "desktop_idle_duration", "threshold" : 30, "comparison_operator" : "", "interval" : 1, "enable" : true, "notify_object" : "urn:smn:REGION_ID:XXX-XXX-XXX:topicName" }

响应示例 状态码：200 查询策略组策略项信息的响应。 { "policies" : { "peripherals" : { "usb_port_redirection" : { "usb_enable" : true, "options" : { "usb_image_enable" : true, "usb_video_enable" : true, "usb_printer_enable" : true, "usb_storage_enable" : false, "wireless_devices_enable" : false, "network_devices_enable" : false, "usb_smart_card_enable" : true, "other_usb_devices_enable" : false, "usb_redirection_customization_policy" : "string", "usb_redirection_mode" : "Classical mode" } }, "device_redirection" : { "printer_redirection" : { "printer_enable" : true, "options" : { "sync_client_default_printer_enable" : true, "universal_printer_driver" : "Default" } }, "session_printer" : { "session_printer_enable" : false, "options" : { "session_printer_customization_policy" : "string" } }, "camera_redirection" : { "video_compress_enable" : true, "options" : { "camera_frame_rate" : 15, "camera_max_width" : 3000, "camera_max_heigth" : 3000, "camera_compression_method" : "H.264" } }, "twain_redirection_enable" : true, "image_compression_level" : "medium" }, "usb_device_common" : { "pcsc_smart_card_enable" : "Disable", "common_options" : { "remove_smart_card_disconnect_enable" : false } }, "serial_port_redirection" : { "serial_port_enable" : false, "options" : { "auto_connect_enable" : false } } }, "audio" : { "audio_redirection_enable" : true, "play_redirection_enable" : true, "play_classification" : "Music Play", "record_redirection_enable" : true, "record_classification" : "Speech Call" }, "client" : { "automatic_reconnection_interval" : 5, "session_persistence_time" : 180, "forbid_screen_capture" : false }, "display" : { "display_level" : "LEVEL4", "options" : { "display_bandwidth" : 20000, "frame_rate" : 25, "video_frame_rate" : 30, "min_image_cache" : 200, "smoothing_factor" : 60, "lossless_compression_mode" : "Basic Compression", "deep_compression_options" : { "deep_compression_level" : "Compression grade 0" }, "lossy_compression_quality" : 85, "color_enhancement_enable" : false, "quality_bandwidth_first" : "Quality First", "video_bit_rate_options" : { "average_video_bit_rate" : 18000 }, "peak_video_bit_rate" : 18000, "video_quality_options" : { "average_video_quality" : 15, "lowest_video_quality" : 25, "highest_video_quality" : 7 }, "gop_size" : 100, "encoding_preset" : "Preset 1" }, "rendering_acceleration_enable" : false, "rendering_acceleration_options" : { "video_acceleration_enhancement_enable" : false, "video_optimization_enable" : false, "gpu_color_optimization_enable" : false }, "video_card_memory_size" : 64, "driver_delegation_mode_enable" : false, "driver_delegation_latency" : 80, "video_latency" : 80, "change_resolution_vm" : false }, "file_and_clipboard" : { "bypass_in_remote_app_enable" : true, "file_redirection" : { "redirection_mode" : "DISABLED", "options" : { "fluid_control_switch_enable" : false, "fluid_control_options" : { "good_network_latency" : 30, "normal_network_latency" : 70, "poor_network_latency" : 100, "reducing_step" : 20, "slow_increasing_step" : 10, "quick_increasing_step" : 20, "start_speed" : 1024, "test_block_size" : 64, "test_time_gap" : 10000 }, "compression_switch_enable" : false, "compression_switch_options" : { "compression_threshold" : 512, "minimum_compression_rate" : 900 }, "linux_file_size_supported_enable" : true, "linux_file_size_supported_options" : { "linux_file_size_supported_threshold" : 100 }, "linux_root_mount_switch_enable" : true, "linux_root_dir_list" : "\\\\home", "linux_file_mount_path" : "\\\\media|\\\\Volumes|\\\\swdb\\\\mnt|\\\\home|\\\\storage|\\\\tmp|\\\\run\\\\media", "linux_fixed_drive_file_system_format" : "string", "linux_removable_drive_file_system_format" : "vfat|ntfs|msdos|fuseblk|sdcardfs|exfat|fuse.fdredir", "linux_cdrom_drive_file_system_format" : "cd9660|iso9660|udf", "linux_network_drive_file_system_format" : "smbfs|afpfs|cifs", "path_separator" : "|", "fixed_drive_enable" : true, "removable_drive_enable" : true, "cd_rom_drive_enable" : true, "network_drive_enable" : true }, "vm_send_file_client" : true, "redirection_send_file_options" : { "read_write_speed" : 0 } }, "fd_mobile_client_redir_enable" : true, "clipboard_redirection" : "DISABLED", "clipboard_redirection_options" : { "rich_text_redirection_enable" : true, "rich_text_clipboard_redirection" : "DISABLED", "clipboard_file_redirection_enable" : true, "file_clipboard_redirection" : "DISABLED" } }, "session" : { "sbc" : { "sbc_automatic_disconnection" : "AUTO_DISCONNECT", "sbc_automatic_disconnection_options" : { "disconnection_waiting_time" : 15, "sbc_auto_logout" : true, "auto_logout_options" : { "sbc_logout_waiting_time" : 480 } } } }, "virtual_channel" : { "virtual_channel_control_enable" : false, "options" : { "custom_virtual_channel_name" : "string", "virtual_channel_plugin_details" : "string", "third_party_plugin_name" : "string" } }, "keyboard_mouse" : { "mouse_feedback" : "SELFADAPTION", "mouse_simulation_mode" : "ABSOLUTE_POSITION", "external_cursor_feedback" : false }, "bandwidth" : { "intelligent_data_transport_flag" : "DISABLE", "total_bandwidth_control_enable" : false, "options" : { "total_bandwidth_control_value" : 30000, "display_bandwidth_percentage_enable" : false, "display_bandwidth_percentage_options" : { "display_bandwidth_percentage_value" : 65 }, "multimedia_bandwidth_percentage_enable" : false, "multimedia_bandwidth_percentage_options" : { "multimedia_bandwidth_percentage_value" : 50 }, "usb_bandwidth_percentage_enable" : false, "usb_bandwidth_percentage_options" : { "usb_bandwidth_percentage_value" : 100 }, "pcsc_bandwidth_percentage_enable" : false, "pcsc_bandwidth_percentage_options" : { "pcsc_bandwidth_percentage_value" : 5 }, "twain_bandwidth_percentage_enable" : false, "twain_bandwidth_percentage_options" : { "twain_bandwidth_percentage_value" : 15 }, "printer_bandwidth_percentage_enable" : false, "printer_bandwidth_percentage_options" : { "printer_bandwidth_percentage_value" : 5 }, "com_bandwidth_percentage_enable" : false, "com_bandwidth_percentage_options" : { "com_bandwidth_percentage_value" : 3 }, "file_redirection_bandwidth_percentage_enable" : false, "file_redirection_bandwidth_percentage_options" : { "file_redirection_bandwidth_percentage_value" : 30 }, "clipboard_bandwidth_percentage_enable" : false, "clipboard_bandwidth_percentage_options" : { "clipboard_bandwidth_percentage_value" : 3 }, "secure_channel_bandwidth_percentage_enable" : false, "secure_channel_bandwidth_percentage_options" : { "secure_channel_bandwidth_percentage_value" : 30 }, "camera_bandwidth_percentage_enable" : false, "camera_bandwidth_percentage_options" : { "camera_bandwidth_percentage_value" : 30 }, "virtual_channel_bandwidth_percentage_enable" : false, "virtual_channel_bandwidth_percentage_options" : { "virtual_channel_bandwidth_percentage_value" : 65 } }, "display_bandwidth_control_enable" : false, "display_bandwidth_control_options" : { "display_bandwidth_control_value" : 20000 }, "multimedia_bandwidth_control_enable" : false, "multimedia_bandwidth_control_options" : { "multimedia_bandwidth_control_value" : 15000 }, "usb_bandwidth_control_enable" : false, "usb_bandwidth_control_options" : { "usb_bandwidth_control_value" : 30000 }, "pcsc_bandwidth_control_enable" : false, "pcsc_bandwidth_control_options" : { "pcsc_bandwidth_control_value" : 2000 }, "twain_bandwidth_control_enable" : false, "twain_bandwidth_control_options" : { "twain_bandwidth_control_value" : 5000 }, "printer_bandwidth_control_enable" : false, "printer_bandwidth_control_options" : { "printer_bandwidth_control_value" : 2000 }, "com_bandwidth_control_enable" : false, "com_bandwidth_control_options" : { "com_bandwidth_control_value" : 1000 }, "file_redirection_bandwidth_control_enable" : false, "file_redirection_bandwidth_control_options" : { "file_redirection_bandwidth_control_value" : 10000 }, "clipboard_bandwidth_control_enable" : false, "clipboard_bandwidth_control_options" : { "clipboard_bandwidth_control_value" : 1000 }, "secure_channel_bandwidth_control_enable" : false, "secure_channel_bandwidth_control_options" : { "secure_channel_bandwidth_control_value" : 10000 }, "camera_bandwidth_control_enable" : false, "camera_bandwidth_control_options" : { "camera_bandwidth_control_value" : 10000 }, "virtual_channel_bandwidth_control_enable" : false, "virtual_channel_bandwidth_control_options" : { "virtual_channel_bandwidth_control_value" : 20000 } }, "custom" : { "custom_configuration1_enable" : true, "options" : { "custom_configuration1_rule" : "string" } } } }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 policies Policies object 策略类。 表4 Policies 参数 参数类型 描述 peripherals peripherals object 外设。 audio audio object 音频。 client client object 客户端。 display display object 显示。 file_and_clipboard file_and_clipboard object 文件和剪切板。 session Session object 会话。 virtual_channel VirtualChannel object 虚拟通道。 keyboard_mouse keyboard_mouse object 键盘鼠标。 bandwidth Bandwidth object 带宽。 custom custom object 自定义策略。 cloud_storage cloud_storage object 云存储 配置。 user_profile user_profile object 配置文件漫游技术配置。 表5 peripherals 参数 参数类型 描述 usb_port_redirection usb_port_redirection object USB端口重定向。 device_redirection device_redirection object 设备重定向。 usb_device_common usb_device_common object USB和设备智能卡控制选项。 serial_port_redirection serial_port_redirection object 串口重定向。 表6 usb_port_redirection 参数 参数类型 描述 usb_enable Boolean 是否开启USB端口重定向。取值为： false：表示关闭。 true：表示开启。 options UsbPortRedirectionOptions object USB端口重定向控制的选项。 表7 UsbPortRedirectionOptions 参数 参数类型 描述 usb_image_enable Boolean 是否开启图像设备（如: 扫描仪）。取值为： false：表示关闭。 true：表示开启。 usb_video_enable Boolean 是否开启视频设备（如: 摄像头）。取值为： false：表示关闭。 true：表示开启。 usb_printer_enable Boolean 是否开启打印设备（如: 打印机）。取值为： false：表示关闭。 true：表示开启。 usb_storage_enable Boolean 是否开启存储设备（如: U盘）。取值为： false：表示关闭。 true：表示开启。 wireless_devices_enable Boolean 是否开启无线设备（如：蓝牙）。取值为： false：表示关闭。 true：表示开启。 network_devices_enable Boolean 是否开启网络设备（如：无线网卡）。取值为： false：表示关闭。 true：表示开启。 usb_smart_card_enable Boolean 是否开启智能卡设备（如：Ukey）。取值为： false：表示关闭。 true：表示开启。 other_usb_devices_enable Boolean 是否开启其他USB设备重定向。取值为： false：表示关闭。 true：表示开启。 usb_redirection_customization_policy String USB端口重定向自定义策略。 usb_redirection_mode String USB 重定向模式。取值为： Classical mode：经典模式。 Common mode：通用模式。 表8 device_redirection 参数 参数类型 描述 printer_redirection printer_redirection object 打印机重定向。 session_printer session_printer object 会话打印机。 camera_redirection camera_redirection object 摄像头重定向。 twain_redirection_enable Boolean 是否开启TWAIN设备重定向。取值为： false：表示关闭。 true：表示开启。 image_compression_level String 图形压缩级别。取值为： 不压缩：none。 低（速度最快）：low。 中（速度适中）：medium。 高（速度最慢）：high。 无损（无损压缩）：lossless。 低损（低损压缩）：low-loss。 中损（中损压缩）：medium-loss。 高损（高损压缩）：high-loss。 表9 printer_redirection 参数 参数类型 描述 printer_enable Boolean 是否开启打印机设备重定向。取值为： false：表示关闭。 true：表示开启。 options PrinterRedirectionOptions object 打印机设备重定向控制的选项。 表10 PrinterRedirectionOptions 参数 参数类型 描述 sync_client_default_printer_enable Boolean 是否开启同步客户端默认打印机。取值为： false：表示关闭。 true：表示开启。 universal_printer_driver String 通用打印机驱动。取值为：- Default：linux客户端选择Universal Printing- PS，windows客户端选择HDP XPSDrv Driver。- HDP XPSDrv Driver。- Universal Printing PCL 5。- Universal Printing PCL 6。- Universal Printing PS。 表11 session_printer 参数 参数类型 描述 session_printer_enable Boolean 是否开启会话打印机。取值为： false：表示关闭。 true：表示开启。 options SessionPrinterOptions object 会话打印机控制选项。 表12 SessionPrinterOptions 参数 参数类型 描述 session_printer_customization_policy String 会话打印机自定义策略。 表13 camera_redirection 参数 参数类型 描述 video_compress_enable Boolean 是否开启摄像头设备重定向。取值为： false：表示关闭。 true：表示开启。 options CameraRedirectionOptions object 摄像头设备重定向控制的选项。 表14 CameraRedirectionOptions 参数 参数类型 描述 camera_frame_rate Integer 摄像头帧率（fps）。取值范围为[1-30]。默认：15。 camera_max_width Integer 摄像头最大宽度（pixel）。取值范围为[1-9999]。默认：3000。 camera_max_heigth Integer 摄像头最大高度（pixel）。取值范围为[1-9999]。默认：3000。 camera_compression_method String 摄像头数据压缩方式。取值为：H.264。 表15 usb_device_common 参数 参数类型 描述 pcsc_smart_card_enable String 是否开启PC/SC智能卡重定向。取值为： Enable：表示已启动。 Closed：表示已关闭。 Disable：表示已禁用。 common_options common_options object USB和设备智能卡共同控制的选项。 表16 common_options 参数 参数类型 描述 remove_smart_card_disconnect_enable Boolean 是否移除智能卡断开用户会话。取值为： false：表示关闭。 true：表示开启。 表17 serial_port_redirection 参数 参数类型 描述 serial_port_enable Boolean 是否开启串口重定向。取值为： false：表示关闭。 true：表示开启。 options SerialPortRedirectionOptions object 串口重定向控制的选项。 表18 SerialPortRedirectionOptions 参数 参数类型 描述 auto_connect_enable Boolean 是否自动连接客户端串口。取值为： false：表示关闭。 true：表示开启。 表19 audio 参数 参数类型 描述 audio_redirection_enable Boolean 是否开启音频重定向。取值为： false：表示关闭。 true：表示开启。 play_redirection_enable Boolean 是否开启播音重定向。取值为： false：表示关闭。 true：表示开启。 play_classification String 播音场景。取值为： 无损播音：LossLess。 语音通话：Speech Call。 音乐播音：Music Play。 自动识别：Automatic Identification。 record_redirection_enable Boolean 是否开启录音重定向。取值为： false：表示关闭。 true：表示开启。 record_classification String 录音场景。取值为： 无损录音：LossLess。 语音通话：Speech Call。 音乐录音：Music Record。 自动识别：Automatic Identification。 表20 client 参数 参数类型 描述 automatic_reconnection_interval Integer 自动重连间隔（秒）。取值范围为[1-50]。默认：5。 session_persistence_time Integer 自动重连会话保持时长（秒）。取值范围为[0-180]。默认：180。 forbid_screen_capture Boolean 防截屏策略开关。 false：表示关闭。 true：表示开启。 表21 display 参数 参数类型 描述 display_level String 显示级别。取值为： LEVEL1：表示等级1。 LEVEL2：表示等级2。 LEVEL3：表示等级3。 LEVEL4：表示等级4（默认/推荐）。 LEVEL5：表示等级5。 options DisplayOptions object 显示级别共同控制的选项。 rendering_acceleration_enable Boolean 是否开启渲染加速。取值为： false：表示关闭。 true：表示开启。 rendering_acceleration_options rendering_acceleration_options object 渲染加速控制选项。 video_card_memory_size Integer 显卡缓存（MB）。取值范围为[0-64]。默认：64。 driver_delegation_mode_enable Boolean 是否开启驱动托管模式。取值为： false：表示关闭。 true：表示开启。 driver_delegation_latency Integer 驱动托管延时（*30ms）。取值范围为[1-100]。默认：80。 video_latency Integer 驱动托管视频延时（*30ms）。取值范围为[1-100]。默认：80。 change_resolution_vm Boolean 计算机修改分辨率：取值为： false：表示关闭。 true：表示开启。 表22 DisplayOptions 参数 参数类型 描述 display_bandwidth Integer 带宽（Kbps）。取值范围为[256-25000]。默认：20000。 frame_rate Integer 帧率（fps）。取值范围为[1-60]。默认：25。 video_frame_rate Integer 视频帧率（fps）。取值范围为[1-60]。默认：30。 min_image_cache Integer 图像缓存最低容量（MB）。取值范围[0-300]，默认：200。 smoothing_factor Integer 有损压缩识别阈值。取值范围为[0-255]。默认：60。 lossless_compression_mode String 无损压缩模式。取值为： Basic Compression：表示初级压缩。 Deep Compression：表示深度压缩。 deep_compression_options deep_compression_options object 深度压缩控制选项。 lossy_compression_quality Integer 有损压缩质量。取值范围为[20-100]。默认：85。 color_enhancement_enable Boolean 办公场景色彩增强：取值为： false：表示关闭。 true：表示开启。 quality_bandwidth_first String 质量或带宽优先。取值为： Quality First：表示初级压缩。 Bandwidth First：表示深度压缩。 video_bit_rate_options video_bit_rate_options object 视频码率控制选项。 peak_video_bit_rate Integer 视频峰值码率（Kbps）。取值范围为[256-100000]。默认：18000。 video_quality_options video_quality_options object 视频质量控制选项。 gop_size Integer GOP大小。取值范围为[0-65535]。默认：100。 encoding_preset String 编码预置。取值为： 预置1：Preset 1。 预置2：Preset 2。 预置3：Preset 3。 预置4：Preset 4。 预置5：Preset 5。 预置6：Preset 6。 预置7：Preset 7。 表23 deep_compression_options 参数 参数类型 描述 deep_compression_level String 深度压缩级别。取值为： 压缩级别0：Compression grade 0 压缩级别1：Compression grade 1 压缩级别2：Compression grade 2 压缩级别3：Compression grade 3 压缩级别4：Compression grade 4 压缩级别5：Compression grade 5 压缩级别6：Compression grade 6 压缩级别7：Compression grade 7 压缩级别8：Compression grade 8 压缩级别9：Compression grade 9 表24 video_bit_rate_options 参数 参数类型 描述 average_video_bit_rate Integer 视频平均码率（Kbps）。取值范围为[256-100000]。默认：18000。 表25 video_quality_options 参数 参数类型 描述 average_video_quality Integer 视频平均质量。取值范围为[5-59]。默认：15。 lowest_video_quality Integer 视频最低质量。取值范围为[5-69]。默认：25。 highest_video_quality Integer 视频最高质量。取值范围为[1-59]。默认：7。 表26 rendering_acceleration_options 参数 参数类型 描述 video_acceleration_enhancement_enable Boolean 视频加速增强配置。取值为： false：表示关闭。 true：表示开启。 video_optimization_enable Boolean 是否开启视频场景优化。取值为： false：表示关闭。 true：表示开启。 gpu_color_optimization_enable Boolean 是否开启GPU色彩优化。取值为： false：表示关闭。 true：表示开启。 表27 file_and_clipboard 参数 参数类型 描述 bypass_in_remote_app_enable Boolean 应用聚合场景下是否双向放通：取值为： false：表示不放通。 true：表示放通。 file_redirection file_redirection object 文件重定向。 fd_mobile_client_redir_enable Boolean 移动客户端文件重定向：取值为： false：表示关闭。 true：表示开启。 clipboard_redirection String 剪切板重定向。取值为： DISABLED：表示禁用。（默认） SERVER_TO_CLIENT_ENABLED：表示开启服务端到客户端。 CLIENT_TO_SERVER_ENABLED：表示开启客户端到服务端。 TWO_WAY_ENABLED：表示开启双向。 clipboard_redirection_options clipboard_redirection_options object 剪切板重定向控制的选项。 表28 file_redirection 参数 参数类型 描述 redirection_mode String 文件重定向。取值为： DISABLED：表示禁用。（默认） READ_ONLY：表示只读。 READ_AND_WRITE：表示读写。 options FileRedirectionOptions object 文件重定向控制的选项。 vm_send_file_client Boolean 是否开启发送文件（虚机到客户端）。取值为： false：表示关闭。 true：表示开启。 redirection_send_file_options redirection_send_file_options object 重定向和发送文件共同控制项。 表29 FileRedirectionOptions 参数 参数类型 描述 fluid_control_switch_enable Boolean 是否开启流控开关。取值为： false：表示关闭。 true：表示开启。 fluid_control_options fluid_control_options object 流控控制项。 compression_switch_enable Boolean 是否开启压缩开关。取值为： false：表示关闭。 true：表示开启。 compression_switch_options compression_switch_options object 压缩开关控制项。 linux_file_size_supported_enable Boolean 是否开启Linux支持设置文件大小。取值为： false：表示关闭。 true：表示开启。 linux_file_size_supported_options linux_file_size_supported_options object Linux支持设置文件大小控制项。 linux_root_mount_switch_enable Boolean 是否开启Linux根目录挂载开关。取值为： false：表示关闭。 true：表示开启。 linux_root_dir_list String Linux根目录挂载路径。默认："\home"。 linux_file_mount_path String Linux文件系统挂载路径。默认："\media|\Volumes|\swdb\mnt|\home|\storage|\tmp|\run\media"。 linux_fixed_drive_file_system_format String Linux固定驱动器文件系统格式。 linux_removable_drive_file_system_format String Linux可移动驱动器文件系统格式。默认："vfat|ntfs|msdos|fuseblk|sdcardfs|exfat|fuse.fdredir"。 linux_cdrom_drive_file_system_format String Linux光盘驱动器文件系统格式。默认："cd9660|iso9660|udf"。 linux_network_drive_file_system_format String Linux网络驱动器文件系统格式。默认："smbfs|afpfs|cifs"。 path_separator String 路径分隔符。默认："|"。 fixed_drive_enable Boolean 是否开启固定驱动器（如: 本地磁盘）。取值为： false：表示关闭。 true：表示开启。 removable_drive_enable Boolean 是否开启可移除驱动器（如: U盘）。取值为： false：表示关闭。 true：表示开启。 cd_rom_drive_enable Boolean 是否开启光盘驱动器。取值为： false：表示关闭。 true：表示开启。 network_drive_enable Boolean 是否开启网络驱动器。取值为： false：表示关闭。 true：表示开启。 表30 fluid_control_options 参数 参数类型 描述 good_network_latency Integer 网络优的延时阈值（ms）。取值范围为[1-1000]。默认：30。 normal_network_latency Integer 网络一般的延时阈值（ms）。取值范围为[1-1000]。默认：70。 poor_network_latency Integer 网络差的延时阈值（ms）。取值范围为[1-1000]。默认：100。 reducing_step Integer 降速步伐（KB）。取值范围为[1-100]。默认：20。 slow_increasing_step Integer 慢增速步伐（KB）。取值范围为[1-100]。默认：10。 quick_increasing_step Integer 快增速步伐（KB）。取值范围为[1-100]。默认：20。 start_speed Integer 传输初始速度（KB/s）。取值范围为[1-10240]。默认：1024。 test_block_size Integer 测速块大小（KB）。取值范围为[64-1024]。默认：64。 test_time_gap Integer 测速块时间间隔（ms）。取值范围为[1000-100000]。默认：10000。 表31 compression_switch_options 参数 参数类型 描述 compression_threshold Integer 压缩阈值（Byte）。取值范围为[0-10240]。默认：512。 minimum_compression_rate Integer 最小压缩率。取值范围为[0-1000]。默认：900。 表32 linux_file_size_supported_options 参数 参数类型 描述 linux_file_size_supported_threshold Integer Linux设置文件大小阈值（Byte）。取值范围为[0-4096]。默认：100。 表33 redirection_send_file_options 参数 参数类型 描述 read_write_speed Integer 读写速度（Kbps）。取值范围为[0-2147483647]。默认：0。 表34 clipboard_redirection_options 参数 参数类型 描述 rich_text_redirection_enable Boolean 是否开启剪切板富文本重定向。取值为： false：表示关闭。 true：表示开启。 rich_text_clipboard_redirection String 剪切板富文本重定向。取值为： DISABLED：表示禁用。（默认） SERVER_TO_CLIENT_ENABLED：表示开启服务端到客户端。 CLIENT_TO_SERVER_ENABLED：表示开启客户端到服务端。 TWO_WAY_ENABLED：表示开启双向。 clipboard_file_redirection_enable Boolean 是否开启剪切板文件重定向。取值为： false：表示关闭。 true：表示开启。 file_clipboard_redirection String 剪切板文件重定向。取值为： DISABLED：表示禁用。（默认） SERVER_TO_CLIENT_ENABLED：表示开启服务端到客户端。 CLIENT_TO_SERVER_ENABLED：表示开启客户端到服务端。 TWO_WAY_ENABLED：表示开启双向。 clipboard_length_limit_cts_enable Boolean 本地到虚拟机长度限制开关。取值为： false: 标识关闭。 ture: 标识开启。 clipboard_length_limit_cts Integer 本地到虚拟机长度限制。 clipboard_length_limit_stc_enable Boolean 虚拟机到本地到长度限制开关。取值为： false: 标识关闭。 ture: 标识开启。 clipboard_length_limit_stc Integer 虚拟机到本地长度限制。 表35 Session 参数 参数类型 描述 sbc Sbc object SBC结构体。 表36 Sbc 参数 参数类型 描述 sbc_automatic_disconnection String 连接策略： DISABLED：已禁用 AUTO_DISCONNECT：自动断开 AUTO_LOCK：自动锁屏 sbc_automatic_disconnection_options SbcAutomaticDisconnectionOptions object 自动连接选项。 表37 SbcAutomaticDisconnectionOptions 参数 参数类型 描述 disconnection_waiting_time Integer 等待时间（分钟）。 sbc_auto_logout Boolean 是否自动注销。取值为：false：表示是。true：表示否。 auto_logout_options AutoLogoutOptions object 自动注销。 表38 AutoLogoutOptions 参数 参数类型 描述 sbc_logout_waiting_time Integer 会话断连保留时长（分钟）。 表39 VirtualChannel 参数 参数类型 描述 virtual_channel_control_enable Boolean 是否开启虚拟通道策略设置。取值为：false：表示关闭。true：表示开启。 options VirtualChannelOptions object 虚拟通道策略控制的选项。 表40 VirtualChannelOptions 参数 参数类型 描述 custom_virtual_channel_name String 自定义虚拟通道注册名。 virtual_channel_plugin_details String 虚拟通道下载配置信息，需Base64加密。 third_party_plugin_name String 第三方插件名称。 表41 keyboard_mouse 参数 参数类型 描述 mouse_feedback String 虚拟机鼠标回馈。取值为： SELFADAPTION：自适应鼠标回馈。 FORCE：强制鼠标回馈。 CLOSE：关闭鼠标回馈。 mouse_simulation_mode String 虚拟机鼠标模拟方式。取值为： ABSOLUTE_POSITION：绝对位置模拟。 RELATIVE_POSITION：相对位置模拟。 external_cursor_feedback Boolean 虚拟机外部光标反馈。取值为： false：表示关闭。 true：表示开启。 表42 Bandwidth 参数 参数类型 描述 intelligent_data_transport_flag String 智能显示传输。取值为：DISABLE：表示关闭。ENABLE：表示开启。DIAGNOSTIC：诊断模式。 total_bandwidth_control_enable Boolean 是否开启总带宽控制。取值为：false：表示关闭。true：表示开启。 options TotalBandwidthControlOptions object 总带宽控制的选项。 display_bandwidth_control_enable Boolean 是否开启显示带宽控制。取值为：false：表示关闭。true：表示开启。 display_bandwidth_control_options DisplayBandwidthControlOptions object 显示带宽控制的选项。 multimedia_bandwidth_control_enable Boolean 是否开启多媒体带宽控制。取值为：false：表示关闭。true：表示开启。 multimedia_bandwidth_control_options MultimediaBandwidthControlOptions object 多媒体带宽控制的选项。 usb_bandwidth_control_enable Boolean 是否开启USB带宽控制。取值为：false：表示关闭。true：表示开启。 usb_bandwidth_control_options UsbBandwidthControlOptions object USB带宽控制的选项。 pcsc_bandwidth_control_enable Boolean 是否开启P CS C控制。取值为：false：表示关闭。true：表示开启。 pcsc_bandwidth_control_options PcscBandwidthControlOptions object PCSC带宽控制的选项。 twain_bandwidth_control_enable Boolean 是否开启TWAIN带宽控制。取值为：false：表示关闭。true：表示开启。 twain_bandwidth_control_options TwainBandwidthControlOptions object TWAIN带宽控制的选项。 printer_bandwidth_control_enable Boolean 是否开启打印机带宽控制。取值为：false：表示关闭。true：表示开启。 printer_bandwidth_control_options PrinterBandwidthControlOptions object 打印机带宽控制的选项。 com_bandwidth_control_enable Boolean 是否开启串口带宽控制。取值为：false：表示关闭。true：表示开启。 com_bandwidth_control_options ComBandwidthControlOptions object 串口带宽控制的选项。 file_redirection_bandwidth_control_enable Boolean 是否开启文件重定向带宽控制。取值为：false：表示关闭。true：表示开启。 file_redirection_bandwidth_control_options FileRedirectionBandwidthControlOptions object 文件重定向带宽控制的选项。 clipboard_bandwidth_control_enable Boolean 是否开启剪切板带宽控制。取值为：false：表示关闭。true：表示开启。 clipboard_bandwidth_control_options ClipboardBandwidthControlOptions object 剪切板带宽控制的选项。 secure_channel_bandwidth_control_enable Boolean 是否开启安全通道带宽控制。取值为：false：表示关闭。true：表示开启。 secure_channel_bandwidth_control_options SecureChannelBandwidthControlOptions object 安全通道带宽控制的选项。 camera_bandwidth_control_enable Boolean 是否开启摄像头带宽控制。取值为：false：表示关闭。true：表示开启。 camera_bandwidth_control_options CameraBandwidthControlOptions object 摄像头带宽控制的选项。 virtual_channel_bandwidth_control_enable Boolean 是否开启虚拟通道带宽控制。取值为：false：表示关闭。true：表示开启。 virtual_channel_bandwidth_control_options VirtualChannelBandwidthControlOptions object 虚拟通道带宽控制的选项。 表43 TotalBandwidthControlOptions 参数 参数类型 描述 total_bandwidth_control_value Integer 总带宽控制量（Kbps）。取值范围为[10000-1000000]。默认：30000。 display_bandwidth_percentage_enable Boolean 显示带宽百分比控制。取值为：false：表示关闭。true：表示开启。 display_bandwidth_percentage_options DisplayBandwidthPercentageOptions object 显示带宽百分比控制的选项。 multimedia_bandwidth_percentage_enable Boolean 多媒体带宽百分比控制。取值为：false：表示关闭。true：表示开启。 multimedia_bandwidth_percentage_options MultimediaBandwidthPercentageOptions object 多媒体带宽百分比控制的选项。 usb_bandwidth_percentage_enable Boolean USB带宽百分比控制。取值为：false：表示关闭。true：表示开启。 usb_bandwidth_percentage_options UsbBandwidthPercentageOptions object USB带宽百分比控制的选项。 pcsc_bandwidth_percentage_enable Boolean PCSC带宽百分比控制。取值为：false：表示关闭。true：表示开启。 pcsc_bandwidth_percentage_options PcscBandwidthPercentageOptions object PCSC带宽百分比控制的选项。 twain_bandwidth_percentage_enable Boolean TWAIN带宽百分比控制。取值为：false：表示关闭。true：表示开启。 twain_bandwidth_percentage_options TwainBandwidthPercentageOptions object TWAIN带宽百分比控制的选项。 printer_bandwidth_percentage_enable Boolean 打印机带宽百分比控制。取值为：false：表示关闭。true：表示开启。 printer_bandwidth_percentage_options PrinterBandwidthPercentageOptions object 打印机带宽百分比控制的选项。 com_bandwidth_percentage_enable Boolean 串口带宽百分比控制。取值为：false：表示关闭。true：表示开启。 com_bandwidth_percentage_options ComBandwidthPercentageOptions object 串口带宽百分比控制的选项。 file_redirection_bandwidth_percentage_enable Boolean 文件重定向带宽百分比控制。取值为：false：表示关闭。true：表示开启。 file_redirection_bandwidth_percentage_options FileRedirectionBandwidthPercentageOptions object 文件重定向带宽百分比控制的选项。 clipboard_bandwidth_percentage_enable Boolean 剪切板带宽百分比控制。取值为：false：表示关闭。true：表示开启。 clipboard_bandwidth_percentage_options ClipboardBandwidthPercentageOptions object 剪切板带宽百分比控制的选项。 secure_channel_bandwidth_percentage_enable Boolean 安全通道带宽百分比控制。取值为：false：表示关闭。true：表示开启。 secure_channel_bandwidth_percentage_options SecureChannelBandwidthPercentageOptions object 安全通道带宽百分比控制的选项。 camera_bandwidth_percentage_enable Boolean 摄像头带宽百分比控制。取值为：false：表示关闭。true：表示开启。 camera_bandwidth_percentage_options CameraBandwidthPercentageOptions object 摄像头带宽百分比控制的选项。 virtual_channel_bandwidth_percentage_enable Boolean 虚拟通道带宽百分比控制。取值为：false：表示关闭。true：表示开启。 virtual_channel_bandwidth_percentage_options VirtualChannelBandwidthPercentageOptions object 虚拟通道带宽百分比控制的选项。 表44 DisplayBandwidthPercentageOptions 参数 参数类型 描述 display_bandwidth_percentage_value Integer 显示带宽百分比控制量（%）。取值范围为[0-100]。默认：65。 表45 MultimediaBandwidthPercentageOptions 参数 参数类型 描述 multimedia_bandwidth_percentage_value Integer 多媒体带宽百分比控制量（%）。取值范围为[0-100]。默认：50。 表46 UsbBandwidthPercentageOptions 参数 参数类型 描述 usb_bandwidth_percentage_value Integer USB带宽百分比控制量（%）。取值范围为[0-100]。默认：100。 表47 PcscBandwidthPercentageOptions 参数 参数类型 描述 pcsc_bandwidth_percentage_value Integer PCSC带宽百分比控制量（%）。取值范围为[0-100]。默认：5。 表48 TwainBandwidthPercentageOptions 参数 参数类型 描述 twain_bandwidth_percentage_value Integer TWAIN带宽百分比控制量（%）。取值范围为[0-100]。默认：15。 表49 PrinterBandwidthPercentageOptions 参数 参数类型 描述 printer_bandwidth_percentage_value Integer 打印机带宽百分比控制量（%）。取值范围为[0-100]。默认：5。 表50 ComBandwidthPercentageOptions 参数 参数类型 描述 com_bandwidth_percentage_value Integer 串口带宽百分比控制量（%）。取值范围为[0-100]。默认：3。 表51 FileRedirectionBandwidthPercentageOptions 参数 参数类型 描述 file_redirection_bandwidth_percentage_value Integer 文件重定向带宽百分比控制量（%）。取值范围为[0-100]。默认：30。 表52 ClipboardBandwidthPercentageOptions 参数 参数类型 描述 clipboard_bandwidth_percentage_value Integer 剪切板带宽百分比控制量（%）。取值范围为[0-100]。默认：3。 表53 SecureChannelBandwidthPercentageOptions 参数 参数类型 描述 secure_channel_bandwidth_percentage_value Integer 安全通道带宽百分比控制量（%）。取值范围为[0-100]。默认：30。 表54 CameraBandwidthPercentageOptions 参数 参数类型 描述 camera_bandwidth_percentage_value Integer 摄像头带宽百分比控制量（%）。取值范围为[0-100]。默认：30。 表55 VirtualChannelBandwidthPercentageOptions 参数 参数类型 描述 virtual_channel_bandwidth_percentage_value Integer 虚拟通道带宽百分比控制量（%）。取值范围为[0-100]。默认：65。 表56 DisplayBandwidthControlOptions 参数 参数类型 描述 display_bandwidth_control_value Integer 显示带宽控制量（Kbps）。取值范围为[500-50000]。默认：20000。 表57 MultimediaBandwidthControlOptions 参数 参数类型 描述 multimedia_bandwidth_control_value Integer 多媒体带宽控制量（Kbps）。取值范围为[5000-20000]。默认：15000。 表58 UsbBandwidthControlOptions 参数 参数类型 描述 usb_bandwidth_control_value Integer USB带宽控制量（Kbps）。取值范围为[1000-30000]。默认：30000。 表59 PcscBandwidthControlOptions 参数 参数类型 描述 pcsc_bandwidth_control_value Integer PCSC带宽控制量（Kbps）。取值范围为[1000-5000]。默认：2000。 表60 TwainBandwidthControlOptions 参数 参数类型 描述 twain_bandwidth_control_value Integer TWAIN带宽控制量（Kbps）。取值范围为[2000-10000]。默认：5000。 表61 PrinterBandwidthControlOptions 参数 参数类型 描述 printer_bandwidth_control_value Integer 打印机带宽控制量（Kbps）。取值范围为[1000-5000]。默认：2000。 表62 ComBandwidthControlOptions 参数 参数类型 描述 com_bandwidth_control_value Integer 串口带宽控制量（Kbps）。取值范围为[500-2000]。默认：1000。 表63 FileRedirectionBandwidthControlOptions 参数 参数类型 描述 file_redirection_bandwidth_control_value Integer 文件重定向带宽控制量（Kbps）。取值范围为[500-20000]。默认：10000。 表64 ClipboardBandwidthControlOptions 参数 参数类型 描述 clipboard_bandwidth_control_value Integer 剪切板带宽控制量（Kbps）。取值范围为[100-2000]。默认：1000。 表65 SecureChannelBandwidthControlOptions 参数 参数类型 描述 secure_channel_bandwidth_control_value Integer 安全通道带宽控制量（Kbps）。取值范围为[500-20000]。默认：10000。 表66 CameraBandwidthControlOptions 参数 参数类型 描述 camera_bandwidth_control_value Integer 摄像头带宽控制量（Kbps）。取值范围为[0-10000]。默认：10000。 表67 VirtualChannelBandwidthControlOptions 参数 参数类型 描述 virtual_channel_bandwidth_control_value Integer 虚拟通道带宽控制量（Kbps）。取值范围为[500-20000]。默认：20000。 表68 custom 参数 参数类型 描述 custom_configuration1_enable Boolean 自定义策略配置项1： false: 表示关闭 true: 表示开启 options CustomOptions object 自定义策略设置项。 表69 CustomOptions 参数 参数类型 描述 custom_configuration1_rule String 配置项1内容。 rail_transparent_config RailTransparentConfig object 应用镜像策略设置项。 表70 RailTransparentConfig 参数 参数类型 描述 select_policy Integer 策略选值原则。 transparent_list_custom String 配置项内容。 表71 cloud_storage 参数 参数类型 描述 cloud_storage_enable Boolean 云存储配置开关： false: 表示关闭 true: 表示开启 options CloudStorageOptions object 云存储配置。 表72 CloudStorageOptions 参数 参数类型 描述 cloud_storage_rule String 配置项内容。 表73 user_profile 参数 参数类型 描述 user_profile_enable Boolean 配置文件漫游技术配置开关： false: 表示关闭 true: 表示开启 options UpmOptions object 配置文件漫游技术配置。 表74 UpmOptions 参数 参数类型 描述 user_profile_rule String 配置项内容。 redir_exclude_common_folders String 排除常用文件夹。 redir_exclude_copy0s String 禁止自定义文件夹/copy base = 0,copy back = 0。 redir_exclude_copy1s String 禁止自定义文件夹/copy base = 0,copy back = 1。 redir_exclude_copy2s String 禁止自定义文件夹/copy base = 1,copy back = 0。 redir_exclude_copy3s String 禁止自定义文件夹/copy base = 1,copy back = 1。 redir_exclude_includes String 允许自定义文件夹 状态码：400 表75 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：401 表76 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：403 表77 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：404 表78 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：405 表79 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：500 表80 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：503 表81 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。