华为云用户手册

  • 服务概述 确定性运维支持服务依托华为云丰富运维技术与服务经验,为客户提供专业的运维服务,进一步提升客户业务稳定性和运维能力。 远程运维技术支持服务定位为面向服务预算有限的客户,希望华为云工单问题受理、处理时效和质量提升,同时针对业务系统重要紧急事件可以获得快速支持、针对重大事件可以获得华为云主动通知,推出的高性价产品。 远程运维技术支持服务包含六个权益项:官网工单加速、专家直服、专属群、服务响应SLA、需求跟踪、云事件通知。
  • 服务范围 覆盖范围 客户在使用 华为云产品 时的相关问题咨询/报障,通过专属群向华为云寻求技术支持加急服务。 业界突发事件(如安全漏洞、病毒、骨干网故障等)或华为云变更事件主动通知。 客户紧急问题需要远程技术服务经理高效、专业的进行处理。 服务期间客户对华为云产品提出优化需求,华为依据客户实际需求、产品规划与设计评估需求实现可能性与上线周期。 不覆盖范围 不提供代码开发。 不提供第三方软件的安装、补丁更新、测试、故障诊断、优化等日常运维服务,不负责第三方软件支持过程中所提供建议的实施。 不提供IDC和硬件设备维护,如网络设备、服务器、存储等硬件巡检、更换、诊断等。 不提供其他云产品的技术支持服务。 服务区域 中国。
  • 服务内容和服务场景 服务类型 服务内容 典型应用场景 AI平台开发支持服务 提供ModelArts SDK/API的使用支持及Demo展示;提供ModelArts开发环境搭建指导及训练、推理过程指导。 第三方模型的集成对接及调测;ModelArts开发环境搭建指导及训练、推理过程指导。 AI平台场景化建模开发服务 针对客户业务场景,提供建模咨询服务,帮助客户构建场景化模型,并提供场景化调优服务。 迁移模型至华为昇腾;构建场景化模型。 AI平台场景化建模调优服务 针对用户已有模型提供模型优化、加速、性能提升等服务。 场景化模型优化、加速。 父主题: 关于服务咨询
  • 计费项 服务项 服务子项 服务规格 计费说明 单价(元) 单位 确定性运维支持服务 运维技术支持服务 远程运维技术支持服务(包月) 包周期计费,按包月数计费 12,000.00 每月 远程运维技术支持服务(包年) 包周期计费,按包年数计费 140,000.00 每年 工单加速 一次性预付费,按套数计费,一套内含10个加急工单额度,有效期一个月,次数或时间任意一项清空则权益到期 4,500.00 每套 专家直服 一次性预付费,按套数计费,一套内含5个专家直服工单额度,有效期一个月,次数或时间任意一项清空则权益到期 5,500.00 每套
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 job_id String 任务ID。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 405 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 503 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。
  • 响应示例 状态码: 200 查询策略组策略项信息的响应。 { "policies" : { "peripherals" : { "usb_port_redirection" : { "usb_enable" : true, "options" : { "usb_image_enable" : true, "usb_video_enable" : true, "usb_printer_enable" : true, "usb_storage_enable" : false, "wireless_devices_enable" : false, "network_devices_enable" : false, "usb_smart_card_enable" : true, "other_usb_devices_enable" : false, "usb_redirection_customization_policy" : "string", "usb_redirection_mode" : "Classical mode" } }, "device_redirection" : { "printer_redirection" : { "printer_enable" : true, "options" : { "sync_client_default_printer_enable" : true, "universal_printer_driver" : "Default" } }, "session_printer" : { "session_printer_enable" : false, "options" : { "session_printer_customization_policy" : "string" } }, "camera_redirection" : { "video_compress_enable" : true, "options" : { "camera_frame_rate" : 15, "camera_max_width" : 3000, "camera_max_heigth" : 3000, "camera_compression_method" : "H.264" } }, "twain_redirection_enable" : true, "image_compression_level" : "medium" }, "usb_device_common" : { "pcsc_smart_card_enable" : "Disable", "common_options" : { "remove_smart_card_disconnect_enable" : false } }, "serial_port_redirection" : { "serial_port_enable" : false, "options" : { "auto_connect_enable" : false } } }, "audio" : { "audio_redirection_enable" : true, "play_redirection_enable" : true, "play_classification" : "Music Play", "record_redirection_enable" : true, "record_classification" : "Speech Call" }, "client" : { "automatic_reconnection_interval" : 5, "session_persistence_time" : 180, "forbid_screen_capture" : false }, "display" : { "display_level" : "LEVEL4", "options" : { "display_bandwidth" : 20000, "frame_rate" : 25, "video_frame_rate" : 30, "min_image_cache" : 200, "smoothing_factor" : 60, "lossless_compression_mode" : "Basic Compression", "deep_compression_options" : { "deep_compression_level" : "Compression grade 0" }, "lossy_compression_quality" : 85, "color_enhancement_enable" : false, "quality_bandwidth_first" : "Quality First", "video_bit_rate_options" : { "average_video_bit_rate" : 18000 }, "peak_video_bit_rate" : 18000, "video_quality_options" : { "average_video_quality" : 15, "lowest_video_quality" : 25, "highest_video_quality" : 7 }, "gop_size" : 100, "encoding_preset" : "Preset 1" }, "rendering_acceleration_enable" : false, "rendering_acceleration_options" : { "video_acceleration_enhancement_enable" : false, "video_optimization_enable" : false, "gpu_color_optimization_enable" : false }, "video_card_memory_size" : 64, "driver_delegation_mode_enable" : false, "driver_delegation_latency" : 80, "video_latency" : 80, "change_resolution_vm" : false }, "file_and_clipboard" : { "bypass_in_remote_app_enable" : true, "file_redirection" : { "redirection_mode" : "DISABLED", "options" : { "fluid_control_switch_enable" : false, "fluid_control_options" : { "good_network_latency" : 30, "normal_network_latency" : 70, "poor_network_latency" : 100, "reducing_step" : 20, "slow_increasing_step" : 10, "quick_increasing_step" : 20, "start_speed" : 1024, "test_block_size" : 64, "test_time_gap" : 10000 }, "compression_switch_enable" : false, "compression_switch_options" : { "compression_threshold" : 512, "minimum_compression_rate" : 900 }, "linux_file_size_supported_enable" : true, "linux_file_size_supported_options" : { "linux_file_size_supported_threshold" : 100 }, "linux_root_mount_switch_enable" : true, "linux_root_dir_list" : "\\\\home", "linux_file_mount_path" : "\\\\media|\\\\Volumes|\\\\swdb\\\\mnt|\\\\home|\\\\storage|\\\\tmp|\\\\run\\\\media", "linux_fixed_drive_file_system_format" : "string", "linux_removable_drive_file_system_format" : "vfat|ntfs|msdos|fuseblk|sdcardfs|exfat|fuse.fdredir", "linux_cdrom_drive_file_system_format" : "cd9660|iso9660|udf", "linux_network_drive_file_system_format" : "smbfs|afpfs|cifs", "path_separator" : "|", "fixed_drive_enable" : true, "removable_drive_enable" : true, "cd_rom_drive_enable" : true, "network_drive_enable" : true }, "vm_send_file_client" : true, "redirection_send_file_options" : { "read_write_speed" : 0 } }, "fd_mobile_client_redir_enable" : true, "clipboard_redirection" : "DISABLED", "clipboard_redirection_options" : { "rich_text_redirection_enable" : true, "rich_text_clipboard_redirection" : "DISABLED", "clipboard_file_redirection_enable" : true, "file_clipboard_redirection" : "DISABLED" } }, "session" : { "sbc" : { "sbc_automatic_disconnection" : "AUTO_DISCONNECT", "sbc_automatic_disconnection_options" : { "disconnection_waiting_time" : 15, "sbc_auto_logout" : true, "auto_logout_options" : { "sbc_logout_waiting_time" : 480 } } } }, "virtual_channel" : { "virtual_channel_control_enable" : false, "options" : { "custom_virtual_channel_name" : "string", "virtual_channel_plugin_details" : "string", "third_party_plugin_name" : "string" } }, "keyboard_mouse" : { "mouse_feedback" : "SELFADAPTION", "mouse_simulation_mode" : "ABSOLUTE_POSITION", "external_cursor_feedback" : false }, "bandwidth" : { "intelligent_data_transport_flag" : "DISABLE", "total_bandwidth_control_enable" : false, "options" : { "total_bandwidth_control_value" : 30000, "display_bandwidth_percentage_enable" : false, "display_bandwidth_percentage_options" : { "display_bandwidth_percentage_value" : 65 }, "multimedia_bandwidth_percentage_enable" : false, "multimedia_bandwidth_percentage_options" : { "multimedia_bandwidth_percentage_value" : 50 }, "usb_bandwidth_percentage_enable" : false, "usb_bandwidth_percentage_options" : { "usb_bandwidth_percentage_value" : 100 }, "pcsc_bandwidth_percentage_enable" : false, "pcsc_bandwidth_percentage_options" : { "pcsc_bandwidth_percentage_value" : 5 }, "twain_bandwidth_percentage_enable" : false, "twain_bandwidth_percentage_options" : { "twain_bandwidth_percentage_value" : 15 }, "printer_bandwidth_percentage_enable" : false, "printer_bandwidth_percentage_options" : { "printer_bandwidth_percentage_value" : 5 }, "com_bandwidth_percentage_enable" : false, "com_bandwidth_percentage_options" : { "com_bandwidth_percentage_value" : 3 }, "file_redirection_bandwidth_percentage_enable" : false, "file_redirection_bandwidth_percentage_options" : { "file_redirection_bandwidth_percentage_value" : 30 }, "clipboard_bandwidth_percentage_enable" : false, "clipboard_bandwidth_percentage_options" : { "clipboard_bandwidth_percentage_value" : 3 }, "secure_channel_bandwidth_percentage_enable" : false, "secure_channel_bandwidth_percentage_options" : { "secure_channel_bandwidth_percentage_value" : 30 }, "camera_bandwidth_percentage_enable" : false, "camera_bandwidth_percentage_options" : { "camera_bandwidth_percentage_value" : 30 }, "virtual_channel_bandwidth_percentage_enable" : false, "virtual_channel_bandwidth_percentage_options" : { "virtual_channel_bandwidth_percentage_value" : 65 } }, "display_bandwidth_control_enable" : false, "display_bandwidth_control_options" : { "display_bandwidth_control_value" : 20000 }, "multimedia_bandwidth_control_enable" : false, "multimedia_bandwidth_control_options" : { "multimedia_bandwidth_control_value" : 15000 }, "usb_bandwidth_control_enable" : false, "usb_bandwidth_control_options" : { "usb_bandwidth_control_value" : 30000 }, "pcsc_bandwidth_control_enable" : false, "pcsc_bandwidth_control_options" : { "pcsc_bandwidth_control_value" : 2000 }, "twain_bandwidth_control_enable" : false, "twain_bandwidth_control_options" : { "twain_bandwidth_control_value" : 5000 }, "printer_bandwidth_control_enable" : false, "printer_bandwidth_control_options" : { "printer_bandwidth_control_value" : 2000 }, "com_bandwidth_control_enable" : false, "com_bandwidth_control_options" : { "com_bandwidth_control_value" : 1000 }, "file_redirection_bandwidth_control_enable" : false, "file_redirection_bandwidth_control_options" : { "file_redirection_bandwidth_control_value" : 10000 }, "clipboard_bandwidth_control_enable" : false, "clipboard_bandwidth_control_options" : { "clipboard_bandwidth_control_value" : 1000 }, "secure_channel_bandwidth_control_enable" : false, "secure_channel_bandwidth_control_options" : { "secure_channel_bandwidth_control_value" : 10000 }, "camera_bandwidth_control_enable" : false, "camera_bandwidth_control_options" : { "camera_bandwidth_control_value" : 10000 }, "virtual_channel_bandwidth_control_enable" : false, "virtual_channel_bandwidth_control_options" : { "virtual_channel_bandwidth_control_value" : 20000 } }, "custom" : { "custom_configuration1_enable" : true, "options" : { "custom_configuration1_rule" : "string" } } } }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 policies Policies object 策略类。 表4 Policies 参数 参数类型 描述 peripherals peripherals object 外设。 audio audio object 音频。 client client object 客户端。 display display object 显示。 file_and_clipboard file_and_clipboard object 文件和剪切板。 session Session object 会话 virtual_channel VirtualChannel object 虚拟通道 keyboard_mouse keyboard_mouse object 键盘鼠标。 bandwidth Bandwidth object 带宽。 custom custom object 自定义策略 表5 peripherals 参数 参数类型 描述 usb_port_redirection usb_port_redirection object USB端口重定向。 device_redirection device_redirection object 设备重定向。 usb_device_common usb_device_common object USB和设备智能卡控制选项。 serial_port_redirection serial_port_redirection object 串口重定向。 表6 usb_port_redirection 参数 参数类型 描述 usb_enable Boolean 是否开启USB端口重定向。取值为: false:表示关闭。 true:表示开启。 options UsbPortRedirectionOptions object USB端口重定向控制的选项。 表7 UsbPortRedirectionOptions 参数 参数类型 描述 usb_image_enable Boolean 是否开启图像设备(如: 扫描仪)。取值为: false:表示关闭。 true:表示开启。 usb_video_enable Boolean 是否开启视频设备(如: 摄像头)。取值为: false:表示关闭。 true:表示开启。 usb_printer_enable Boolean 是否开启打印设备(如: 打印机)。取值为: false:表示关闭。 true:表示开启。 usb_storage_enable Boolean 是否开启存储设备(如: U盘)。取值为: false:表示关闭。 true:表示开启。 wireless_devices_enable Boolean 是否开启无线设备(如:蓝牙)。取值为: false:表示关闭。 true:表示开启。 network_devices_enable Boolean 是否开启网络设备(如:无线网卡)。取值为: false:表示关闭。 true:表示开启。 usb_smart_card_enable Boolean 是否开启智能卡设备(如:Ukey)。取值为: false:表示关闭。 true:表示开启。 other_usb_devices_enable Boolean 是否开启其他USB设备重定向。取值为: false:表示关闭。 true:表示开启。 usb_redirection_customization_policy String USB端口重定向自定义策略。 usb_redirection_mode String USB 重定向模式。取值为: Classical mode:经典模式。 Common mode:通用模式。 表8 device_redirection 参数 参数类型 描述 printer_redirection printer_redirection object 打印机重定向。 session_printer session_printer object 会话打印机。 camera_redirection camera_redirection object 摄像头重定向。 twain_redirection_enable Boolean 是否开启TWAIN设备重定向。取值为: false:表示关闭。 true:表示开启。 image_compression_level String 图形压缩级别。取值为: 不压缩:none。 低(速度最快):low。 中(速度适中):medium。 高(速度最慢):high。 无损(无损压缩):lossless。 低损(低损压缩):low-loss。 中损(中损压缩):medium-loss。 高损(高损压缩):high-loss。 表9 printer_redirection 参数 参数类型 描述 printer_enable Boolean 是否开启打印机设备重定向。取值为: false:表示关闭。 true:表示开启。 options PrinterRedirectionOptions object 打印机设备重定向控制的选项。 表10 PrinterRedirectionOptions 参数 参数类型 描述 sync_client_default_printer_enable Boolean 是否开启同步客户端默认打印机。取值为: false:表示关闭。 true:表示开启。 universal_printer_driver String 通用打印机驱动。取值为:- Default:linux客户端选择Universal Printing- PS,windows客户端选择HDP XPSDrv Driver。- HDP XPSDrv Driver。- Universal Printing PCL 5。- Universal Printing PCL 6。- Universal Printing PS。 表11 session_printer 参数 参数类型 描述 session_printer_enable Boolean 是否开启会话打印机。取值为: false:表示关闭。 true:表示开启。 options SessionPrinterOptions object 会话打印机控制选项。 表12 SessionPrinterOptions 参数 参数类型 描述 session_printer_customization_policy String 会话打印机自定义策略。 表13 camera_redirection 参数 参数类型 描述 video_compress_enable Boolean 是否开启摄像头设备重定向。取值为: false:表示关闭。 true:表示开启。 options CameraRedirectionOptions object 摄像头设备重定向控制的选项。 表14 CameraRedirectionOptions 参数 参数类型 描述 camera_frame_rate Integer 摄像头帧率(fps)。取值范围为[1-30]。默认:15。 camera_max_width Integer 摄像头最大宽度(pixel)。取值范围为[1-9999]。默认:3000。 camera_max_heigth Integer 摄像头最大高度(pixel)。取值范围为[1-9999]。默认:3000。 camera_compression_method String 摄像头数据压缩方式。取值为:H.264。 表15 usb_device_common 参数 参数类型 描述 pcsc_smart_card_enable String 是否开启PC/SC智能卡重定向。取值为: Enable:表示已启动。 Closed:表示已关闭。 Disable:表示已禁用。 common_options common_options object USB和设备智能卡共同控制的选项。 表16 common_options 参数 参数类型 描述 remove_smart_card_disconnect_enable Boolean 是否移除智能卡断开用户会话。取值为: false:表示关闭。 true:表示开启。 表17 serial_port_redirection 参数 参数类型 描述 serial_port_enable Boolean 是否开启串口重定向。取值为: false:表示关闭。 true:表示开启。 options SerialPortRedirectionOptions object 串口重定向控制的选项。 表18 SerialPortRedirectionOptions 参数 参数类型 描述 auto_connect_enable Boolean 是否自动连接客户端串口。取值为: false:表示关闭。 true:表示开启。 表19 audio 参数 参数类型 描述 audio_redirection_enable Boolean 是否开启音频重定向。取值为: false:表示关闭。 true:表示开启。 play_redirection_enable Boolean 是否开启播音重定向。取值为: false:表示关闭。 true:表示开启。 play_classification String 播音场景。取值为: 无损播音:LossLess。 语音通话:Speech Call。 音乐播音:Music Play。 自动识别:Automatic Identification。 record_redirection_enable Boolean 是否开启录音重定向。取值为: false:表示关闭。 true:表示开启。 record_classification String 录音场景。取值为: 无损录音:LossLess。 语音通话:Speech Call。 音乐录音:Music Record。 自动识别:Automatic Identification。 表20 client 参数 参数类型 描述 automatic_reconnection_interval Integer 自动重连间隔(秒)。取值范围为[1-50]。默认:5。 session_persistence_time Integer 自动重连会话保持时长(秒)。取值范围为[0-180]。默认:180。 forbid_screen_capture Boolean 防截屏策略开关。 false:表示关闭。 true:表示开启。 表21 display 参数 参数类型 描述 display_level String 显示级别。取值为: LEVEL1:表示等级1。 LEVEL2:表示等级2。 LEVEL3:表示等级3。 LEVEL4:表示等级4(默认/推荐)。 LEVEL5:表示等级5。 options DisplayOptions object 显示级别共同控制的选项。 rendering_acceleration_enable Boolean 是否开启渲染加速。取值为: false:表示关闭。 true:表示开启。 rendering_acceleration_options rendering_acceleration_options object 渲染加速控制选项。 video_card_memory_size Integer 显卡缓存(MB)。取值范围为[0-64]。默认:64。 driver_delegation_mode_enable Boolean 是否开启驱动托管模式。取值为: false:表示关闭。 true:表示开启。 driver_delegation_latency Integer 驱动托管延时(*30ms)。取值范围为[1-100]。默认:80。 video_latency Integer 驱动托管视频延时(*30ms)。取值范围为[1-100]。默认:80。 change_resolution_vm Boolean 计算机修改分辨率:取值为: false:表示关闭。 true:表示开启。 表22 DisplayOptions 参数 参数类型 描述 display_bandwidth Integer 带宽(Kbps)。取值范围为[256-25000]。默认:20000。 frame_rate Integer 帧率(fps)。取值范围为[1-60]。默认:25。 video_frame_rate Integer 视频帧率(fps)。取值范围为[1-60]。默认:30。 min_image_cache Integer 图像缓存最低容量(MB)。取值范围[0-300],默认:200。 smoothing_factor Integer 有损压缩识别阈值。取值范围为[0-255]。默认:60。 lossless_compression_mode String 无损压缩模式。取值为: Basic Compression:表示初级压缩。 Deep Compression:表示深度压缩。 deep_compression_options deep_compression_options object 深度压缩控制选项。 lossy_compression_quality Integer 有损压缩质量。取值范围为[20-100]。默认:85。 color_enhancement_enable Boolean 办公场景色彩增强:取值为: false:表示关闭。 true:表示开启。 quality_bandwidth_first String 质量或带宽优先。取值为: Quality First:表示初级压缩。 Bandwidth First:表示深度压缩。 video_bit_rate_options video_bit_rate_options object 视频码率控制选项。 peak_video_bit_rate Integer 视频峰值码率(Kbps)。取值范围为[256-100000]。默认:18000。 video_quality_options video_quality_options object 视频质量控制选项。 gop_size Integer GOP大小。取值范围为[0-65535]。默认:100。 encoding_preset String 编码预置。取值为: 预置1:Preset 1。 预置2:Preset 2。 预置3:Preset 3。 预置4:Preset 4。 预置5:Preset 5。 预置6:Preset 6。 预置7:Preset 7。 表23 deep_compression_options 参数 参数类型 描述 deep_compression_level String 深度压缩级别。取值为: 压缩级别0:Compression grade 0 压缩级别1:Compression grade 1 压缩级别2:Compression grade 2 压缩级别3:Compression grade 3 压缩级别4:Compression grade 4 压缩级别5:Compression grade 5 压缩级别6:Compression grade 6 压缩级别7:Compression grade 7 压缩级别8:Compression grade 8 压缩级别9:Compression grade 9 表24 video_bit_rate_options 参数 参数类型 描述 average_video_bit_rate Integer 视频平均码率(Kbps)。取值范围为[256-100000]。默认:18000。 表25 video_quality_options 参数 参数类型 描述 average_video_quality Integer 视频平均质量。取值范围为[5-59]。默认:15。 lowest_video_quality Integer 视频最低质量。取值范围为[5-69]。默认:25。 highest_video_quality Integer 视频最高质量。取值范围为[1-59]。默认:7。 表26 rendering_acceleration_options 参数 参数类型 描述 video_acceleration_enhancement_enable Boolean 视频加速增强配置。取值为: false:表示关闭。 true:表示开启。 video_optimization_enable Boolean 是否开启视频场景优化。取值为: false:表示关闭。 true:表示开启。 gpu_color_optimization_enable Boolean 是否开启GPU色彩优化。取值为: false:表示关闭。 true:表示开启。 表27 file_and_clipboard 参数 参数类型 描述 bypass_in_remote_app_enable Boolean 应用聚合场景下是否双向放通:取值为: false:表示不放通。 true:表示放通。 file_redirection file_redirection object 文件重定向。 fd_mobile_client_redir_enable Boolean 移动客户端文件重定向:取值为: false:表示关闭。 true:表示开启。 clipboard_redirection String 剪切板重定向。取值为: DISABLED:表示禁用。(默认) SERVER_TO_CLIENT_ENABLED:表示开启服务端到客户端。 CLIENT_TO_SERVER_ENABLED:表示开启客户端到服务端。 TWO_WAY_ENABLED:表示开启双向。 clipboard_redirection_options clipboard_redirection_options object 剪切板重定向控制的选项。 表28 file_redirection 参数 参数类型 描述 redirection_mode String 文件重定向。取值为: DISABLED:表示禁用。(默认) READ_ONLY:表示只读。 READ_AND_WRITE:表示读写。 options FileRedirectionOptions object 文件重定向控制的选项。 vm_send_file_client Boolean 是否开启发送文件(虚机到客户端)。取值为: false:表示关闭。 true:表示开启。 redirection_send_file_options redirection_send_file_options object 重定向和发送文件共同控制项。 表29 FileRedirectionOptions 参数 参数类型 描述 fluid_control_switch_enable Boolean 是否开启流控开关。取值为: false:表示关闭。 true:表示开启。 fluid_control_options fluid_control_options object 流控控制项。 compression_switch_enable Boolean 是否开启压缩开关。取值为: false:表示关闭。 true:表示开启。 compression_switch_options compression_switch_options object 压缩开关控制项。 linux_file_size_supported_enable Boolean 是否开启Linux支持设置文件大小。取值为: false:表示关闭。 true:表示开启。 linux_file_size_supported_options linux_file_size_supported_options object Linux支持设置文件大小控制项。 linux_root_mount_switch_enable Boolean 是否开启Linux根目录挂载开关。取值为: false:表示关闭。 true:表示开启。 linux_root_dir_list String Linux根目录挂载路径。默认:"\home"。 linux_file_mount_path String Linux文件系统挂载路径。默认:"\media|\Volumes|\swdb\mnt|\home|\storage|\tmp|\run\media"。 linux_fixed_drive_file_system_format String Linux固定驱动器文件系统格式。 linux_removable_drive_file_system_format String Linux可移动驱动器文件系统格式。默认:"vfat|ntfs|msdos|fuseblk|sdcardfs|exfat|fuse.fdredir"。 linux_cdrom_drive_file_system_format String Linux光盘驱动器文件系统格式。默认:"cd9660|iso9660|udf"。 linux_network_drive_file_system_format String Linux网络驱动器文件系统格式。默认:"smbfs|afpfs|cifs"。 path_separator String 路径分隔符。默认:"|"。 fixed_drive_enable Boolean 是否开启固定驱动器(如: 本地磁盘)。取值为: false:表示关闭。 true:表示开启。 removable_drive_enable Boolean 是否开启可移除驱动器(如: U盘)。取值为: false:表示关闭。 true:表示开启。 cd_rom_drive_enable Boolean 是否开启光盘驱动器。取值为: false:表示关闭。 true:表示开启。 network_drive_enable Boolean 是否开启网络驱动器。取值为: false:表示关闭。 true:表示开启。 表30 fluid_control_options 参数 参数类型 描述 good_network_latency Integer 网络优的延时阈值(ms)。取值范围为[1-1000]。默认:30。 normal_network_latency Integer 网络一般的延时阈值(ms)。取值范围为[1-1000]。默认:70。 poor_network_latency Integer 网络差的延时阈值(ms)。取值范围为[1-1000]。默认:100。 reducing_step Integer 降速步伐(KB)。取值范围为[1-100]。默认:20。 slow_increasing_step Integer 慢增速步伐(KB)。取值范围为[1-100]。默认:10。 quick_increasing_step Integer 快增速步伐(KB)。取值范围为[1-100]。默认:20。 start_speed Integer 传输初始速度(KB/s)。取值范围为[1-10240]。默认:1024。 test_block_size Integer 测速块大小(KB)。取值范围为[64-1024]。默认:64。 test_time_gap Integer 测速块时间间隔(ms)。取值范围为[1000-100000]。默认:10000。 表31 compression_switch_options 参数 参数类型 描述 compression_threshold Integer 压缩阈值(Byte)。取值范围为[0-10240]。默认:512。 minimum_compression_rate Integer 最小压缩率。取值范围为[0-1000]。默认:900。 表32 linux_file_size_supported_options 参数 参数类型 描述 linux_file_size_supported_threshold Integer Linux设置文件大小阈值(Byte)。取值范围为[0-4096]。默认:100。 表33 redirection_send_file_options 参数 参数类型 描述 read_write_speed Integer 读写速度(Kbps)。取值范围为[0-2147483647]。默认:0。 表34 clipboard_redirection_options 参数 参数类型 描述 rich_text_redirection_enable Boolean 是否开启剪切板富文本重定向。取值为: false:表示关闭。 true:表示开启。 rich_text_clipboard_redirection String 剪切板富文本重定向。取值为: DISABLED:表示禁用。(默认) SERVER_TO_CLIENT_ENABLED:表示开启服务端到客户端。 CLIENT_TO_SERVER_ENABLED:表示开启客户端到服务端。 TWO_WAY_ENABLED:表示开启双向。 clipboard_file_redirection_enable Boolean 是否开启剪切板文件重定向。取值为: false:表示关闭。 true:表示开启。 file_clipboard_redirection String 剪切板文件重定向。取值为: DISABLED:表示禁用。(默认) SERVER_TO_CLIENT_ENABLED:表示开启服务端到客户端。 CLIENT_TO_SERVER_ENABLED:表示开启客户端到服务端。 TWO_WAY_ENABLED:表示开启双向。 clipboard_length_limit_cts_enable Boolean 本地到虚拟机长度限制开关。取值为: false: 标识关闭。 ture: 标识开启。 clipboard_length_limit_cts Integer 本地到虚拟机长度限制。 clipboard_length_limit_stc_enable Boolean 虚拟机到本地到长度限制开关。取值为: false: 标识关闭。 ture: 标识开启。 clipboard_length_limit_stc Integer 虚拟机到本地长度限制。 表35 Session 参数 参数类型 描述 sbc Sbc object SBC结构体。 表36 Sbc 参数 参数类型 描述 sbc_automatic_disconnection String 连接策略: DISABLED:已禁用 AUTO_DISCONNECT:自动断开 AUTO_LOCK:自动锁屏 sbc_automatic_disconnection_options SbcAutomaticDisconnectionOptions object 自动连接选项。 表37 SbcAutomaticDisconnectionOptions 参数 参数类型 描述 disconnection_waiting_time Integer 等待时间(分钟)。 sbc_auto_logout Boolean 是否自动注销。取值为:false:表示是。true:表示否。 auto_logout_options AutoLogoutOptions object 自动注销。 表38 AutoLogoutOptions 参数 参数类型 描述 sbc_logout_waiting_time Integer 会话断连保留时长(分钟)。 表39 VirtualChannel 参数 参数类型 描述 virtual_channel_control_enable Boolean 是否开启虚拟通道策略设置。取值为:false:表示关闭。true:表示开启。 options VirtualChannelOptions object 虚拟通道策略控制的选项。 表40 VirtualChannelOptions 参数 参数类型 描述 custom_virtual_channel_name String 自定义虚拟通道注册名。 virtual_channel_plugin_details String 虚拟通道下载配置信息,需Base64加密。 third_party_plugin_name String 第三方插件名称。 表41 keyboard_mouse 参数 参数类型 描述 mouse_feedback String 虚拟机鼠标回馈。取值为: SELFADAPTION:自适应鼠标回馈。 FORCE:强制鼠标回馈。 CLOSE:关闭鼠标回馈。 mouse_simulation_mode String 虚拟机鼠标模拟方式。取值为: ABSOLUTE_POSITION:绝对位置模拟。 RELATIVE_POSITION:相对位置模拟。 external_cursor_feedback Boolean 虚拟机外部光标反馈。取值为: false:表示关闭。 true:表示开启。 表42 Bandwidth 参数 参数类型 描述 intelligent_data_transport_flag String 智能显示传输。取值为:DISABLE:表示关闭。ENABLE:表示开启。DIAGNOSTIC:诊断模式。 total_bandwidth_control_enable Boolean 是否开启总带宽控制。取值为:false:表示关闭。true:表示开启。 options TotalBandwidthControlOptions object 总带宽控制的选项。 display_bandwidth_control_enable Boolean 是否开启显示带宽控制。取值为:false:表示关闭。true:表示开启。 display_bandwidth_control_options DisplayBandwidthControlOptions object 显示带宽控制的选项。 multimedia_bandwidth_control_enable Boolean 是否开启多媒体带宽控制。取值为:false:表示关闭。true:表示开启。 multimedia_bandwidth_control_options MultimediaBandwidthControlOptions object 多媒体带宽控制的选项。 usb_bandwidth_control_enable Boolean 是否开启USB带宽控制。取值为:false:表示关闭。true:表示开启。 usb_bandwidth_control_options UsbBandwidthControlOptions object USB带宽控制的选项。 pcsc_bandwidth_control_enable Boolean 是否开启P CS C控制。取值为:false:表示关闭。true:表示开启。 pcsc_bandwidth_control_options PcscBandwidthControlOptions object PCSC带宽控制的选项。 twain_bandwidth_control_enable Boolean 是否开启TWAIN带宽控制。取值为:false:表示关闭。true:表示开启。 twain_bandwidth_control_options TwainBandwidthControlOptions object TWAIN带宽控制的选项。 printer_bandwidth_control_enable Boolean 是否开启打印机带宽控制。取值为:false:表示关闭。true:表示开启。 printer_bandwidth_control_options PrinterBandwidthControlOptions object 打印机带宽控制的选项。 com_bandwidth_control_enable Boolean 是否开启串口带宽控制。取值为:false:表示关闭。true:表示开启。 com_bandwidth_control_options ComBandwidthControlOptions object 串口带宽控制的选项。 file_redirection_bandwidth_control_enable Boolean 是否开启文件重定向带宽控制。取值为:false:表示关闭。true:表示开启 file_redirection_bandwidth_control_options FileRedirectionBandwidthControlOptions object 文件重定向带宽控制的选项。 clipboard_bandwidth_control_enable Boolean 是否开启剪切板带宽控制。取值为:false:表示关闭。true:表示开启。 clipboard_bandwidth_control_options ClipboardBandwidthControlOptions object 剪切板带宽控制的选项。 secure_channel_bandwidth_control_enable Boolean 是否开启安全通道带宽控制。取值为:false:表示关闭。true:表示开启。 secure_channel_bandwidth_control_options SecureChannelBandwidthControlOptions object 安全通道带宽控制的选项。 camera_bandwidth_control_enable Boolean 是否开启摄像头带宽控制。取值为:false:表示关闭。true:表示开启。 camera_bandwidth_control_options CameraBandwidthControlOptions object 摄像头带宽控制的选项。 virtual_channel_bandwidth_control_enable Boolean 是否开启虚拟通道带宽控制。取值为:false:表示关闭。true:表示开启。 virtual_channel_bandwidth_control_options VirtualChannelBandwidthControlOptions object 虚拟通道带宽控制的选项。 表43 TotalBandwidthControlOptions 参数 参数类型 描述 total_bandwidth_control_value Integer 总带宽控制量(Kbps)。取值范围为[10000-1000000]。默认:30000。 display_bandwidth_percentage_enable Boolean 显示带宽百分比控制。取值为:false:表示关闭。true:表示开启。 display_bandwidth_percentage_options DisplayBandwidthPercentageOptions object 显示带宽百分比控制的选项。 multimedia_bandwidth_percentage_enable Boolean 多媒体带宽百分比控制。取值为:false:表示关闭。true:表示开启。 multimedia_bandwidth_percentage_options MultimediaBandwidthPercentageOptions object 多媒体带宽百分比控制的选项。 usb_bandwidth_percentage_enable Boolean USB带宽百分比控制。取值为:false:表示关闭。true:表示开启。 usb_bandwidth_percentage_options UsbBandwidthPercentageOptions object USB带宽百分比控制的选项。 pcsc_bandwidth_percentage_enable Boolean PCSC带宽百分比控制。取值为:false:表示关闭。true:表示开启。 pcsc_bandwidth_percentage_options PcscBandwidthPercentageOptions object PCSC带宽百分比控制的选项。 twain_bandwidth_percentage_enable Boolean TWAIN带宽百分比控制。取值为:false:表示关闭。true:表示开启。 twain_bandwidth_percentage_options TwainBandwidthPercentageOptions object TWAIN带宽百分比控制的选项。 printer_bandwidth_percentage_enable Boolean 打印机带宽百分比控制。取值为:false:表示关闭。true:表示开启。 printer_bandwidth_percentage_options PrinterBandwidthPercentageOptions object 打印机带宽百分比控制的选项。 com_bandwidth_percentage_enable Boolean 串口带宽百分比控制。取值为:false:表示关闭。true:表示开启。 com_bandwidth_percentage_options ComBandwidthPercentageOptions object 串口带宽百分比控制的选项。 file_redirection_bandwidth_percentage_enable Boolean 文件重定向带宽百分比控制。取值为:false:表示关闭。true:表示开启。 file_redirection_bandwidth_percentage_options FileRedirectionBandwidthPercentageOptions object 文件重定向带宽百分比控制的选项。 clipboard_bandwidth_percentage_enable Boolean 剪切板带宽百分比控制。取值为:false:表示关闭。true:表示开启。 clipboard_bandwidth_percentage_options ClipboardBandwidthPercentageOptions object 剪切板带宽百分比控制的选项。 secure_channel_bandwidth_percentage_enable Boolean 安全通道带宽百分比控制。取值为:false:表示关闭。true:表示开启。 secure_channel_bandwidth_percentage_options SecureChannelBandwidthPercentageOptions object 安全通道带宽百分比控制的选项。 camera_bandwidth_percentage_enable Boolean 摄像头带宽百分比控制。取值为:false:表示关闭。true:表示开启。 camera_bandwidth_percentage_options CameraBandwidthPercentageOptions object 摄像头带宽百分比控制的选项。 virtual_channel_bandwidth_percentage_enable Boolean 虚拟通道带宽百分比控制。取值为:false:表示关闭。true:表示开启。 virtual_channel_bandwidth_percentage_options VirtualChannelBandwidthPercentageOptions object 虚拟通道带宽百分比控制的选项。 表44 DisplayBandwidthPercentageOptions 参数 参数类型 描述 display_bandwidth_percentage_value Integer 显示带宽百分比控制量(%)。取值范围为[0-100]。默认:65。 表45 MultimediaBandwidthPercentageOptions 参数 参数类型 描述 multimedia_bandwidth_percentage_value Integer 多媒体带宽百分比控制量(%)。取值范围为[0-100]。默认:50。 表46 UsbBandwidthPercentageOptions 参数 参数类型 描述 usb_bandwidth_percentage_value Integer USB带宽百分比控制量(%)。取值范围为[0-100]。默认:100。 表47 PcscBandwidthPercentageOptions 参数 参数类型 描述 pcsc_bandwidth_percentage_value Integer PCSC带宽百分比控制量(%)。取值范围为[0-100]。默认:5。 表48 TwainBandwidthPercentageOptions 参数 参数类型 描述 twain_bandwidth_percentage_value Integer TWAIN带宽百分比控制量(%)。取值范围为[0-100]。默认:15。 表49 PrinterBandwidthPercentageOptions 参数 参数类型 描述 printer_bandwidth_percentage_value Integer 打印机带宽百分比控制量(%)。取值范围为[0-100]。默认:5。 表50 ComBandwidthPercentageOptions 参数 参数类型 描述 com_bandwidth_percentage_value Integer 串口带宽百分比控制量(%)。取值范围为[0-100]。默认:3。 表51 FileRedirectionBandwidthPercentageOptions 参数 参数类型 描述 file_redirection_bandwidth_percentage_value Integer 文件重定向带宽百分比控制量(%)。取值范围为[0-100]。默认:30。 表52 ClipboardBandwidthPercentageOptions 参数 参数类型 描述 clipboard_bandwidth_percentage_value Integer 剪切板带宽百分比控制量(%)。取值范围为[0-100]。默认:3。 表53 SecureChannelBandwidthPercentageOptions 参数 参数类型 描述 secure_channel_bandwidth_percentage_value Integer 安全通道带宽百分比控制量(%)。取值范围为[0-100]。默认:30。 表54 CameraBandwidthPercentageOptions 参数 参数类型 描述 camera_bandwidth_percentage_value Integer 摄像头带宽百分比控制量(%)。取值范围为[0-100]。默认:30。 表55 VirtualChannelBandwidthPercentageOptions 参数 参数类型 描述 virtual_channel_bandwidth_percentage_value Integer 虚拟通道带宽百分比控制量(%)。取值范围为[0-100]。默认:65。 表56 DisplayBandwidthControlOptions 参数 参数类型 描述 display_bandwidth_control_value Integer 显示带宽控制量(Kbps)。取值范围为[500-50000]。默认:20000。 表57 MultimediaBandwidthControlOptions 参数 参数类型 描述 multimedia_bandwidth_control_value Integer 多媒体带宽控制量(Kbps)。取值范围为[5000-20000]。默认:15000。 表58 UsbBandwidthControlOptions 参数 参数类型 描述 usb_bandwidth_control_value Integer USB带宽控制量(Kbps)。取值范围为[1000-30000]。默认:30000。 表59 PcscBandwidthControlOptions 参数 参数类型 描述 pcsc_bandwidth_control_value Integer PCSC带宽控制量(Kbps)。取值范围为[1000-5000]。默认:2000。 表60 TwainBandwidthControlOptions 参数 参数类型 描述 twain_bandwidth_control_value Integer TWAIN带宽控制量(Kbps)。取值范围为[2000-10000]。默认:5000。 表61 PrinterBandwidthControlOptions 参数 参数类型 描述 printer_bandwidth_control_value Integer 打印机带宽控制量(Kbps)。取值范围为[1000-5000]。默认:2000。 表62 ComBandwidthControlOptions 参数 参数类型 描述 com_bandwidth_control_value Integer 串口带宽控制量(Kbps)。取值范围为[500-2000]。默认:1000。 表63 FileRedirectionBandwidthControlOptions 参数 参数类型 描述 file_redirection_bandwidth_control_value Integer 文件重定向带宽控制量(Kbps)。取值范围为[500-20000]。默认:10000。 表64 ClipboardBandwidthControlOptions 参数 参数类型 描述 clipboard_bandwidth_control_value Integer 剪切板带宽控制量(Kbps)。取值范围为[100-2000]。默认:1000。 表65 SecureChannelBandwidthControlOptions 参数 参数类型 描述 secure_channel_bandwidth_control_value Integer 安全通道带宽控制量(Kbps)。取值范围为[500-20000]。默认:10000。 表66 CameraBandwidthControlOptions 参数 参数类型 描述 camera_bandwidth_control_value Integer 摄像头带宽控制量(Kbps)。取值范围为[0-10000]。默认:10000。 表67 VirtualChannelBandwidthControlOptions 参数 参数类型 描述 virtual_channel_bandwidth_control_value Integer 虚拟通道带宽控制量(Kbps)。取值范围为[500-20000]。默认:20000。 表68 custom 参数 参数类型 描述 custom_configuration1_enable Boolean 自定义策略配置项1: false: 表示关闭 true: 表示开启 options CustomOptions object 自定义策略设置项。 表69 CustomOptions 参数 参数类型 描述 custom_configuration1_rule String 配置项1内容。 状态码: 400 表70 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 401 表71 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 403 表72 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 404 表73 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 405 表74 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 500 表75 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 503 表76 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。
  • 响应示例 状态码: 200 成功响应。 { "count" : 2, "items" : [ { "id" : "394", "connect_type" : "2", "user_name" : "user001@wksapp***.huawei.com", "pre_conn_time" : "2023-06-05T03:34:43Z", "start_time" : "2023-06-05T06:37:47Z", "machine_sid" : "S-1-5-21-1213649063-4191095369-2401105760-1418", "machine_name" : "APS-XS1QJ3TA7T", "failed_reason" : "", "failed_code" : "", "client_mac" : "c8-d9-d2-**-3a-57", "client_name" : "Y002516E2p1", "client_ip" : "10.*73.108.206", "client_version" : "23.2.2.0", "client_type" : "Windows 10", "agent_version" : "23.2.2.0423", "vm_ip" : "10.*.248.130", "connect_flag" : "0", "wi_ip" : "192.**.10.*00\\#192.**.10.23", "update_time" : "2023-06-05T06:37:47Z", "tenant_id" : "a4da8115c9d8464ead3a38309130523f", "virtual_ip" : "" }, { "id" : "112", "connect_type" : "2", "user_name" : "nas01@wksapp***.huawei.com", "pre_conn_time" : "2023-05-23T09:10:03Z", "start_time" : "2023-05-23T09:10:04Z", "end_time" : "2023-05-23T09:16:15Z", "machine_sid" : "S-1-5-21-1213649063-4191095369-2401105760-1395", "machine_name" : "APS-Z5OV9E157G", "failed_reason" : "", "failed_code" : "", "client_mac" : "68-05-ca-**-c7-98", "client_name" : "kdjhfkjhdghschd", "client_ip" : "10.**.**.151", "client_version" : "23.5.0.0", "client_type" : "Windows 10", "agent_version" : "23.5.0.0519", "vm_ip" : "10.*.83.5", "connect_flag" : "0", "wi_ip" : "192.**.10.*00\\#192.**.10.23", "update_time" : "2023-05-23T09:16:15Z", "tenant_id" : "a4da8115c9d8464ead3a38309130523f", "virtual_ip" : "" } ] }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 count Integer 总数。 items Array of UserConnectionInfo objects 应用使用记录列表。 表6 UserConnectionInfo 参数 参数类型 描述 id String 主键。 connect_type String 连接类型。 user_name String 登录用户。 desktop_group_name String 桌面组名。 pre_conn_time String 预连接时间。 start_time String 开始时间。 end_time String 结束时间。 machine_sid String 应用服务器sid。 machine_name String 应用服务器名称。 failed_reason String 连接失败原因。 failed_code String 连接失败状态码。 client_mac String 客户端Mac。 client_name String 客户端名称。 client_ip String 客户端ip。 client_version String 客户端版本。 client_type String 客户端操作系统类型。 agent_version String aps hda版本。 vm_ip String 应用服务器ip。 connect_flag String 连接标志。 wi_ip String 连接IP。 update_time String 更新时间。 tenant_id String 租户id。 virtual_ip String 会话虚拟ip。 状态码: 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 错误描述。 状态码: 415 表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 错误描述。
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表4 请求Body参数 参数 是否必选 参数类型 描述 id 否 String 登录记录唯一标识ID。 connect_type 否 String 用户连接类别。 user_name 否 String 登录用户名称。 machine_sid 否 String 应用服务器sid。 machine_name 否 String 应用服务器名称。 failed_reason 否 String 连接失败原因。 failed_code 否 String 连接失败状态码。 client_name 否 String 客户端名称。 client_version 否 String 客户端版本。 client_type 否 String 客户端操作系统类型。 agent_version 否 String aps hda版本。 vm_ip 否 String 应用服务器ip。 connect_flag 否 String 连接标志,目前值为0。 wi_ip 否 String 连接IP。 update_time 否 String 登录应用开始时间,格式 2022-10-31 08:07:39。 tenant_id 否 String 租户id。 login_start_time 否 String 登录应用开始时间,格式 2022-10-31 08:07:39。 login_end_time 否 String 登录应用结束时间,格式 2022-10-31 08:07:39。 virtual_ip 否 String 会话虚拟ip。
  • 响应示例 状态码: 200 成功响应。 { "job" : { "job_id" : "575768277444198400", "job_type" : 1, "job_status" : 0, "sub_jobs" : [ { "job_id" : "575768277481947136", "job_type" : 2, "job_status" : 0, "entities" : [ ], "begin_time" : "2023-06-06T02:30:06Z", "end_time" : "2023-06-06T02:45:49Z" } ], "begin_time" : "2023-06-06T02:30:06Z", "end_time" : "2023-06-06T02:45:49Z", "expected_end_time" : "2023-06-06T15:55:57Z", "execute_code" : "", "execute_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 表3 响应Body参数 参数 参数类型 描述 tags Array of Tags objects 标签对象 表4 Tags 参数 参数类型 描述 key String 标签key。 values Array of strings 标签value。 状态码: 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 错误描述。 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。
  • URI GET /v1/{project_id}/app-groups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 单次查询的大小[1-100]。 offset 否 Integer 查询的偏移量。 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
  • 响应参数 状态码: 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 } ] }
  • 响应示例 状态码: 200 成功响应。 { "volume_types" : [ { "resource_spec_code" : "workspace.volume.high", "volume_type" : "SAS", "volume_product_type" : "workspace", "resource_type" : "hws.resource.type.workspace.volume", "cloud_service_type" : "hws.service.type.vdi", "name" : [ { "language" : "en-us", "value" : "High IO Disk" }, { "language" : "zh-cn", "value" : "高IO磁盘" } ], "volume_type_extra_specs" : { "availability_zone" : "cn-north-5b,cn-north-5c,cn-north-5a", "sold_out_availability_zone" : "" } } ] }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 items 是 Array of UserAssignment objects 存储分配目标。 表4 UserAssignment 参数 是否必选 参数类型 描述 attach 是 String 目标用户。 policy_statement_id 是 String 策略ID。
  • 响应参数 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 405 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 503 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。
  • 请求示例 POST /v1/a4da8115c9d8464ead3a38309130523f/persistent-storages/540353390023016448/actions/assign-folder { "items" : [ { "attach" : "USER001***@local.com", "policy_statement_id" : "1" } ] }
  • 响应示例 状态码: 200 成功响应。 { "count" : 4, "items" : [ { "policy_statement_id" : "DEFAULT_4", "actions" : null, "roam_actions" : [ "GetObject" ] }, { "policy_statement_id" : "DEFAULT_3", "actions" : [ "PutObject", "DeleteObject" ], "roam_actions" : [ "PutObject", "DeleteObject", "GetObject" ] }, { "policy_statement_id" : "DEFAULT_2", "actions" : [ "GetObject" ], "roam_actions" : [ "PutObject", "DeleteObject", "GetObject" ] }, { "policy_statement_id" : "DEFAULT_1", "actions" : [ "PutObject", "DeleteObject", "GetObject" ], "roam_actions" : [ "PutObject", "DeleteObject", "GetObject" ] } ] }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数。 items Array of PolicyStatement objects 支持的访问策略。 表5 PolicyStatement 参数 参数类型 描述 policy_statement_id String 支持的访问策略,内置如下四种策略: DEFAULT_1:客户端访问存储 - 上传、下载; 云端访问存储 - 读写。 action: PutObject、DeleteObject、GetObject roam_action: PutObject、DeleteObject、GetObject DEFAULT_2:客户端访问存储 - 下载; 云端访问存储 - 读写。 action: GetObject roam_action: PutObject、DeleteObject、GetObject DEFAULT_3:客户端访问存储 - 上传; 云端访问存储 - 读写。 action: PutObject、DeleteObject roam_action: PutObject、DeleteObject、GetObject DEFAULT_4:客户端访问存储 - 仅可查看列表,不允许上传下载; 云端访问存储 - 只读。 action: roam_action: GetObject actions Array of strings 客户端访问存储可操作的权限合集。 PutObject - 上传、修改、重命名、移动。 GetObject - 下载。 DeleteObject - 删除。 roam_actions Array of strings 云端访问存储可操作的权限合集。 PutObject - 上传、修改、重命名、移动。 GetObject - 下载。 DeleteObject - 删除。 状态码: 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 查询策略应用对象的响应。 { "targets" : [ { "target_id" : "S-1-5-21-1065092785-1316984780-3147557180-9999", "target_type" : "USER", "target_name" : "All-Targets-123" }, { "target_id" : "192.168.1.1", "target_type" : "CLIENTIP", "target_name" : "192.168.1.1" } ] }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 targets Array of Target objects 应用对象列表。 表5 Target 参数 参数类型 描述 target_id String 对象ID。 target_name String 对象名称。 target_type String 对象类型。 USER:表示用户。 target_id:为用户ID。 target_name:为用户name。 USERGROUP:表示用户组。 target_id:为用户组ID。 target_name:为用户组name。 APPGROUP:应用组。 target_id:应用组id。 target_name:应用组名称。 OU:组织单元。 target_id:OUID。 target_name:OU名称。 ALL:表示所有。 target_id:default-apply-all-targets。 target_name:All-Targets。 状态码: 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 /v1/{project_id}/policy-groups/{policy_group_id}/target 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 policy_group_id 是 String 策略组id。 表2 Query参数 参数 是否必选 参数类型 描述 target_type 否 String 应用对象的类型: USER:表示用户。 USERGROUP:表示用户组。 APPGROUP:应用组。 OU:组织单元。 ALl:所有类型
  • 响应示例 状态码: 200 成功响应。 { "products" : [ { "product_id" : "workspace.appstream.general.2xlarge.2", "flavor_id" : "s2.xlarge.2", "type" : "BASE", "architecture" : "x86", "cpu" : "4", "memory" : "8192", "is_gpu" : false, "descriptions" : "s2.xlarge.2 云应用通用型|4核|8GB内存", "charge_mode" : "0", "resource_type" : "hws.resource.type.workspace.appstream", "cloud_service_type" : "hws.service.type.vdi", "volume_product_type" : "workspace", "sessions" : 10, "status" : "abandon", "cond_operation_az" : "cn-north-7c(abandon),cn-north-7b(abandon),cn-north-7a(sellout)", "domain_ids" : [ ], "package_type" : "general" } ] }
  • URI GET /v1/{project_id}/product 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目唯一标识。 表2 Query参数 参数 是否必选 参数类型 描述 product_id 否 String 如果不为空,将按产品ID进行过滤后返回。 flavor_id 否 String 如果不为空,将按规格ID进行过滤后返回。 availability_zone 否 String 可用分区,如果不为空,将按可用分区进行过滤后返回。 获取方式详见可用区管理ListAvailabilityZone:"GET /v1/{project_id}/availability-zone"。 os_type 否 String 产品套餐的操作系统类型,当前支持:Windows。 Linux Windows Other charge_mode 否 String 套餐标识。 1:表示包周期。 0:表示按需。 architecture 否 String 架构类型,当前支持:x86。 x86 arm package_type 否 String 套餐类型: general:表示产品通用套餐。 dedicated:表示产品专属主机套餐。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 availability_zone String 可用分区。将服务创建到指定的可用分区。如果不指定则使用系统随机的可用分区。 os_type String 系统类型,当前仅支持Windows。 Linux - Windows - Other - products Array of ProductInfo objects 产品列表。 表5 ProductInfo 参数 参数类型 描述 product_id String 产品id。 flavor_id String 规格ID。 type String 产品类型。 BASE:表示产品基础套餐,套餐镜像中不包括除操作系统之外的其他商业软件,私有镜像场景只能使用此类套餐。 ADVANCED:表示产品高级套餐,套餐镜像中包括了一些商业软件。 architecture String 产品架构,当前仅支持x86。 x86 arm cpu String CPU。 cpu_desc String CPU描述。 memory String 内存大小,单位兆:MB。 is_gpu Boolean 是否是GPU类型的规格。 system_disk_type String 系统盘类型。 system_disk_size String 系统盘大小。 gpu_desc String GPU描述。 descriptions String 产品描述。 charge_mode String 套餐标识。 1:表示包周期。 0:表示按需。 contain_data_disk Boolean 套餐计费是否包含了数据盘。 resource_type String 资源类型。 cloud_service_type String 云服务类型。 volume_product_type String 磁盘产品类型。 sessions Integer 套餐默认支持的最大会话数。 status String 产品套餐在销售模式下的状态,取值自ECS的cond:operation:status。 不配置时等同于normal在售状态。 normal - 正常商用 abandon - 下线(即不显示) sellout - 售罄 obt - 公测 obt_sellout - 公测售罄 promotion - 推荐(等同normal,也是商用) cond_operation_az String 产品套餐在可用区的状态,配套status使用。 说明: 此参数是AZ级配置,优选取此参数的值,某个AZ没有在此参数中配置时默认使用status参数的取值。 配置格式“az(xx)”。()内为某个AZ的flavor状态,()内必须要填有状态,不填为无效配置。 例如:套餐在某个region的az0正常商用,az1售罄,az2公测,az3正常商用,其他az显示下线,可配置为: “status”设置为:“abandon” 。 “cond_operation_az”设置为:“az0(normal), az1(sellout), az2(obt), az3(normal)”。 说明:如果flavor在某个AZ下的状态与status配置状态不同,必须配置该参数。 sub_product_list Array of strings 专属主机的子产品。 domain_ids Array of strings 产品属于专有的domainId。 package_type String 套餐类型: general:表示产品通用套餐。 dedicated:表示产品专属主机套餐。 series_type String 系列类型 expire_time String 产品套餐过期时间,产品将在改时间点后逐步下架。 support_gpu_type String 产品套餐支持的GPU类型。 状态码: 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 成功响应。 { "session_info_list" : [ { "id" : "a7db732e1ad511edaf56fa163ed8e03f", "session_stamp" : "S-1-5-21-1908276142-124560728-768171367-1358-zeng**long@wksapp.****huawei.com-HDP-_1", "protocol_type" : "Hdp", "login_user" : "zeng**long@wksapp.****huawei.com", "session_type" : "1", "pre_conn_time" : "2022-08-13 07:00:20", "start_time" : "2022-08-13 07:00:20", "end_time" : "0001-01-01 00:00:00", "machine_sid" : "S-1-5-21-1908276142-**4560728-768171367-1358", "session_state" : "AppcInit", "client_mac" : "3c-7c-3f-**-e4-04", "client_name" : "proven", "client_ip" : "10.**.**.239", "client_version" : "22.4.2.12888", "client_type" : "Windows 10 Enterprise", "agent_version" : "21.12.0.11461", "vm_ip" : "172.**.**.26", "failed_reason" : "success", "failed_code" : "WKS.00000000", "tenant_id" : "26a0420e9e284569a23f1b2f7d9b5011" }, { "id" : "9d123d5e0f36419c9b345efcd031a92e", "session_stamp" : "S-1-5-21-1908276142-124560728-768171367-3006-zeng**long@wksapp.****huawei.com-HDP-2", "os_session_id" : "2", "protocol_type" : "Hdp", "login_user" : "zeng**long@wksapp.****huawei.com", "session_type" : "2", "app_group_id" : "587004825166675968", "app_server_group_id" : "fb8a92be-ebc1-4dac-9a4c-1590518d140a", "pre_conn_time" : "2023-07-07 03:04:06", "start_time" : "2023-07-07 03:04:06", "end_time" : "0001-01-01 00:00:00", "machine_sid" : "S-1-5-21-1908276142-***560728-768171367-3006", "machine_name" : "APS-6NGU98Y4W4", "session_state" : "AppcInit", "app_name" : "HDTransmission,winlogon,HDTerminalExplorer,slui,HDTerminalAssist,fontdrvhost,TSTheme,ChsIME,ctfmon,csrss,HDTerminalSystem,dwm,ChsIME,sihost,HDTerminalDisplay,TabTip32,svchost,svchost,HDTerminalUser,taskhostw,TabTip", "client_mac" : "3c-7c-3f-**-e4-04", "client_name" : "proven", "client_ip" : "10.*.97.212", "client_version" : "23.2.2.0", "client_type" : "Windows 10 Enterprise", "agent_version" : "23.2.0.0314", "vm_ip" : "172.*.*.41", "failed_reason" : "success", "failed_code" : "WKS.00000000", "tenant_id" : "26a0420e9e284569a23f1b2f7d9b5011" } ] }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 session_info_list Array of AppSession objects 会话信息列表。 表5 AppSession 参数 参数类型 描述 id String 主键ID。 session_stamp String 会话标识。 os_session_id String 会话在hda的os中会话id。 protocol_type String 协议类型。 login_user String 当前会话的登录用户。 session_type String 会话类型,1表示共享桌面,2表示应用。 app_group_id String App组ID。 app_server_group_id String AppServer组ID。 pre_conn_time String 预连接时间。 start_time String 会话开始时间。 end_time String 会话结束时间。 status_continue_time String 状态持续时间。 machine_sid String 服务器SID。。 machine_name String 服务器名称。 session_state String 会话状态。 app_name String 会话中的应用名称。 client_mac String 客户端Mac地址。 client_name String 客户端名称。 client_ip String 客户端IP。 client_version String 客户端版本。 client_type String 客户端类型。 agent_version String agent版本。 vm_ip String 服务器IP。 failed_reason String 错误原因消息。 failed_code String 错误原因码。 last_update_status_time String 状态最后变化时间。 tenant_id String 租户ID 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 405 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 415 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 500 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 503 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。
共100000条