华为云用户手册

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

响应参数 状态码：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 操作成功。 { "id" : "2b31e-d520xxxx-xxebedb6-e57xxxxxx", "task_type" : "RESTART_SERVER", "task_name" : "测试任务", "schedule_task_policy" : { "enforcement_enable" : false }, "scheduled_type" : "day", "day_interval" : 1, "week_list" : "1,2,7", "month_list" : "1,3,12", "date_list" : "1,2,28,L", "time_zone" : "Asia/Shanghai", "scheduled_date" : "2022-12-23", "scheduled_time" : "09:00:00", "expire_time" : "2022-03-07T10:40:43.858Z", "description" : "一个描述。", "target_infos" : [ { "target_type" : "SERVER", "target_id" : [ "3f791197-d166-4c8e-81e4-38c40ffc1989" ], "target_name" : "测试桌面" } ] }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 id String 任务id。 task_type String 定时任务类型： RESTART_SERVER - 定时重启服务器 START_SERVER - 定时开机 STOP_SERVER - 定时关机 REINSTALL_OS - 定时重装操作系统 task_name String 任务名称。 schedule_task_policy ScheduleTaskPolicy object 定时任务策略。 scheduled_type String 执行周期： FIXED_TIME - 指定时间 DAY - 按天 WEEK - 按周 MONTH - 按月 day_interval Integer 周期按天时：按x天间隔执行。 week_list String 周期按周时：取值1~7，英文逗号分隔，如1,2,7。 month_list String 周期按月时：取值1~12，英文逗号分隔，如1,3,12。 date_list String 周期按月时：取值1~31及L(代表当月最后一天)，英文逗号分隔，如1,2,28,L。 time_zone String 时区。 scheduled_date String 周期指定时间时：表示指定的日期，格式为yyyy-MM-dd。 scheduled_time String 指定的执行时间点，格式为HH:mm:ss。 expire_time String 到期时间，格式为。 description String 描述。 target_infos Array of TargetInfo objects 定时任务应用的对象列表。 表4 ScheduleTaskPolicy 参数 参数类型 描述 enforcement_enable Boolean 当存在会话的时候，是否强制执行，强制执行开关。取值为： false：表示关闭。 true：表示开启。 表5 TargetInfo 参数 参数类型 描述 target_type String 定时任务对象类型： SERVER - 服务器 SERVER_GROUP - 服务器组 target_id String 对象id。 target_name 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 错误描述。 状态码：404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：405 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：409 表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 表3 响应Body参数 参数 参数类型 描述 items Array of Catalog objects 应用分类信息。 表4 Catalog 参数 参数类型 描述 id String 唯一标识ID。 catalog_zh String 分类描述(中文)。 catalog_en 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 查询所有策略组的详细信息的响应。 { "policy_groups" : [ { "policy_group_id" : "string", "policy_group_name" : "string", "priority" : 65535, "update_time" : "string", "description" : "string。", "scope_flag" : 1, "tenant_id" : "string", "policies" : { "peripherals" : { "usb_custom_policy_debug" : "string", "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" : "Common mode" } }, "device_redirection" : { "printer_redirection" : { "printer_enable" : true, "options" : { "mobile_printer_enable" : false, "print_data_compression_mode" : false, "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", "hid_redirection" : { "hid_redirection_enable" : false, "options" : { "hid_redirection_customization_policy" : "string" } } }, "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 } }, "parallel_port_redirection" : { "parallel_port_enable" : false }, "driver_interface_redirection" : { "api_redir_driver_list" : "string" } }, "audio" : { "audio_redirection_enable" : true, "play_volume" : "Do Not Set Volume", "play_volume_ratio" : "Do Not Set Volume Ratio", "record_volume" : "100", "record_volume_ratio" : "Do Not Set Volume Ratio", "audio_transmission_mode" : "Reliable Transmission", "play_redirection_enable" : true, "play_classification" : "Music Play", "play_quality" : "Middle", "play_denoising" : "Disable Denoising", "play_agc" : "Disable AGC", "play_crc" : "Disable CRC", "play_device_mode" : "Play Device In Shared Mode", "play_delay_threshold" : "240", "play_amplitude_threshold" : "4096", "play_prefill_data" : "Do Not Prefill Data", "record_redirection_enable" : true, "record_classification" : "Speech Call", "record_quality" : "Middle", "record_denoising" : "-25", "record_agc" : "Disable AGC", "record_crc" : "Disable CRC", "record_device_mode" : "Record Device In Shared Mode", "record_delay_threshold" : "200", "record_amplitude_threshold" : "4096" }, "client" : { "automatic_reconnection_interval" : 5, "session_persistence_time" : 180, "autoclose_monitor_after_locked" : false, "autoclose_monitor_options" : { "autoclose_monitor_wait_time" : 300 }, "forbid_screen_capture" : false, "client_machine_join_domain" : true, "client_type" : { "client_type_limit" : true, "options" : { "sc_type_window" : true, "sc_type_mac" : true, "sc_type_android" : true, "sc_type_linux" : true, "sc_type_h5" : true, "sc_type_ios" : true, "sc_type_harmony_os" : true, "tc_type_all" : true } } }, "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" : true, "video_optimization_enable" : false, "gpu_color_optimization_enable" : false, "video_recognition_threshold" : 10, "frame_rate_statistical_length" : 4, "image_quality_threshold" : 0, "refresh_frequency_threshold" : 3, "exiting_video_area_threshold" : 8, "min_video_width" : 191, "min_video_length" : 191, "single_frame_natural_percentage" : "0.3", "cyclical_natural_images_number" : 2, "non_natural_image_percentage" : "0.85", "non_natural_images_number" : 25 }, "adaptive_bitrate_control_enable" : false, "adaptive_bitrate_control_options" : { "peak_bandwidth_suppression_enable" : false, "expected_average_network_latency" : 160, "network_latency_threshold1" : 160, "network_latency_threshold2" : 300, "min_dynamic_frame_rate" : 17, "min_dynamic_frame_rate_lv1" : 17, "min_dynamic_frame_rate_lv2" : 10, "rtt_threshold" : 20, "min_add_framerate" : 8, "max_add_framerate" : 20, "sub_framerate" : 25, "adaptive_bandwidth_lower_limit" : 500, "adaptive_compression_quality_lower_limit" : 60, "adaptive_compression_quality_upper_limit" : 85, "adaptive_compression_quality_increase_limit" : 5, "adaptive_compression_quality_decrease_limit" : 10, "adaptive_average_quality_lower_limit" : 15, "adaptive_average_quality_upper_limit" : 25, "adaptive_average_quality_increase_limit" : 3, "adaptive_average_quality_decrease_limit" : 1, "adaptive_min_quality_lower_limit" : 25, "adaptive_min_quality_upper_limit" : 30, "adaptive_min_quality_increase_limit" : 3, "adaptive_min_quality_decrease_limit" : 1 }, "video_card_memory_size" : 64, "configuration1_enable" : false, "driver_delegation_mode_enable" : false, "driver_delegation_latency" : 80, "video_latency" : 80, "change_resolution_vm" : false, "application_recognition" : "string", "duplicate_display_enable" : false, "default_mapping_order" : "1,2,3,4", "duplicate_display_mode" : "One-to-One" }, "file_and_clipboard" : { "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" : "\\\\var\\\\log", "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|lifs", "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 } }, "clip_length_limit_flag_c2s" : true, "clip_length_limit_c2s" : 180, "clip_length_limit_flag_s2c" : true, "clip_length_limit_s2c" : 180, "fd_mobile_client_redir_enable" : true, "clipboard_redirection" : "DISABLED", "clipboard_redirection_options" : { "rich_text_redirection_enable" : true, "clipboard_file_redirection_enable" : true } }, "access_control" : { "ip_access_control" : "string" }, "session" : { "vdi" : { "auto_lock_enable" : true, "auto_lock_options" : { "auto_lock_minutes" : 10, "auto_disconnect" : "DISABLED", "options" : { "auto_disconnect_minutes" : 1440 } }, "disconnect_logout_enable" : 0, "disconnect_logout_options" : { "disconnect_logout_minutes" : 10 }, "disconnect_hibernate_enable" : false, "disconnect_hibernate_options" : { "disconnect_hibernate_minutes" : 0 }, "no_operation_hibernate_enable" : false, "no_operation_hibernate_options" : { "no_operation_hibernate_minutes" : 0 } }, "self_help_console" : true, "disconnect_on_lock_flag" : 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 } }, "virtual_channel" : { "virtual_channel_control_enable" : false, "options" : { "custom_virtual_channel_name" : "string", "virtual_channel_plugin_details" : "string", "third_party_plugin_name" : "string" } }, "watermark" : { "watermark_enable" : false, "options" : { "show_style" : "RANDOM", "color" : "2a2a2a", "font_size" : 30, "opacity_setting" : "12.5", "content_item_count" : 1, "display_format" : "{\"AlignMode\":\"left\",\"DateTimeFormat\":\"DT\",\"DateFormat\":\"yyyy-mm-dd\",\"TimeFormat\":\"hh:mm:ss\",\"RepeatCount\":2,\"RepeatInterval\":10,\"DisplayFormat\":{\"Content1\":\"CustomContent\",\"Interval1\":\"n\",\"Content2\":\"UserName\",\"Interval2\":\"4\",\"Content3\":\"DateTime\"}}", "lean" : -45, "content_customized" : "string", "content_color" : 522857002, "watermark_security_access" : false, "user_extend_info_switch" : false, "user_extend_info" : "string" } }, "keyboard_mouse" : { "mouse_feedback" : "SELFADAPTION", "mouse_simulation_mode" : "ABSOLUTE_POSITION", "external_cursor_feedback" : false, "selfhelp_console_enable" : true, "client_mouse_send_interval" : 30, "windows_client_keyboard_mode" : "GLOBAL", "windows_client_mouse_mode" : "WINDOW", "linux_client_keyboard_mode" : "EVENT", "linux_client_mouse_mode" : "EVENT", "special_keyboard" : false, "joy_stick_flag" : false }, "seamless" : { "seamless_enable" : false, "options" : { "seamless_apply_path" : "string" } }, "personalizedDataMgmt" : { "personalized_data_mgmt_path" : "string", "user_data_roaming_enable" : false, "user_data_roaming_options" : { "profile_streaming_enable" : false, "roamed_files_local_path" : "string", "exclude_folders_path" : "string", "roaming_registry_method" : "string", "roaming_registry_path" : "string" }, "user_folder_redirection_enable" : false, "user_folder_redirection_options" : { "restore_local_directories_enable" : false, "appData_roaming_enale" : false, "redirec_desktop" : false, "redirec_start_menu" : false, "redirec_documents" : false, "redirec_pictures" : false, "redirec_music" : false, "redirec_videos" : false, "redirec_favorites" : false, "redirec_contacts" : false, "redirec_downloads" : false, "redirec_links" : false, "redirec_searches" : false, "redirec_saved_games" : false }, "logoff_delete_user_configuration" : false, "network_drive_mapping_enable" : false, "network_drive_mapping_options" : { "network_drive_mapping_path" : "string", "drive_letter" : "string" } }, "custom" : { "custom_configuration1_enable" : false, "options" : { "custom_configuration1_rule" : "string" } }, "record_audit" : { "enable" : true, "rules" : { "rule" : { "record_type" : "string", "interval_record_start_time" : "string", "interval_record_end_time" : "string", "op_type" : "string", "audio_record" : true, "fps" : 0, "duration" : 0, "resolution" : "string", "retention_duration" : 0 } } } }, "targets" : [ { "target_id" : "string", "target_name" : "string", "target_type" : "string" } ] } ], "total_count" : 0 }

URI GET /v2/{project_id}/policy-groups/detail 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 用于分页查询。范围0-100。 offset 否 Integer 用于分页查询，查询的起始记录序号，从0开始。 policy_group_id 否 String 根据策略组ID过滤结果。 policy_group_name 否 String 根据策略组名字过滤结果。 priority 否 Integer 根据优先级过滤结果。所带的值需要满足现有策略组已有最大优先级值。 update_time 否 String 根据更新时间过滤结果。时间格式满足：yyyy-MM-dd HH:mm:ss。 description 否 String 策略组描述。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 items Array of ServerJobInfo objects 服务器任务信息。 表5 ServerJobInfo 参数 参数类型 描述 server_id String 服务器ID。 job_id String 任务ID。 error_code String 失败时的错误码。 error_message 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 错误描述。 状态码：404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：405 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：503 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

响应示例 状态码：200 成功响应。 { "items" : [ { "server_id" : "84d5dd05-2977-4e37-8409-cf0b027f6a5b", "job_id" : "84d5dd05-2977-4e37-8409-cf0b027f6a5b", "error_code" : "", "error_message" : "" }, { "server_id" : "84d5dd05-2977-4e37-8409-cf0b027f6a5b", "job_id" : "", "error_code" : "WKS.00129901", "error_message" : "The service is now unavailable to process the request." } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 server_ids 否 Array of strings 应用服务器id集合。 update_access_agent 否 Boolean 是否自动升级hda版本。

请求示例 POST /v2/0bec5db98280d2d02fd6c00c2de791ce/periodic/subscribe/order { "type" : "addVolumes", "enterprise_project_id" : "0", "resources" : [ { "add_volumes" : { "desktop_id" : "8d049b4e-4f1e-4ed5-b3a9-a7f0f15658a7", "volumes" : [ { "type" : "SAS", "size" : 50 } ] } } ] } POST /v2/0bec5db98280d2d02fd6c00c2de791ce/periodic/subscribe/order { "type" : "createDesktops", "enterprise_project_id" : "0", "resources" : [ { "period_type" : 2, "period_num" : 1, "create_desktops" : { "desktops" : [ { "user_email" : "test@test.com", "user_name" : "test", "user_group" : "sudo" } ], "desktop_type" : "DEDICATED", "email_notification" : false, "product_id" : "workspace.k.xlarge2.uosv20pro", "share_resource_sku" : "workspace.collaborativedesktop.6party.standard", "image_type" : "private", "image_id" : "e1d65e11-861c-459d-a3a8-ab150d79befc", "root_volume" : { "type" : "SAS", "size" : 80 }, "nics" : [ { "subnet_id" : "197c1aa4-2611-48bd-a3af-ac4ce2c17c4c" } ], "tags" : [ { "key" : "aa", "value" : "bb" } ] } } ] }

响应参数 状态码：200 表30 响应Body参数 参数 参数类型 描述 order_id String 订单号，下单成功时返回订单ID。 状态码：400 表31 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：500 表32 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数。 items Array of AppGroup objects 应用组列表。 表5 AppGroup 参数 参数类型 描述 id String 应用组ID。 name String 应用组名称。 app_server_group_id String 应用服务器组ID。 app_server_group_name String 应用服务器组名称。 description String 应用组描述。 authorization_type String 授权类型，基于应用(组)授权，默认为APP_GROUP授权。 APP - 按照应用授权（尚未支持）。 APP_GROUP - 按照应用组授权。 tenant_id String 租户ID。 app_type String 服务器组应用类型： SESSION_DESKTOP_APP - 会话桌面app。 COMMON_APP - 普通app。 create_at String 发布时间。 app_count 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 错误描述。

响应示例 状态码：200 成功响应。 { "count" : 3, "items" : [ { "id" : "575772274859184145", "name" : "开放性API创建应用组测试", "app_server_group_id" : "", "description" : "开放性API测试。", "authorization_type" : "APP_GROUP", "tenant_id" : "a4da8115c9d8464ead3a38309130523f", "app_type" : "COMMON_APP", "create_at" : "2023-06-06T14:14:02.246Z", "app_count" : 0 }, { "id" : "573743978327834676", "name" : "lmn", "app_server_group_id" : "cb5a5079-67cb-45f6-9e4a-e489f3d821d6", "app_server_group_name" : "lmn-530test-勿删", "description" : "", "authorization_type" : "APP_GROUP", "tenant_id" : "a4da8115c9d8464ead3a38309130523f", "app_type" : "COMMON_APP", "create_at" : "2023-06-05T03:43:24.806Z", "app_count" : 1 }, { "id" : "561707361090142208", "name" : "tmp", "app_server_group_id" : "a0890780-7ef2-4aaf-b56d-b25fb53b717e", "app_server_group_name" : "Nas", "description" : "", "authorization_type" : "APP_GROUP", "tenant_id" : "a4da8115c9d8464ead3a38309130523f", "app_type" : "COMMON_APP", "create_at" : "2023-04-28T07:17:03.085Z", "app_count" : 14 } ] }

URI GET /v1/{project_id}/app-groups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 单次查询的大小[1-100]，默认值10。 offset 否 Integer 查询的偏移量，默认值0。 app_server_group_id 否 String 应用服务器组ID。 app_group_id 否 String 应用组ID。 name 否 String 应用组名称。 authorization_type 否 String 授权类型： APP - 应用 APP_GROUP - 应用组 app_type 否 String 应用组类型： SESSION_DESKTOP_APP - 会话桌面app COMMON_APP - 普通app

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 op_type 是 String 操作类型。 -os-start 开机。 -os-stop 关机。 -reboot 重启。 -hibernate 休眠。 type 否 String 执行类型。例如type为HARD，op_type为os-stop代表强制关机。 SOFT：普通操作。 HARD：强制操作。

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

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

请求示例 POST /v2/0bec5db98280d2d02fd6c00c2de791ce/desktops/resize { "desktops" : [ { "desktop_id" : "538946c2-7ff8-4444-b1bd-e9a1f8137b81" } ], "product_id" : "workspace.k.xlarge.2.linux", "mode" : "STOP_DESKTOP" }

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

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 jobs Array of ResizeDesktopJobResponse objects 按需桌面变更规格返回的任务信息（jobs字段后续会下线，请使用job_id字段）。 job_id String 变更规格任务id。 表6 ResizeDesktopJobResponse 参数 参数类型 描述 desktop_id String 桌面ID。 job_id String 任务ID。 状态码：202 表7 响应Body参数 参数 参数类型 描述 jobs Array of ResizeDesktopJobResponse objects 按需桌面变更规格返回的任务信息（jobs字段后续会下线，请使用job_id字段）。 job_id String 变更规格任务id。 表8 ResizeDesktopJobResponse 参数 参数类型 描述 desktop_id String 桌面ID。 job_id String 任务ID。 状态码：400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：401 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：403 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：404 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：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接口进行解密。

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

URI DELETE /v2/{project_id}/desktops/{desktop_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 desktop_id 是 String 桌面ID。 表2 Query参数 参数 是否必选 参数类型 描述 delete_users 否 Boolean 删除桌面后，如果当前用户没有其它桌面，可以删除桌面用户。true：删除用户，false：不删除用户，默认为false。 email_notification 否 Boolean 删除桌面后，是否给桌面用户发送系统通知邮件。true：发送，false：不发送。默认为true。 is_force_delete 否 Boolean 是否强制删除。

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

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 否 String 发送的实体的MIME类型。 表3 请求Body参数 参数 是否必选 参数类型 描述 desktop_ids 是 Array of strings 需要设置维护模式的desktopId列表。 in_maintenance_mode 是 Boolean 进入或退出管理员维护模式 false: 退出维护模式 true: 维护模式

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

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

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

请求示例 { "scheduled_type" : "FIXED_TIME", "day_interval" : 1, "week_list" : "1,2,7", "month_list" : "1,3,12", "date_list" : "1,2,28,L", "scheduled_date" : "2022-12-23", "scheduled_time" : "09:00:00", "expire_time" : "2022-12-31 09:00:00", "gray_count" : 1000, "gray_desktop_ids" : [ "string" ], "gray_fail_threshold" : 1000, "life_cycle_type" : "string", "time_zone" : "Asia/Shanghai" }