华为云用户手册

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 config_infos Array of CorpConfigInfo objects 批量配置项列表。 表5 CorpConfigInfo 参数 参数类型 描述 config_key String 查询的配置configKey。 config_value String 根据configKey查到的configValue。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 503 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

响应示例 状态码： 200 包周期桌面池批量询价响应体。 { "currency" : "string", "cloud_service_rating_results" : [ { "order_request_id" : "string", "official_website_rating_result" : { "amount" : 0, "official_website_amount" : 0, "original_amount" : 0, "official_website_discount_amount" : 0, "optional_discount_amount" : 0, "discount_amount" : 0, "per_amount" : 0, "per_discount_amount" : 0, "per_original_amount" : 0, "per_period_type" : 0, "measure_id" : 0, "product_rating_results" : [ { "id" : "string", "product_id" : "string", "amount" : 0, "discount_amount" : 0, "original_amount" : 0, "official_website_amount" : 0, "official_website_discount_amount" : 0, "optional_discount_amount" : 0, "per_amount" : 0, "per_discount_amount" : 0, "per_original_amount" : 0, "per_official_website_amount" : 0, "per_official_website_discount_amount" : 0, "per_optional_discount_amount" : 0, "per_period_type" : 0, "measure_id" : 0, "extend_params" : "string" } ] }, "optional_discount_rating_results" : [ { "discount_id" : "string", "amount" : 0, "official_website_amount" : 0, "original_amount" : 0, "official_website_discount_amount" : 0, "optional_discount_amount" : 0, "discount_amount" : 0, "per_amount" : 0, "per_discount_amount" : 0, "per_original_amount" : 0, "per_official_website_amount" : 0, "per_official_website_discount_amount" : 0, "per_optional_discount_amount" : 0, "per_period_type" : 0, "measure_id" : 0, "discount_type" : 0, "discount_name" : "string", "best_offer" : 0, "same_ratio_flag" : 0, "discount_ratio" : 0, "promotion_info" : "string", "product_rating_results" : [ { "id" : "string", "product_id" : "string", "amount" : 0, "discount_amount" : 0, "original_amount" : 0, "official_website_amount" : 0, "official_website_discount_amount" : 0, "optional_discount_amount" : 0, "per_amount" : 0, "per_discount_amount" : 0, "per_original_amount" : 0, "per_official_website_amount" : 0, "per_official_website_discount_amount" : 0, "per_optional_discount_amount" : 0, "per_period_type" : 0, "measure_id" : 0, "extend_params" : "string" } ] } ] } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 currency String 币种，比如CNY。 cloud_service_rating_results Array of CloudServiceRatingResult objects 询价结果。 表5 CloudServiceRatingResult 参数 参数类型 描述 order_request_id String 下单请求体中的orderRequestId。 official_website_rating_result OfficialWebsiteRatingResult object 结果。 optional_discount_rating_results Array of OptionalDiscountRatingResult objects 优惠询价结果。 表6 OfficialWebsiteRatingResult 参数 参数类型 描述 amount Number 订单总额，即最终优惠后的订单金额(预留实例只包含预付部分)。 official_website_amount Number 官网价(预留实例只包含预付部分)。 original_amount Number 订单原总额，即优惠前订单总额(预留实例只包含预付部分)。 official_website_discount_amount Number 官网价优惠额(预留实例只包含预付部分)。 optional_discount_amount Number 可选折扣优惠额(预留实例只包含预付部分)。 discount_amount Number 总优惠额(预留实例只包含预付部分)。 per_amount Number 总分期金额(批量询价的商品分期周期类型一致，才会有总分期金额，分期周期类型不一致，该信息没有)。 per_discount_amount Number 总分期金额的优惠额(perDiscountAmount = perOriginalAmount - perAmount)。 per_original_amount Number 总分期金额原价。 per_period_type Integer 分期周期类型 2:月 4:小时。 measure_id Integer 度量单位。 product_rating_results Array of ProductResult objects 产品询价结果。 表7 OptionalDiscountRatingResult 参数 参数类型 描述 discount_id String 折扣优惠Id。 amount Number 订单总额，即最终优惠后的订单金额(预留实例只包含预付部分)。 official_website_amount Number 官网价(预留实例只包含预付部分)。 original_amount Number 订单原总额，即优惠前订单总额(预留实例只包含预付部分)。 official_website_discount_amount Number 官网价优惠额(预留实例只包含预付部分)。 optional_discount_amount Number 可选折扣优惠额(预留实例只包含预付部分)。 discount_amount Number 总优惠额(预留实例只包含预付部分)。 per_amount Number 总分期金额(批量询价的商品分期周期类型一致，才会有总分期金额，分期周期类型不一致，该信息没有)。 per_discount_amount Number 总分期金额的优惠额(perDiscountAmount = perOriginalAmount - perAmount)。 per_original_amount Number 总分期金额原价。 per_official_website_amount Number 总分期金额的官网价(批量询价的商品分期周期类型一致，才会有总分期金额的官网价，分期周期类型不一致，该信息没有)。 per_official_website_discount_amount Number 总分期金额的官网价官网价优惠额，即： perOfficialWebsiteDiscountAmount =perOriginalAmount-perOfficialWebsiteAmount (批量询价的商品分期周期类型一致，才会有总分期金额的官网价，分期周期类型不一致，该信息没有)。 per_optional_discount_amount Number 总分期金额的可选折扣优惠额，如商务折扣、伙伴折扣、促销折扣和折扣券选用时的优惠额 perOptionalDiscountAmount= perOfficialWebsiteAmount- perAmount (批量询价的商品分期周期类型一致，才会有总分期金额的官网价，分期周期类型不一致，该信息没有)。 per_period_type Integer 分期周期类型 2:月 4:小时。 measure_id Integer 度量单位。 discount_type Integer 折扣优惠类型。 discount_name String 折扣名称。 best_offer Integer 是否为最优折扣0：不是最优折扣；为缺省值。1：是最优折扣；最优折扣：在商务折扣、伙伴折扣和促销折扣中选择（优惠金额相等则按此顺序排优先级），折扣券不参与最优折扣的计算。 same_ratio_flag Integer sameRatioFlag。 discount_ratio Number sameRatioFlag为1时有值，表示该折扣的折扣率。 promotion_info String 折扣优惠基本信息；调用者在确定好折扣优惠后、下单时，使用此字段值，填入到订购/变更接口中的promotionInfo字段。 product_rating_results Array of ProductResult objects 产品询价结果。 表8 ProductResult 参数 参数类型 描述 id String 对应请求体中的ID。 product_id String 产品ID。 amount Number 总额，即最终优惠后的金额(预留实例只包含预付部分)。 discount_amount Number 优惠额(预留实例只包含预付部分)。 original_amount Number 原总额，即优惠前总额(预留实例只包含预付部分)。 official_website_amount Number 官网价（非所有接口有该字段）(预留实例只包含预付部分)。 official_website_discount_amount Number 官网价优惠额（非所有接口有该字段）(预留实例只包含预付部分)。 optional_discount_amount Number 可选折扣优惠额(预留实例只包含预付部分)，如商务折扣、伙伴折扣、促销折扣和折扣券选用时的优惠额（非所有接口有该字段）。 per_amount Number 总分期金额(批量询价的商品分期周期类型一致，才会有总分期金额，分期周期类型不一致，该信息没有)。 per_discount_amount Number 总分期金额的优惠额(perDiscountAmount = perOriginalAmount - perAmount)。 per_original_amount Number 总分期金额原价。 per_official_website_amount Number 分期金额的官网价。 per_official_website_discount_amount Number 分期金额的官网价官网价优惠额，即：perOfficialWebsiteDiscountAmount =perOriginalAmount-perOfficialWebsiteAmount。 per_optional_discount_amount Number 分期金额的可选折扣优惠额，如商务折扣、伙伴折扣、促销折扣和折扣券选用时的优惠额 perOptionalDiscountAmount= perOfficialWebsiteAmount- perAmount。 per_period_type Integer 分期周期类型 2:月 4:小时。 measure_id Integer 度量单位。 extend_params String 扩展参数。 状态码： 400 表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接口进行解密。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 否 String 发送的实体的MIME类型。 表3 请求Body参数 参数 是否必选 参数类型 描述 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。

URI GET /v2/{project_id}/connections/desktops/export 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 start_time 否 String 查询的起始时间。指定该参数后，返回的结果为此时间之后的所有登录记录。时间格式如：“2016-08-20T21:11Z”。终止时间不为空时，起始时间为必填参数。 end_time 否 String 查询的终止时间。指定该参数后，返回的结果为此时间之前的所有登录记录。时间格式如：“2016-08-20T21:11Z”。起始时间不为空时，终止时间为必填参数。 user_name 否 String 登录桌面的用户名。 computer_name 否 String 计算机名（操作系统信息中可见）。 terminal_type 否 String 登录桌面的终端系统类型。 language 否 String 导出语言，默认英文。 zh_CN：中文 en_US：英文

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

URI GET /v2/{project_id}/desktops/online-users 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 start_time 否 String 查询的起始时间。指定该参数后，返回的结果为此时间之后的所有登录记录。时间格式如：“2016-08-20T21:11Z”。终止时间不为空时，起始时间为必填参数 end_time 否 String 查询的终止时间。指定该参数后，返回的结果为此时间之前的所有登录记录。时间格式如：“2016-08-20T21:11Z”。起始时间不为空时，终止时间为必填参数 query_type 否 String 查询类型，合法取值有三个:MONTH按月查询 WEEK：按周查询DAY：按天查询。 client_hour 否 Integer 客户端所在操作系统时间的小时数。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 time_counts Array of strings 返回前端历史登录信息。查询的时间和计数之间用冒号分隔。查询的时间，按Day查询或时间段在同一天时，按小时计数，其他场景为按天计数。 状态码： 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 成功响应。 { "count" : 0, "items" : [ { "name" : "user-file-persistent", "location" : "https://sfs-tmp.****.huawei.com:/sfs-tmp", "usage" : 1024, "create_time" : "2024-12-25T12:19:03.229Z" } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 count Integer 总数。 items Array of Sfs3Storage objects 存储列表。 表4 Sfs3Storage 参数 参数类型 描述 name String 文件系统名称。 location String 挂载地址。 usage String 存储使用量(Byte)。 create_time String 创建时间。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 405 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 503 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

响应示例 状态码： 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" : 60, "video_frame_rate" : 60, "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" : "Bandwidth 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" : true, "rendering_acceleration_options" : { "video_acceleration_enhancement_enable" : true, "video_optimization_enable" : true, "gpu_color_optimization_enable" : true }, "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", "clipboard_length_limit_cts_enable" : false, "clipboard_length_limit_cts" : 0, "clipboard_length_limit_stc_enable" : false, "clipboard_length_limit_stc" : 0 } }, "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" : 60 } } } }, "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 表4 响应Body参数 参数 参数类型 描述 policies Policies object 策略类。 表5 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 自定义策略。 表6 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 串口重定向。 表7 usb_port_redirection 参数 参数类型 描述 usb_enable Boolean 是否开启USB端口重定向。取值为： false：表示关闭。 true：表示开启。 options UsbPortRedirectionOptions object USB端口重定向控制的选项。 表8 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：通用模式。 表9 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。 表10 printer_redirection 参数 参数类型 描述 printer_enable Boolean 是否开启打印机设备重定向。取值为： false：表示关闭。 true：表示开启。 options PrinterRedirectionOptions object 打印机设备重定向控制的选项。 表11 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。 表12 session_printer 参数 参数类型 描述 session_printer_enable Boolean 是否开启会话打印机。取值为： false：表示关闭。 true：表示开启。 options SessionPrinterOptions object 会话打印机控制选项。 表13 SessionPrinterOptions 参数 参数类型 描述 session_printer_customization_policy String 会话打印机自定义策略。 表14 camera_redirection 参数 参数类型 描述 video_compress_enable Boolean 是否开启摄像头设备重定向。取值为： false：表示关闭。 true：表示开启。 options CameraRedirectionOptions object 摄像头设备重定向控制的选项。 表15 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。 表16 usb_device_common 参数 参数类型 描述 pcsc_smart_card_enable String 是否开启PC/SC智能卡重定向。取值为： Enable：表示已启动。 Closed：表示已关闭。 Disable：表示已禁用。 common_options common_options object USB和设备智能卡共同控制的选项。 表17 common_options 参数 参数类型 描述 remove_smart_card_disconnect_enable Boolean 是否移除智能卡断开用户会话。取值为： false：表示关闭。 true：表示开启。 表18 serial_port_redirection 参数 参数类型 描述 serial_port_enable Boolean 是否开启串口重定向。取值为： false：表示关闭。 true：表示开启。 options SerialPortRedirectionOptions object 串口重定向控制的选项。 表19 SerialPortRedirectionOptions 参数 参数类型 描述 auto_connect_enable Boolean 是否自动连接客户端串口。取值为： false：表示关闭。 true：表示开启。 表20 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。 表21 client 参数 参数类型 描述 automatic_reconnection_interval Integer 自动重连间隔（秒）。取值范围为[1-50]。默认：5。 session_persistence_time Integer 自动重连会话保持时长（秒）。取值范围为[0-180]。默认：180。 forbid_screen_capture Boolean 防截屏策略开关。 false：表示关闭。 true：表示开启。 表22 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：表示开启。 表23 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。 表24 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 表25 video_bit_rate_options 参数 参数类型 描述 average_video_bit_rate Integer 视频平均码率（Kbps）。取值范围为[256-100000]。默认：18000。 表26 video_quality_options 参数 参数类型 描述 average_video_quality Integer 视频平均质量。取值范围为[5-59]。默认：15。 lowest_video_quality Integer 视频最低质量。取值范围为[5-69]。默认：25。 highest_video_quality Integer 视频最高质量。取值范围为[1-59]。默认：7。 表27 rendering_acceleration_options 参数 参数类型 描述 video_acceleration_enhancement_enable Boolean 视频加速增强配置。取值为： false：表示关闭。 true：表示开启。 video_optimization_enable Boolean 是否开启视频场景优化。取值为： false：表示关闭。 true：表示开启。 gpu_color_optimization_enable Boolean 是否开启GPU色彩优化。取值为： false：表示关闭。 true：表示开启。 表28 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 剪切板重定向控制的选项。 表29 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 重定向和发送文件共同控制项。 表30 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：表示开启。 表31 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。 表32 compression_switch_options 参数 参数类型 描述 compression_threshold Integer 压缩阈值（Byte）。取值范围为[0-10240]。默认：512。 minimum_compression_rate Integer 最小压缩率。取值范围为[0-1000]。默认：900。 表33 linux_file_size_supported_options 参数 参数类型 描述 linux_file_size_supported_threshold Integer Linux设置文件大小阈值（Byte）。取值范围为[0-4096]。默认：100。 表34 redirection_send_file_options 参数 参数类型 描述 read_write_speed Integer 读写速度（Kbps）。取值范围为[0-2147483647]。默认：0。 表35 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 虚拟机到本地长度限制。 表36 Session 参数 参数类型 描述 sbc Sbc object SBC结构体。 表37 Sbc 参数 参数类型 描述 sbc_automatic_disconnection String 连接策略： DISABLED：已禁用 AUTO_DISCONNECT：自动断开 AUTO_LOCK：自动锁屏 sbc_automatic_disconnection_options SbcAutomaticDisconnectionOptions object 自动连接选项。 表38 SbcAutomaticDisconnectionOptions 参数 参数类型 描述 disconnection_waiting_time Integer 等待时间（分钟）。 sbc_auto_logout Boolean 是否自动注销。取值为：false：表示是。true：表示否。 auto_logout_options AutoLogoutOptions object 自动注销。 表39 AutoLogoutOptions 参数 参数类型 描述 sbc_logout_waiting_time Integer 会话断连保留时长（分钟）。 表40 VirtualChannel 参数 参数类型 描述 virtual_channel_control_enable Boolean 是否开启虚拟通道策略设置。取值为：false：表示关闭。true：表示开启。 options VirtualChannelOptions object 虚拟通道策略控制的选项。 表41 VirtualChannelOptions 参数 参数类型 描述 custom_virtual_channel_name String 自定义虚拟通道注册名。 virtual_channel_plugin_details String 虚拟通道下载配置信息，需Base64加密。 third_party_plugin_name String 第三方插件名称。 表42 keyboard_mouse 参数 参数类型 描述 mouse_feedback String 虚拟机鼠标回馈。取值为： SELFADAPTION：自适应鼠标回馈。 FORCE：强制鼠标回馈。 CLOSE：关闭鼠标回馈。 mouse_simulation_mode String 虚拟机鼠标模拟方式。取值为： ABSOLUTE_POSITION：绝对位置模拟。 RELATIVE_POSITION：相对位置模拟。 external_cursor_feedback Boolean 虚拟机外部光标反馈。取值为： false：表示关闭。 true：表示开启。 表43 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 虚拟通道带宽控制的选项。 表44 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 虚拟通道带宽百分比控制的选项。 表45 DisplayBandwidthPercentageOptions 参数 参数类型 描述 display_bandwidth_percentage_value Integer 显示带宽百分比控制量（%）。取值范围为[0-100]。默认：65。 表46 MultimediaBandwidthPercentageOptions 参数 参数类型 描述 multimedia_bandwidth_percentage_value Integer 多媒体带宽百分比控制量（%）。取值范围为[0-100]。默认：50。 表47 UsbBandwidthPercentageOptions 参数 参数类型 描述 usb_bandwidth_percentage_value Integer USB带宽百分比控制量（%）。取值范围为[0-100]。默认：100。 表48 PcscBandwidthPercentageOptions 参数 参数类型 描述 pcsc_bandwidth_percentage_value Integer PCSC带宽百分比控制量（%）。取值范围为[0-100]。默认：5。 表49 TwainBandwidthPercentageOptions 参数 参数类型 描述 twain_bandwidth_percentage_value Integer TWAIN带宽百分比控制量（%）。取值范围为[0-100]。默认：15。 表50 PrinterBandwidthPercentageOptions 参数 参数类型 描述 printer_bandwidth_percentage_value Integer 打印机带宽百分比控制量（%）。取值范围为[0-100]。默认：5。 表51 ComBandwidthPercentageOptions 参数 参数类型 描述 com_bandwidth_percentage_value Integer 串口带宽百分比控制量（%）。取值范围为[0-100]。默认：3。 表52 FileRedirectionBandwidthPercentageOptions 参数 参数类型 描述 file_redirection_bandwidth_percentage_value Integer 文件重定向带宽百分比控制量（%）。取值范围为[0-100]。默认：30。 表53 ClipboardBandwidthPercentageOptions 参数 参数类型 描述 clipboard_bandwidth_percentage_value Integer 剪切板带宽百分比控制量（%）。取值范围为[0-100]。默认：3。 表54 SecureChannelBandwidthPercentageOptions 参数 参数类型 描述 secure_channel_bandwidth_percentage_value Integer 安全通道带宽百分比控制量（%）。取值范围为[0-100]。默认：30。 表55 CameraBandwidthPercentageOptions 参数 参数类型 描述 camera_bandwidth_percentage_value Integer 摄像头带宽百分比控制量（%）。取值范围为[0-100]。默认：30。 表56 VirtualChannelBandwidthPercentageOptions 参数 参数类型 描述 virtual_channel_bandwidth_percentage_value Integer 虚拟通道带宽百分比控制量（%）。取值范围为[0-100]。默认：65。 表57 DisplayBandwidthControlOptions 参数 参数类型 描述 display_bandwidth_control_value Integer 显示带宽控制量（Kbps）。取值范围为[500-50000]。默认：20000。 表58 MultimediaBandwidthControlOptions 参数 参数类型 描述 multimedia_bandwidth_control_value Integer 多媒体带宽控制量（Kbps）。取值范围为[5000-20000]。默认：15000。 表59 UsbBandwidthControlOptions 参数 参数类型 描述 usb_bandwidth_control_value Integer USB带宽控制量（Kbps）。取值范围为[1000-30000]。默认：30000。 表60 PcscBandwidthControlOptions 参数 参数类型 描述 pcsc_bandwidth_control_value Integer PCSC带宽控制量（Kbps）。取值范围为[1000-5000]。默认：2000。 表61 TwainBandwidthControlOptions 参数 参数类型 描述 twain_bandwidth_control_value Integer TWAIN带宽控制量（Kbps）。取值范围为[2000-10000]。默认：5000。 表62 PrinterBandwidthControlOptions 参数 参数类型 描述 printer_bandwidth_control_value Integer 打印机带宽控制量（Kbps）。取值范围为[1000-5000]。默认：2000。 表63 ComBandwidthControlOptions 参数 参数类型 描述 com_bandwidth_control_value Integer 串口带宽控制量（Kbps）。取值范围为[500-2000]。默认：1000。 表64 FileRedirectionBandwidthControlOptions 参数 参数类型 描述 file_redirection_bandwidth_control_value Integer 文件重定向带宽控制量（Kbps）。取值范围为[500-20000]。默认：10000。 表65 ClipboardBandwidthControlOptions 参数 参数类型 描述 clipboard_bandwidth_control_value Integer 剪切板带宽控制量（Kbps）。取值范围为[100-2000]。默认：1000。 表66 SecureChannelBandwidthControlOptions 参数 参数类型 描述 secure_channel_bandwidth_control_value Integer 安全通道带宽控制量（Kbps）。取值范围为[500-20000]。默认：10000。 表67 CameraBandwidthControlOptions 参数 参数类型 描述 camera_bandwidth_control_value Integer 摄像头带宽控制量（Kbps）。取值范围为[0-10000]。默认：10000。 表68 VirtualChannelBandwidthControlOptions 参数 参数类型 描述 virtual_channel_bandwidth_control_value Integer 虚拟通道带宽控制量（Kbps）。取值范围为[500-20000]。默认：20000。 表69 custom 参数 参数类型 描述 custom_configuration1_enable Boolean 自定义策略配置项1： false: 表示关闭 true: 表示开启 options CustomOptions object 自定义策略设置项。 表70 CustomOptions 参数 参数类型 描述 custom_configuration1_rule String 配置项1内容。 状态码： 400 表71 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 401 表72 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 403 表73 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 404 表74 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 405 表75 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 500 表76 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 503 表77 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

URI GET /v1/{project_id}/policy-groups/{policy_group_id}/policy 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 policy_group_id 是 String 策略组id。 表2 Query参数 参数 是否必选 参数类型 描述 policy_type 否 String 根据策略类型过滤结果，不传则查询所有策略。 可选类型: 外设：Peripherals; 音频：Audio; 客户端：Client; 显示：Display; 文件与剪切板：FileAndClip; 接入控制：ClientAccessControl; 会话：SessionAutoDisconnect; 虚拟通道：VirtualChannel 水印：Watermark; 键盘鼠标：KeyboardAndMouse; 通用音视频旁路：Seamless。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 function_configs Array of FunctionConfig objects 租户个性配置列表。 表5 FunctionConfig 参数 参数类型 描述 id String 功能配置id。 name String 功能配置名称。 status String 功能配置开关的状态，表示开启还是关闭 ON/OFF。 - ON： 开启该功能 - OFF： 关闭该功能。 values Array of MapObject objects 配置项列表，键值对格式。 表6 MapObject 参数 参数类型 描述 key String 配置项的键。 value String 配置项对应的值。 状态码： 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 表4 响应Body参数 参数 参数类型 描述 count Integer 总数。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 405 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 503 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

URI GET /v1/{project_id}/app-server-sub-jobs/actions/count 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目唯一标识。 表2 Query参数 参数 是否必选 参数类型 描述 status 否 String job详情的状态： WAITING - 等待 RUNNING - 运行中 SUC CES S - 成功 FAILED - 失败 ABNORMAL - 异常 ROLLBACK - 回滚中 ABORTING - 取消 job_type 否 String 任务类型，传入多个任务类型的时候将任务类型用英文逗号(,)进行分隔。 job_id 否 String 任务ID。

响应示例 状态码： 200 成功响应。 { "count" : 0, "items" : [ { "id" : "1", "job_type" : "CREATE_SERVER", "job_resource_info" : { "resource_id" : "a1a1245-xxxx123d-1425af14", "resource_name" : "镜像测试" }, "begin_time" : "2022-03-07T10:40:43.858Z", "end_time" : "2022-03-07T10:40:43.858Z", "status" : "WAITING", "job_execute_info" : { "error_code" : "WKS.00129901", "error_message" : "The service is now unavailable to process the request." }, "project_id" : "325f2346-xxxx123d-1425af14", "job_id" : "1" } ] }

URI GET /v1/{project_id}/image-server-sub-jobs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目唯一标识。 表2 Query参数 参数 是否必选 参数类型 描述 status 否 String job详情的状态： WAITING - 等待 RUNNING - 运行中 SUCCESS - 成功 FAILED - 失败 ABNORMAL - 异常 ROLLBACK - 回滚中 ABORTING - 取消 job_type 是 String job类型： CREATE_SERVER - 创建镜像实例 CREATE_SERVER_IMAGE - 构建镜像 DELETE_SERVER - 删除镜像实例 offset 否 Integer 查询的偏移量。 limit 否 Integer 查询的数量，值区间[1-100]。 job_id 否 String 任务ID。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数。 items Array of ImageJobDetailInfo objects 任务明细信息列表，返回列表条目数量上限为分页的最大上限值。 表5 ImageJobDetailInfo 参数 参数类型 描述 id String 子任务ID。 job_type String job类型。 CREATE_SERVER - 创建镜像实例 CREATE_SERVER_IMAGE - 构建镜像 DELETE_SERVER - 删除镜像实例 job_resource_info ImageJobResourceInfo object 任务结果对应的资源信息，根据任务类型区分： 镜像实例 - 镜像实例信息 镜像 - 镜像信息 begin_time String 任务创建时间。 end_time String 任务结束时间。 status String job详情的状态 WAITING - 等待 RUNNING - 运行中 SUCCESS - 成功 FAILED - 失败 ABNORMAL - 异常 ROLLBACK - 回滚中 ABORTING - 终止中 job_execute_info ImageJobExecuteInfo object 任务执行失败信息。 project_id String 项目ID。 job_id String 任务ID。 表6 ImageJobResourceInfo 参数 参数类型 描述 resource_id String 资源ID。 resource_name String 产物名称，或者被操作资源名称。 表7 ImageJobExecuteInfo 参数 参数类型 描述 error_code String 任务执行失败时的错误码。 error_message String 任务失败原因。 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 401 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 403 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 404 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 405 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 500 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 503 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 growth_rate Double 环比值。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

URI GET /v2/{project_id}/statistics/growth-rate 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 grow_period 否 String 环比周期 | DAY - 天 MONTH - 月。 metric_name 是 String 指标名称。 dim 否 String 指标维度 | 目前最大支持3个维度，必须从0开始；维度格式为dim.{i}=key,value，key的最大长度32，value的最大长度为256。 单维度：dim.0=instance_id,6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d 多维度：dim.0=key,value&dim.1=key,value。

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

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

响应示例 状态码： 200 状态统计响应。 { "total_num" : 0, "attach_statistics" : { "attached_num" : 0, "unattached_num" : 0, "attaching_num" : 0, "attach_error_num" : 0 }, "run_state_statistics" : { "stop_num" : 0, "active_num" : 5, "error_num" : 0, "hibernated_num" : 0 }, "login_state_statistics" : { "in_use_num" : 0, "stop_num" : 0, "unregistered_num" : 0, "unable_to_connect_num" : 0, "ready_num" : 0, "disconnected_num" : 0 }, "desktop_pool_statistics" : [ { "desktop_pool_id" : 0, "desktop_pool_name" : 0, "total_num" : 0, "attach_statistics" : { "attached_num" : 0, "unattached_num" : 0, "attaching_num" : 0, "attach_error_num" : 0 }, "run_state_statistics" : { "stop_num" : 0, "active_num" : 5, "error_num" : 0, "hibernated_num" : 0 }, "login_state_statistics" : { "in_use_num" : 0, "stop_num" : 0, "unregistered_num" : 0, "unable_to_connect_num" : 0, "ready_num" : 0, "disconnected_num" : 0 } } ] }

URI GET /v2/{project_id}/statistics 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 desktop_type 否 Array of strings 桌面类型。 statistics_type 否 Array of strings 统计类型，为空时仅统计桌面总数 |- - attach-state 按照分配状态统计 - login-state 按照登录状态统计 - run-state 按照运行状态统计。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total_num Integer 桌面总数。 attach_statistics AttachStatistics object 分配情况统计。 run_state_statistics DesktopRunStatisticsRsp object 运行情况统计。 login_state_statistics DesktopLoginStatisticsRsp object 登录情况统计。 desktop_pool_statistics Array of DesktopPoolStatistics objects 每个桌面池的情况统计，当desktop_type指定为POOL时返回。 表5 DesktopPoolStatistics 参数 参数类型 描述 desktop_pool_id String 桌面池id。 desktop_pool_name String 桌面池名称。 total_num Integer 桌面总数。 attach_statistics AttachStatistics object 分配情况统计。 run_state_statistics DesktopRunStatisticsRsp object 运行情况统计。 login_state_statistics DesktopLoginStatisticsRsp object 登录情况统计。 表6 AttachStatistics 参数 参数类型 描述 attached_num Integer 已分配个数。 unattached_num Integer 未分配个数。 attaching_num Integer 分配中个数。 attach_error_num Integer 分配失败的个数。 表7 DesktopRunStatisticsRsp 参数 参数类型 描述 stop_num Integer 停止个数。 active_num Integer 运行中个数。 error_num Integer 故障个数。 hibernated_num Integer 休眠个数。 表8 DesktopLoginStatisticsRsp 参数 参数类型 描述 in_use_num Integer 使用中。 unregistered_num Integer 未注册数目。 unable_to_connect_num Integer 未注册数目。 ready_num Integer 空闲数目。 disconnected_num Integer 断开连接数目。 状态码： default 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 否 String 发送的实体的MIME类型。 表3 请求Body参数 参数 是否必选 参数类型 描述 desktop 否 desktop object 桌面属性。 表4 desktop 参数 是否必选 参数类型 描述 self_backup_management 否 String 是否开启快照的操作类型,"0":关闭 "1":开启。