华为云用户手册

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数。 items Array of JobDetailInfo objects 任务明细信息列表，返回列表条目数量上限为分页的最大上限值。 表5 JobDetailInfo 参数 参数类型 描述 id String 子任务ID。 job_type String job类型： CREATE_SERVER - 创建服务器 DELETE_SERVER - 删除服务器 UPDATE_FREEZE_STATUS - 修改服务器冻结状态 CREATE_SERVER_IMAGE - 构建镜像 REINSTALL_OS - 重装操作系统 CHANGE_SERVER_IMAGE - 更换镜像 REJOIN_DOMAIN - 重新加域 MIGRATE_SERVER - 迁移服务器 UPGRADE_AC CES S_AGENT - hda升级 UPDATE_SERVER_TSVI - 更新虚拟会话IP SCHEDULED_TASK - 定时任务job COLLECT_HDA_ LOG - 收集hda日志 COLLECT_APS_LOG - 收集aps日志 CREATE_SERVER_SNAPSHOT - 创建服务器快照 DELETE_SERVER_SNAPSHOT - 删除服务器快照 RESTORE_SERVER_SNAPSHOT - 恢复服务器快照 BATCH_INSTALL_APP - 批量安装应用 job_resource_info JobResourceInfo object 任务结果对应的资源信息，根据任务类型区分： 服务器 - 服务器信息 镜像 - 镜像信息 begin_time String 任务创建时间。 end_time String 任务结束时间。 status String job详情的状态： WAITING - 等待 RUNNING - 运行中 SUCCESS - 成功 FAILED - 失败 ABNORMAL - 异常 ROLLBACK - 回滚中 ABORTING - 终止中 error_code String 任务执行失败时的错误码。 error_message String 任务失败原因。 project_id String 项目ID。 job_id String 任务ID。 表6 JobResourceInfo 参数 参数类型 描述 resource_id String 资源ID。 resource_name String 产物名称，或者被操作资源名称。 状态码：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 错误描述。

URI GET /v1/{project_id}/app-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 - 创建服务器 DELETE_SERVER - 删除服务器 REJOIN_DOMAIN - 服务器重新加域 CHANGE_SERVER_IMAGE - 修改服务器镜像 REINSTALL_OS - 服务器重装操作系统 MIGRATE_SERVER - 迁移服务器 UPDATE_SERVER_TSVI - 更新虚拟IP配置 UPGRADE_ACCESS_AGENT - hda升级 SCHEDULED_TASK - 定时任务 UPDATE_FREEZE_STATUS - 更新服务器冻结状态 offset 否 Integer 查询的偏移量，默认值0。 limit 否 Integer 查询的数量，值区间[1-100]，默认值10。 job_id 否 String 任务ID。

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

响应示例 状态码：200 成功响应。 { "count" : 0, "items" : [ { "id" : "string", "name" : "string", "description" : "string。", "rule" : { "scope" : "PRODUCT", "product_rule" : { "identify_condition" : "productName", "publisher" : null, "product_name" : "HUAWEI", "process_name" : "Huawei.exe", "support_os" : "Windows", "version" : "1.0.0.1", "product_version" : "1.0.0.1" }, "path_rule" : { "path" : "D:\\\\tmp" } }, "rule_source" : "string", "create_time" : "2024-12-25T07:03:42.629Z", "update_time" : "2024-12-25T07:03:42.629Z" } ] }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数。 items Array of AppRule objects 规则列表。 表5 AppRule 参数 参数类型 描述 id String 规则ID。 name String 规则名称。 description String 规则描述。 rule Rule object 规则信息。 rule_source String 规则来源。 create_time String 创建时间。 update_time String 更新时间。 表6 Rule 参数 参数类型 描述 scope String 规则范围： PRODUCT - 产品 PATH - 路径 product_rule ProductRule object 产品规则信息,进程名称、产品名称、发布者的各项都需要匹配，为空或者表示任意匹配。 例如： 发布者： 产品名称：Huawei 进程名称：* 只要产品名称是Huawei的就可以认为是匹配的。 path_rule PathRule object 路径规则信息,限制对应路径及子路径 表7 ProductRule 参数 参数类型 描述 identify_condition String 识别条件。 publisher String 发布者名称： 名称允许可见字符或空格，不可为全空格。 长度0~1024个字符。 为空或者*号表示任意匹配。 product_name String 产品名称： 名称允许可见字符或空格，不可为全空格。 长度0~128个字符。 为空或者*号表示任意匹配。 process_name String 进程名称： 名称允许可见字符或空格，不可为全空格。 长度0~128个字符。 为空或者*号表示任意匹配。 support_os String 操作系统类型，仅内置规则存在该字段。 名称允许可见字符或空格，不可为全空格。 长度0~128个字符。 version String 版本号： 名称允许可见字符或空格，不可为全空格。 长度0~128个字符。 为空或者*号表示任意匹配。 product_version String 产品版本号： 允许可见字符。 长度0~128个字符。 表8 PathRule 参数 参数类型 描述 path String 完整路径： 名称允许可见字符或空格，不可为全空格。 长度0~512个字符。 为空或者*号表示任意匹配。 状态码：400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：401 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：403 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：404 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：405 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：500 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：503 表15 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

URI GET /v1/{project_id}/app-center/app-rules 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询的偏移量。 limit 否 Integer 单次查询的大小[1-100]。 name 否 String 应用规则名称。

请求示例 PUT /v2/089b2f9a3d80d3062f24c00ca4ed5cbd/policy-groups/8ac225c277ceab6d0177cf829bd6008b/policies { "policies" : { "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 } }, "self_help_console" : true } } }

响应示例 状态码：200 修改一个策略组的部分或者所有策略项的响应。 { "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 } } } } }

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

响应示例 状态码：200 成功响应。 { "count" : 0, "script_records" : [ { "id" : "sawafaw12414214awfa", "script_id" : "string", "script_name" : "string", "script_task_id" : "string", "resource_id" : "string", "resource_name" : "string", "resource_type" : "string", "start_time" : "2024-12-25T07:10:49.357Z", "end_time" : "2024-12-25T07:10:49.357Z", "status" : "string", "execute_order" : 0, "command_content" : "string", "command_type" : "string", "result_code" : "string", "reason" : "string" } ] }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数。 script_records Array of ScriptRecordSimpleInfo objects 脚本执行记录列表。 表5 ScriptRecordSimpleInfo 参数 参数类型 描述 id String 脚本执行记录ID。 script_id String 脚本ID。 script_name String 脚本名称。 script_task_id String 脚本执行的任务ID。 resource_id String 执行脚本的资源ID，如桌面ID。 resource_name String 执行脚本的资源名称，如桌面名称。 resource_type String 资源类型，如桌面(DESKTOP)。 start_time String 脚本执行开始时间。 end_time String 脚本执行结束时间。 status String 脚本执行状态。 execute_order Integer 执行批次（默认：0，灰度：1，非灰度：2）。 result_code String 错误码。 reason 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 错误描述。

URI GET /v2/{project_id}/script-execution-records 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询的偏移量。 limit 否 Integer 单次查询的大小[1-100]。 resource_id 否 Array of strings 执行脚本的资源ID列表。 resource_group_id 否 Array of strings 执行脚本的资源组ID。 script_id 否 Array of strings 执行的脚本ID。 script_name 否 Array of strings 执行的脚本名称。 status 否 String 执行脚本的执行情况。 is_first_order 否 Boolean 是否首批执行。 script_task_id 否 String 执行脚本的任务ID。 task_type 否 String 执行记录的任务类型(SCRIPT/COMMAND)。 show_history 否 Boolean 是否查询历史记录，默认为false，为true时需要同时传入resource_id与script_id。 execute_time_start 否 String 按执行时间查询的起始时间。指定该参数后，返回的结果为此时间之后的所有执行记录。时间格式如：“2021-10-01T12:00:00Z”。 execute_time_end 否 String 按执行时间查询的终止时间。指定该参数后，返回的结果为此时间之前的所有执行记录。时间格式如：“2021-10-01T12:00:00Z”。

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

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

请求示例 { "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", "task_name" : "测试任务", "force_execute" : false, "description" : "一个描述。", "enable" : true, "extra_params" : "{ \"notify_message\": \"测试\" }", "apply_objects" : [ { "object_id" : "2b31e-d520xxxx-xxebedb6-e57xxxxxx", "object_type" : "DESKTOP", "object_name" : "测试桌面" } ], "priority" : 50, "is_gray" : true, "wait_time" : 43200 }

响应参数 状态码：400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：500 表6 响应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的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 scheduled_type 否 String 执行周期类型，可选值为： FIXED_TIME：指定时间。 DAY：按天。 WEEK：按周。 MONTH：按月。 LIFE_CYCLE：指定场景下触发。 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。 scheduled_date 否 String 周期指定时间时：表示指定的日期，格式为yyyy-MM-dd。 scheduled_time 否 String 指定的执行时间点，格式为HH:mm:ss。 expire_time 否 String 到期时间，格式为yyyy-MM-dd HH:mm:ss。 gray_count 否 Integer 灰度对象数量，优先级高于gray_desktop_ids。只支持脚本执行。 gray_desktop_ids 否 Array of strings 灰度执行的桌面id列表，优先级低于gray_count。只支持脚本执行。 gray_fail_threshold 否 Integer 灰度失败阈值，灰度执行失败次数达到该值时，不执行下一批任务。只支持脚本执行。 life_cycle_type 否 String 触发场景。POST_CREATE_DESKTOP_SUCCESS：创建桌面成功后，POST_REBUILD_DESKTOP_SUCCESS：重建桌面成功后，POST_REATTACH_DESKTOP_SUCCESS：触发重建的分配用户任务成功后，POST_DESKTOP_DISCONNECTED：桌面断开连接后。 time_zone 否 String 时区。 task_name 否 String 任务名称。 force_execute 否 Boolean 是否强制执行。 description 否 String 描述。 enable 否 Boolean 是否启用。 extra_params 否 String 扩展参数，json格式。 apply_objects 否 Array of ApplyObject objects 定时任务应用的对象列表。 priority 否 Integer 优先级。触发式任务使用。 is_gray 否 Boolean 任务是否灰度执行，供远程脚本使用。 wait_time 否 Integer 触发式任务触发后，等待时长。 表4 ApplyObject 参数 是否必选 参数类型 描述 object_id 否 String 对象ID。 object_type 否 String 对象类型，可选值为： DESKTOP：桌面。 DESKTOP_POOL：桌面池。 ALL_DESKTOPS: 所有桌面，仅供触发式任务使用。 DESKTOP_TAG：桌面标签

响应示例 状态码：200 成功响应。 { "count" : 0, "items" : [ { "server_id" : "489533790436196976", "machine_name" : "APS-DDP9KKUYTR", "server_name" : "APS-20221011032502-DL51DUK113", "server_group_name" : "测试使用服务器组", "sid" : "489533790436196976", "current_version" : "22.10.0.1020", "target_version" : "22.10.0.1022", "upgrade_status" : "SUCCESS", "upgrade_time" : "2022-10-25 10:25:10" } ] }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数。 items Array of ServerHdaUpgradeRecord objects 返回列表条目数量上限为分页的最大上限值。 表5 ServerHdaUpgradeRecord 参数 参数类型 描述 server_id String 服务器id。 machine_name String 机器名称。 server_name String 服务器名称。 server_group_name String 服务器组名称。 sid String 服务器的sid。 current_version String 当前的accessAgent版本。 target_version String 目标的accessAgent版本。 upgrade_status String HDA升级状态。 upgrade_time 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 错误描述。

URI GET /v1/{project_id}/app-servers/access-agent/upgrade-record 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目唯一标识。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询的偏移量，默认值0。 limit 否 Integer 查询的数量，值区间[1-100]，默认值10。

响应示例 状态码：200 查询站点信息的接口。 { "site_infos" : [ { "site_id" : "string", "site_name" : "string", "site_type" : "string", "project_id" : "string", "status" : "string", "create_time" : "string", "agent_info" : [ { "id" : "string", "project_id" : "string", "site_id" : "string", "vag_ip" : "string", "private_ip" : "string", "private_ipv6" : "string", "vag_port_id" : "string", "ssh_user" : "gandalf", "ssh_pwd" : "string", "vm_id" : "string", "name" : "string", "internal_ip" : "string", "internal_ipv6" : "string", "internal_port_id" : "string", "external_ip" : "string", "external_id" : "string", "root_user" : "string", "root_pwd" : "string", "status" : "string", "availability_zone" : "string", "create_time" : 255, "create_time_str" : "string", "state" : "string", "number_of_online_user" : 20000, "running_status" : "string", "domain_id" : "string", "version" : "string", "latest_version" : "string", "access_edge_version" : "string", "tenant_lock" : 0, "resource_pool_id" : "string", "role" : "string", "resource_pool_type" : "string", "edge_sk" : "string", "has_heartbeat" : true, "user_count" : 0 } ] } ], "total_count" : 200000 }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 site_infos Array of SiteInfo objects 站点信息列表。 total_count Integer 站点总数。 表5 SiteInfo 参数 参数类型 描述 site_id String 站点id。 site_name String 站点名字。 site_type String 配置状态。 CENTER： 中心初始化 IES： 边缘初始化 project_id String 项目ID。 status String 站点状态。 create_time String 创建时间。 agent_info Array of Vag objects 网关节点信息。 表6 Vag 参数 参数类型 描述 id String vAG信息ID。 project_id String 项目ID。 site_id String 站点ID。 vag_ip String vAG IP，与管理节点相同的IP。 private_ip String vAG内网IP，HDA往这个IP上报心跳。 private_ipv6 String vAG内网IPv6。 vag_port_id String vAG端口ID，与管理节点相同的端口的ID。 ssh_user String SSH用户的名称，固定为gandalf。 ssh_pwd String SSH用户的密码。 vm_id String vAG所属E CS 的ID。 name String vAG所属机器名。 internal_ip String vAG内部通信IP，最终租户VPC的子网IP。 internal_ipv6 String vAG内部通信IPV6。 internal_port_id String vAG内部通信端口ID，最终租户VPC的子网中端口的ID。 external_ip String 外部通信IP，可能独立的EIP。 external_id String 外部通信ID，可能独立的EIP ID。 root_user String root用户的名称，固定为root。 root_pwd String root用户的密码。 status String vag操作状态。 availability_zone String 可用分区。 create_time Long 创建时间。 create_time_str String 创建时间字符串。 state String vag服务状态 NOT_USE：维护，ON_USE：启用，CANCELLATION：退服。 number_of_online_user Long 在线用户数。 running_status String vag运行状态。 domain_id String 租户侧domainId。 version String vag当前版本号。 latest_version String vag最新版本号。 access_edge_version String wksAccessEdge版本号。 tenant_lock Integer 项目是否被锁定 0是未锁定 1是锁定。 resource_pool_id String 资源池id。 role String agent角色，如：vag,vap4down,vap4up,authConnector。 resource_pool_type String 资源池类型，public,private。 edge_sk String 边缘sk。 has_heartbeat Boolean 是否有心跳。 user_count Integer VAG负载个数。 状态码：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接口进行解密。 状态码：503 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 tasks_records Array of ScheduledTasksRecords objects 定时任务执行记录列表。 total_count Integer 总个数。 表5 ScheduledTasksRecords 参数 参数类型 描述 id String 任务执行记录id。 start_time String 执行时间，格式为yyyy-MM-dd HH:mm:ss。 task_type String 任务类型。START：开机，STOP：关机，REBOOT：重启，HIBERNATE：休眠，REBUILD：重建系统盘。 scheduled_type String 执行周期类型。FIXED_TIME：指定时间，DAY：按天，WEEK：按周，MONTH：按月。 status String 本次执行状态。 success_num Integer 成功桌面个数。 failed_num Integer 失败桌面个数。 skip_num Integer 跳过桌面个数。 time_zone String 时区。 execute_task_id String 执行定时任务的任务id，只有定时执行脚本返回。 execute_object_type String 执行定时任务的对象类型，只有定时执行脚本返回。 状态码：400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应示例 状态码：200 正常。 { "tasks_records" : [ { "id" : "2b31e-d520xxxx-xxebedb6-e57xxxxxx", "start_time" : "2022-12-31 09:00:00", "task_type" : "START", "scheduled_type" : "FIXED_TIME", "status" : "SUCCESS", "success_num" : 1, "failed_num" : 1, "skip_num" : 1, "time_zone" : "Asia/Shanghai", "execute_task_id" : "string", "execute_object_type" : "string" } ], "total_count" : 10 }

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

URI DELETE /v1/{project_id}/app-center/apps/{app_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 app_id 是 String 应用ID。 表2 Query参数 参数 是否必选 参数类型 描述 reserve_obs_file 否 String 删除应用时是否保留OBS桶文件(默认false) 'true' - 保留OBS桶文件,仅删除应用 'false' - 不保留OBS桶文件,删除应用同时删除OBS桶文件

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

请求示例 { "install_command" : "${FILE_PATH} /S", "uninstall_command" : "msiexec /uninstall ${FILE_PATH} /quiet", "users" : [ { "account" : "zhangsan******@test.com", "domain" : "siv.**.huawei.com", "account_type" : "SIMPLE", "platform_type" : "AD" } ] }

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 install_command 否 String 安装命令(静默安装命令)。 例: ${FILE_PATH} /S 预定义变量将采用以下值: ${FILE_PATH}: 应用安装包在桌面本地的存储路径。 uninstall_command 否 String 卸载命令(静默卸载命令)。 例: msiexec /uninstall ${FILE_PATH} /quiet。 预定义变量将采用以下值: ${FILE_PATH}: 应用安装包在桌面本地的存储路径。 users 否 Array of AccountInfo objects 指定安装用户。 表4 AccountInfo 参数 是否必选 参数类型 描述 account 是 String 账户，账户的格式必须为:账户(组)的形式。 domain 否 String 域名 (用户组必填，不填时使用默认值 local.com)。 account_type 是 String 账户类型： 'SIMPLE' - 普通用户 'USER_GROUP' - 用户组 platform_type 否 String 平台类型： AD - AD域 LOCAL - LiteAs