华为云用户手册

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

URI GET /v1/{project_id}/policy-groups/actions/list-policy-group-detail 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 是 Integer 查询的偏移量 limit 是 Integer 查询的数量，值区间[1-100] policy_group_name 否 String 根据策略组名字过滤结果。 policy_group_type 否 Integer 根据策略组类型名字过滤结果。

响应参数 状态码： 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类型。 表3 请求Body参数 参数 是否必选 参数类型 描述 operate_type 否 String 解除项目锁定操作类型。

响应参数 状态码： 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 错误描述。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 is_lock Integer 云办公服务是否被锁定，0代表未锁定，1代表锁定。 lock_time String 云办公服务锁定时间，格式：yyyy-MM-dd HH:mm:ss，时区：UTC。 lock_reason String 云办公服务锁定原因。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

响应参数 状态码： 202 表3 响应Body参数 参数 参数类型 描述 job_id String 注销云办公服务的任务ID。 状态码： 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 错误描述。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

纯量 纯量的数据类型有字符串、布尔值、整数、浮点数、Null、时间、日期。 字符串表示： 字符串默认不使用引号表示： str: This_is_a_line 如果字符串之中包含空格或特殊字符，需要放在引号之中： str: 'content: a string’ 单引号和双引号都可以使用，两者区别是单引号可以识别转义字符：双引号不会对特殊字符转义:↵ s1: 'content:\n a string's2: "content:\n a string" 单引号之中如果还有单引号，必须连续使用两个单引号转义。 str: 'labor''s day' 字符串可以写成多行，从第二行开始，必须有一个单空格缩进。换行符会被转为空格。 str: This_is a_multi_line 整数表示： int_value: 314 浮点型表示： float_value: 3.14 Null表示： parent: ~ 时间表示： 时间采用ISO8601格式。 iso8601: 2018-12-14t21:59:43.10-05:00 日期表示： 日期采用复合ISO8601格式的年、月、日表示。 date: 1976-07-31

数组 数组使用连字符和空格“- ”表示，合法的表示方法如下： animal:- Cat- Dog- Goldfish 也可使用行内表示法： animal: [Cat, Dog, Goldfish] 对象和数组可以嵌套使用，形成复合结构： languages: - Ruby - Perl - Pythonwebsites: YAML: yaml.org Ruby: ruby-lang.org Python: python.org Perl: use.perl.org

volumes配置样例 以下示例，使得每个任务容器会挂载5个共享存储，也就是所有的容器可以看到一样的共享目录。 volumes: genref: mount_path: '${volume-path-ref}' mount_from: pvc: '${BCE_REF_PVC}' #内置变量，基因容器提供的参考组OBS桶 genobs: mount_path: '${volume-path-obs}' mount_from: pvc: '${BCE_DATA_PVC}' #内置变量，环境关联的OBS桶 gensfs: mount_path: '${volume-path-sfs}' mount_from: pvc: '${BCE_SFS_PVC}' #内置变量，加速存储盘 other: mount_path: /home/mydata mount_from: pvc: '${my_k8s_pvc}' # 关联的Kubernetes集群中的任意共享存储（PVC）名字 subdir: mount_path: /home/subdir mount_from: pvc: '${my_k8s_pvc}' sub_path: '${path_var}' #仅挂载共享存储的某个子目录，可以使用inputs变量，如: path_var = abc/def

创建Argo作业 登录BCE控制台，左侧导航栏中选择“作业管理”。 在“Argo”页签下，单击“创建作业”。 配置参数，具体如表1所示。 表1 创建作业 参数 说明 作业名称 输入作业名称。要求如下： 长度范围为4~32个字符。 名称由小写字母、数字、中划线（-）组成。 以小写字母开头。 以小写字母或数字结尾。 队列 选择队列，如果还未创建队列，可单击“创建队列”创建，具体操作请参见队列管理。 任务组件 可将“AI任务”或“HPC任务”用鼠标拖动至画布中。 在画布中，双击“AI任务”或“HPC任务”，编辑任务，编辑完成后，单击“确定”。 编辑AI任务 表2 编辑AI任务 参数 说明 基本信息 任务名称 输入任务名称。 队列 选择队列，如未创建队列，可单击“创建队列”。 任务实例配置 资源类型 默认为Tensorflow，不可修改。 Tensorflow任务是一种基于Tensorflow开源框架的kubernetes自定义资源类型，多种角色可以配置，可更简单地实现Tensorflow的单机或分布式训练 任务实例组合 可根据实际需求选择对应的任务实例组合。 Worker+Evaluator：单节点进行训练，只有Worker角色，可以搭配Evaluator角色使用。 PS+Worker+Evaluator：多节点进行训练，有PS和Worker角色，可以搭配Evaluator角色使用。 PS+Chief+Worker+Evaluator：多节点进行训练，有PS、Chief和Worker角色，可以搭配Evaluator角色使用。 任务实例 角色名称 角色名称此处为默认值，不用输入。 实例数量 输入实例数量。 PS、Worker：这两个角色根据实际情况输入实例数量。 Chief、Evaluator：这两个角色默认实例数量为1，无法输入。 容器配置 容器配置参数，请参见表3。可单击“添加容器”，添加多个容器。 高级配置 失败重试次数 任务的失败重试次数，仅适用于重启策略为OnFailure或Always的pod。 最大存活时长 最大存活时长，从创建任务开始，若超过此时间任务没有执行完成，则任务会视为失败。 结束后保留时长(s) 此处指定时间删除执行完成的任务，可以选择“0~永久”之间的任意时间。 0：表示执行完成后立刻删除。 永久：表示执行完成后永久保留，不删除。 如果不配置，默认为“永久”。 清理策略 任务结束之后，清理pod策略。可根据实际需求选择“清理运行中的Pod”、“清理全部实例”和“不清理”。 表3 容器配置参数说明 参数 说明 基本信息 镜像名称 单击“选择镜像”，从我的镜像、开源镜像中心或共享镜像中选择需要的镜像。 我的镜像：展示了您创建的所有镜像仓库。 开源镜像中心：展示了开源镜像中心仓库中的官方镜像。 共享镜像：其他租户通过“容器镜像服务”共享给您的镜像将在此处展示，您可以基于共享镜像创建工作负载。 导入的镜像，您可单击“更换镜像”进行更换。 * 镜像版本 选择需要部署的镜像版本。 * 容器名称 容器的名称，可修改。 特权容器 特权容器是指容器里面的程序具有一定的特权。 若选中，容器将获得超级权限，例如可以操作宿主机上面的网络设备、修改内核参数等。 CPU配额 容器需要使用的最小CPU值，默认0.5 核。 内存配额 容器需要使用的内存最小值，默认1 GB。 生命周期 启动命令 设置容器启动时执行的命令。 启动后处理 设置容器成功运行后执行的命令，详细配置方法请参见设置容器生命周期。 停止前处理 设置容器结束前执行的命令，通常用于删除日志/临时文件等，详细配置方法请参见设置容器生命周期。 容器端口 端口名称 输入端口名称，默认为port-1。 容器端口 输入端口，默认为22。 端口协议 选择端口协议，默认为TCP。 环境变量 手动添加 输入变量名称、变量/变量引用。 对于已设置的环境变量，可以进行修改或者删除。 容器存储 手动添加 可选参数，如果要挂载使用对象存储服务提供的并行文件系统，则单击“添加存储挂载”。 文件系统名称：在下拉列表中根据名称选择要使用的并行文件系统。 挂载路径：根据实际情况填入挂载目录，例如/dir/test。 编辑HPC任务 表4 编辑HPC任务 参数 说明 任务名称 输入任务名称。 最小实例 输入最小实例个数。 任务实例配置 添加角色 可单击“添加角色”，添加多个角色。 角色名称 输入角色名称。要求如下： 长度范围为1~10个字符。 名称由小写字母、数字、中划线（-）和点（.）组成。 中划线（-）和点（.）必须以字母或数字隔开。 以小写字母开头和结尾。 实例数量 输入实例数量。 容器配置 容器配置参数，请参见表5。 可单击“添加容器”，添加多个容器。 表5 容器配置参数说明 参数 说明 基本信息 镜像名称 单击“选择镜像”，从我的镜像、开源镜像中心或共享镜像中选择需要的镜像。 我的镜像：展示了您创建的所有镜像仓库。 开源镜像中心：展示了开源镜像中心仓库中的官方镜像。 共享镜像：其他租户通过“容器镜像服务”共享给您的镜像将在此处展示，您可以基于共享镜像创建工作负载。 导入的镜像，您可单击“更换镜像”进行更换。 镜像版本 选择需要部署的镜像版本。 容器名称 容器的名称，可修改。 CPU配额 容器需要使用的最小CPU值，默认0.5 核。 内存配额 容器需要使用的内存最小值，默认1 GB。 生命周期 启动命令 设置容器启动时执行的命令。 启动后处理 设置容器成功运行后执行的命令，详细配置方法请参见设置容器生命周期。 停止前处理 设置容器结束前执行的命令，通常用于删除日志/临时文件等，详细配置方法请参见设置容器生命周期。 容器端口 端口名称 输入端口名称，默认为port-1。 容器端口 输入端口，默认为22。 端口协议 选择端口协议，默认为TCP。 环境变量 手动添加 输入变量名称、变量/变量引用。 对于已设置的环境变量，可以进行修改或者删除。 容器存储 手动添加 可选参数，如果要挂载使用对象存储服务提供的并行文件系统，则单击“添加存储挂载”。 文件系统名称：在下拉列表中根据名称选择要使用的并行文件系统。 挂载路径：根据实际情况填入挂载目录，例如/dir/test 单击“下一步：规格确认”，确认任务规格。 单击“创建任务”，任务创建成功。

模板示例 version: genecontainer_0_1inputs: #设置流程变量 sample: #变量名 default: sample1 type: string description: 变量描述，支持中文 label: basicworkflow: #设置流程顺序 test-job-a: tool: busybox:latest type: GCS.Job resources: memory: 4G commands_iter: # {item} 为GCS内置变量，表示并发任务的 index，需要的时候选用 command: sleep 10; touch /obs/test-job/${sample}.${item}.${1}.txt vars_iter: - [0,1] test-job-b: tool: busybox:latest type: GCS.Job resources: memory: 4G commands: - sleep 10; touch /obs/test-job/${sample}.job-b.txt depends: - target: test-job-a #表示依赖另一个步骤，默认依赖类型: wholevolumes: #设置挂载共享存储 genobs: mount_path: /obs mount_from: pvc: '${GCS_DATA_PVC}' #OBS数据桶outputs: #设置最终结果 result-txt: #结果文件 paths_iter: path: /obs/test-job/${sample}.${item}.${1}.txt vars_iter: - [0,1]

模板结构 基因容器语法结构请参见表1。 表1 模板组成元素 参数 是否必选 参数类型 参数描述 version 是 string 流程文件的版本。当前支持为 genecontainer_0_1。 inputs 否 Map 整个流程的可变量。可以定义多个，在执行的时候设置这些变量的实际值。 workflow 是 Map 定义完整流程包含的各个步骤，以及步骤之间的依赖关系。 volumes 否 Map 定义任务挂载共享存储的挂载路径。 outputs 否 Map 定义流程最终生成的文件列表。用于界面展示使用。

示例流程 图1 给用户授予BCE权限流程 创建用户组并授权 在IAM控制台创建用户组，并授予容器批量计算只读权限“BCE ReadOnlyAccess”。 创建用户并加入用户组 在IAM控制台创建用户，并将其加入1中创建的用户组。 用户登录并验证权限 新创建的用户登录控制台，切换至授权区域，验证权限（假设当前权限仅包含BCE ReadOnlyAccess）。 在“服务列表”中选择容器批量计算，进入BCE主界面，执行除查询以外的其他操作，如：创建、修改、删除等。 示例：单击右上角“创建作业”，若提示权限不足，表示“BCE ReadOnlyAccess”已生效。 在“服务列表”中选择除容器批量计算外的任意一个服务，如“虚拟私有云”，若提示权限不足，表示“BCE ReadOnlyAccess”已生效。

BCE自定义策略样例 示例1：配置BCE FullAccess策略，该策略有依赖，具体说明请参见权限管理。 { "Version": "1.1", "Statement": [ { "Action": [ "swr:repository:getTag", "swr:repository:getRepository", "swr:repository:getNamespace", "swr:repository:listNamespaces", "swr:repository:listTags", "swr:repository:listRepositories" ], "Effect": "Allow" }, { "Action": [ "bce:*:*", "cce:cluster:get", "cce:cluster:list", "cce:node:get", "cce:node:list", "cce:storage:create", "cce:storage:list", "CCI:namespace:get", "CCI:namespace:list", "CCI:namespaceSubResource:Create", "CCI:namespaceSubResource:Delete", "CCI:namespaceSubResource:Get", "CCI:namespaceSubResource:List", "CCI:namespaceSubResource:Update", "CCI:network:get", "CCI:network:list", "rds:database:list", "rds:instance:list", "vpc:vpcs:get", "vpc:subnets:get", "vpc:vpcs:list", "evs:volumes:list", "sfs:shares:getAllSharesDetail", "sfs:shares:ShareAction", "evs:volumes:get" ], "Effect": "Allow" } ]} 示例2：配置BCE ReadOnlyAccess策略，该策略有依赖，具体说明请参见权限管理。 { "Version": "1.1", "Statement": [ { "Action": [ "swr:repository:getTag", "swr:repository:getRepository", "swr:repository:getNamespace", "swr:repository:listNamespaces", "swr:repository:listTags", "swr:repository:listRepositories" ], "Effect": "Allow" }, { "Action": [ "bce:*:list", "bce:*:get", "cce:cluster:get", "cce:cluster:list", "cce:node:get", "cce:node:list", "cce:storage:list", "CCI:namespace:get", "CCI:namespace:list", "CCI:namespaceSubResource:Get", "CCI:namespaceSubResource:List", "CCI:network:get", "CCI:network:list", "rds:database:list", "rds:instance:list", "vpc:vpcs:get", "vpc:subnets:get", "vpc:vpcs:list", "evs:volumes:list", "sfs:shares:getAllSharesDetail", "sfs:shares:ShareAction", "evs:volumes:get" ], "Effect": "Allow" } ]} 示例3：配置BCE CommonOperations策略，该策略有依赖，具体说明请参见权限管理。 { "Version": "1.1", "Statement": [ { "Action": [ "swr:repository:getTag", "swr:repository:getRepository", "swr:repository:getNamespace", "swr:repository:listNamespaces", "swr:repository:listTags", "swr:repository:listRepositories" ], "Effect": "Allow" }, { "Action": [ "bce:*:get", "bce:*:list", "bce:commonWorkflows:*", "bce:commonWorkflowTemplates:*", "bce:executions:*", "bce:executionsExtend:*", "bce:hpcJobs:*", "bce:tfjobs:*", "bce:queues:*", "bce:workflowsExtend:*", "bce:workflows:*", "cce:cluster:get", "cce:cluster:list", "cce:node:get", "cce:node:list", "cce:storage:create", "cce:storage:list", "CCI:namespace:get", "CCI:namespace:list", "CCI:namespaceSubResource:Create", "CCI:namespaceSubResource:Delete", "CCI:namespaceSubResource:Get", "CCI:namespaceSubResource:List", "CCI:namespaceSubResource:Update", "CCI:network:get", "CCI:network:list", "rds:database:list", "rds:instance:list", "vpc:vpcs:get", "vpc:subnets:get", "vpc:vpcs:list", "evs:volumes:list", "sfs:shares:getAllSharesDetail", "sfs:shares:ShareAction", "evs:volumes:get" ], "Effect": "Allow" } ]} 示例4：查询队列列表 { "Version": "1.1", "Statement": [ { "Effect": "Allow", "Action": [ " bce:queues:list " ] } ]} 示例5：拒绝用户删除GCS作业 拒绝策略需要同时配合其他策略使用，否则没有实际作用。用户被授予的策略中，一个授权项的作用如果同时存在Allow和Deny，则遵循Deny优先原则。 如果您给用户授予BCE FullAccess的系统策略，但不希望用户拥有BCE FullAccess中定义的删除GCS作业权限，您可以创建一条拒绝删除GCS作业的自定义策略，然后同时将BCE FullAccess和拒绝策略授予用户，根据Deny优先原则，则用户可以对BCE执行除了删除GCS作业外的所有操作。拒绝策略示例如下： { "Version": "1.1", "Statement": [ { "Action": [ "bce:executions:delete" ], "Effect": "Deny" } ]}

通过模板创建WDL作业 登录BCE控制台，左侧导航栏中选择“作业模板”。 在“WDL作业模板”页签下，在已创建的模板列中，单击“以此版本创建作业”，进入到创建作业的界面。 配置参数，具体如表2所示。 表2 创建作业 参数 说明 作业名称 输入作业名称。要求如下： 长度范围为1~63个字符。 名称由小写字母、数字、中划线（-）组成。 以小写字母开头。 以小写字母或数字结尾。 模板文件 此处默认为2中的模板文件，如果需要更换模板文件，可以单击删除当前模板，重新添加所需的模板。 依赖文件 单击“添加文件”，上传所需的依赖文件。 作业配置 作业配置可以用来定义模板文件中工作流区域的变量值，取值如下： 默认配置：如果您需要修改默认的变量值，则选择“默认配置”，单击“添加文件”，上传JSON文件，执行作业时会读取JSON文件中定义的变量值。示例如下： 模板中定义了Int case = 1 workflow gcs_grammar {... # 选择执行分支，可用分支为 1/2/3，填写其他数字则跳过所有步骤 Int case = 1... JSON文件中可以重新定义Int case = 3 { "gcs_grammar.case": 3} 不启用：选择“不启用”，则执行模板中定义的变量值。 须知： 如果模板中存在未定义的变量值，则后续执行作业的过程中会报错。 执行参数 执行参数为执行作业时为引擎配置的执行指令，取值如下： 默认配置： 执行结果写缓存：如果开启，则执行作业时会将执行结果的输入和输出写入缓存中。 执行任务检查缓存：如果开启，则执行作业时接到输入指令，会优先去缓存中读取输出结果，如果存在结果，则不会重复执行该指令。 该功能使您可以通过管理控制台快速定义“执行结果写缓存”和“执行任务检查缓存”的取值，可以选择默认、开启、关闭。 如果选择开启，JSON示例如下： { "write_to_cache": true, "read_from_cache": true} 自定义配置：如果您需要定义更多引擎的执行指令，可以选择“自定义配置”，单击“添加文件”，上传JSON文件，执行作业时会读取JSON文件中定义的指令。更多指令请参见Workflow Options Overview。 不启用：选择“不启用”，则执行引擎默认的指令。 单击“创建”，即可创建作业。

创建WDL作业 登录BCE控制台，左侧导航栏中选择“作业管理”。 在“WDL”页签下，单击“创建作业”。 配置参数，具体如表1所示。 表1 创建作业 参数 说明 作业名称 输入作业名称。要求如下： 长度范围为4~64个字符。 名称由小写字母、数字、中划线（-）组成。 以小写字母开头。 以小写字母或数字结尾。 模板文件 是一种遵循GCS流程或者WDL流程描述语法规范的文本文件，用于控制流程的详细步骤。GCS流程的语法规则请参见流程语法参考，WDL的语法规则请参见1.0 specification。 依赖文件 创建WDL作业模板时，单击“添加文件”，可添加依赖文件。 作业配置 可根据实际需求选择“默认配置”或“不启用”。 若选择“默认配置”，可输入配置文件或者单击“添加文件”，上传配置文件。 执行参数 可根据实际需求选择配置执行参数： 默认配置 执行结果写缓存：可根据实际需求选择“默认”、“开启”和“关闭”。 执行任务检查缓存：可根据实际需求选择“默认”、“开启”和“关闭”。 自定义配置：可输入配置文件或者单击“添加文件”，上传配置文件。 不启用：不配置执行参数。 单击“创建”，作业创建成功。

创建GCS作业模板 登录BCE控制台，左侧导航栏中选择“作业模板”，在页面的右端有两个选项卡和“WDL作业模板”可以选择。 选择页面右上角的创建GCS作业模板或者创建WDL作业模板，进入到创建作业模板的界面。 登录BCE控制台，左侧导航栏中选择“作业模板”。 在“GCS作业模板”页签下，单击“创建GCS作业模板”，进入到创建作业模板的界面。 填写模板名称、版本、发布者、描述的字段，并单击“添加文件”上传作业模板文件。 表1 创建作业模板 参数 说明 模板名称 输入流程名称，默认为gcs-{Time+Nnumber}，需要保证该值唯一。 版本 输入版本号，支持多版本（在流程管理界面可以添加版本）。 模板文件 是一种遵循GCS流程或者WDL流程描述语法规范的文本文件，用于控制流程的详细步骤。GCS流程的语法规则请参见流程语法参考，WDL的语法规则请参见1.0 specification。 发布者 输入发布者名称。 描述 输入流程描述信息。 单击“创建”。

创建WDL作业模板 登录BCE控制台，左侧导航栏中选择“作业模板”。 在“WDL作业模板”页签下，单击“创建WDL作业模板”，进入到创建作业模板的界面。 填写模板名称、版本、发布者、描述的字段，并单击“添加文件”上传作业模板文件。 表2 创建作业模板 参数 说明 模板名称 输入流程名称，默认为wdl-{Time+Nnumber}，需要保证该值唯一。 版本 输入版本号，支持多版本（在流程管理界面可以添加版本）。 模板文件 是一种遵循GCS流程或者WDL流程描述语法规范的文本文件，用于控制流程的详细步骤。GCS流程的语法规则请参见流程语法参考，WDL的语法规则请参见1.0 specification。 依赖文件 单击“添加文件”，可添加依赖文件。 发布者 输入发布者名称。 描述 输入流程描述信息。 单击“创建”。

通过模板创建GCS作业 登录BCE控制台，左侧导航栏中选择“作业模板”。 在“GCS作业模板”页签下，在已创建的模板列中，单击“以此版本创建作业”，进入到创建作业的界面。 配置参数，具体如表1所示。 表1 创建作业 参数 说明 作业名称 输入作业名称。要求如下： 长度范围为1~63个字符。 名称由小写字母、数字、中划线（-）组成。 以小写字母开头。 以小写字母或数字结尾。 资源池 选择已创建的资源池，若未创建，单击“创建资源池”。 高速共享存储 选择已创建的高速共享存储，若未创建，单击“创建高速共享存储”。 关联OBS存储 选择关联OBS存储，若未创建，单击“创建OBS存储”。 作业配置 配置“通用配置”和“高级配置”，可单击“添加作业”，添加多个作业。 通用配置 通用配置区域显示模板中inputs区域下的指令，指令的label为basic。 例如： inputs: command: default: "sleep 100000" description: 在容器内执行的命令 type: string label: basic ... 高级配置 高级配置区域显示模板中inputs区域下的指令，指令的label为advanced。 例如： inputs: ... memory: default: 1G description: 容器申请的内存 type: string label: advanced ... 优先级 设置当前任务优先级，优先级范围为[0-999]，数值大的优先执行。 重试次数 任务失败重试次数，重试次数范围为[0-9]，共享资源池默认重试0次。 批次名称 设置当前任务的批次，在执行结果页面可对批次进行过滤和筛选，便于批量操作同一个批次的任务。 超时时间 设置一个可接受的作业模板执行成功的时间，如果到这个时间作业模板没有执行成功，就会停止并且报执行失败。 单击“创建”，即可创建作业。

添加版本 登录BCE控制台，左侧导航栏中选择“作业模板”。 在“GCS作业模板”或“WDL作业模板”页签下，在已创建的模板列中，单击“添加版本”。 配置参数，具体如表1所示。 表1 创建作业模板 参数 说明 模板名称 保持默认值，不可修改。 版本 输入版本号。 模板文件 是一种遵循GCS流程或者WDL流程描述语法规范的文本文件，用于控制流程的详细步骤。GCS流程的语法规则请参见流程语法参考，WDL的语法规则请参见1.0 specification。 依赖文件 WDL作业模板才显示此参数。 单击“添加文件”，可添加依赖文件。 发布者 输入发布者名称。 描述 输入描述信息。 单击“添加”。

作业执行状况 图1 作业执行状况 此卡片主要展示各个作业状态的个数，作业的状态包括执行中、删除中、成功、失败、等待中和其他。 从作业执行状态可以确定当前任务所属阶段，具体说明如表1所示。 表1 任务状态说明 状态 说明 执行中 任务正在执行中。 删除中 任务正在删除中。 成功 任务执行成功，可删除任务。 失败 任务执行失败。 等待中 任务准备执行中。 其他 不同的作业存在不重合的状态，将这些状态统一归类在其他中，例如：已提交任务。

查看共享资源池 创建资源池后，可以通过查看资源池确认资源池的状态和信息。 登录BCE控制台，在左侧导航栏单击“资源池管理”。 在“共享资源池”页签，在资源池卡片中可以查看资源池的名称、资源池状态、VPC名称、VPC网段和命名空间类型。 图1 查看共享资源池 单击资源池名称，进入资源池详情页面。在资源池详情页面可以查看资源池、VPC和子网的详情信息。 图2 资源池详情页 单击命名空间名称、VPC名称和子网名称，可以分别进入云容器实例的命名空间页面、VPC页面、子网页面查看对应的详细信息。 单击“资源池名称”和“资源池描述”后的，可以修改资源池名称和资源池描述信息。

资源池概述 资源池是BCE所需要使用的计算资源的集合。BCE的资源池由云容器实例（Cloud Container Instance，CCI）和云容器引擎（Cloud Container Engine，CCE）提供，分为专属资源池、共享资源池。 三种资源池对比如表1所示。 表1 资源池类型对比 对比项目 专属资源池 共享资源池 能力支撑 专属资源池由云容器引擎CCE支撑，CCE提供高可靠高性能的企业级容器应用管理服务。 共享资源池由云容器实例CCI服务的 Serverless Container（无服务器容器）引擎支撑。 优势 支持Kubernetes社区原生应用和工具，简化云上自动化容器运行环境搭建。 让您无需创建和管理服务器集群即可直接运行容器。 功能 使用云容器引擎，您可以管理集群和节点资源。 使用云容器实例，您不再需要关注集群和服务器，通过简单的配置即可快速创建容器负载。如果基因分析流程是成熟稳定的，建议您使用云容器实例环境，可以省去对资源的关注。 参考文档 云容器引擎用户指导 专属资源池 云容器实例用户指导 共享资源池 父主题： 资源池管理

生成GCS流程示例 该命令将会生成以下模板，并提交基因容器语法解析器： 1 2 3 4 5 6 7 8 910111213141516171819202122232425262728293031323334353637383940414243444546 version: genecontainer_0_1inputs: memory: default: 1g type: string cpu: default: 1c type: string tool: default: bwa:0.7.12 type: string job-script: default: bwa_help.sh type: string jobid: default: bwa-help-2018-0830-171114-00d34 type: string shell: default: sh type: stringworkflow: bwa-help-2018-0830-171114-00d34: tool: bwa:0.7.12 type: GCS.Job resources: memory: ${memory} cpu: ${cpu} commands: - sh /obs/gcscli/bwa-help-2018-0830-171114-00d34/bwa_help.shvolumes: sample-data: mount_path: /obs mount_from: pvc: ${BCE_DATA_PVC} temp-data: mount_path: /sfs mount_from: pvc: ${BCE_SFS_PVC} ref-data: mount_path: /ref mount_from: pvc: ${BCE_REF_PVC}outputs: bwa-help-2018-0830-171114-00d34: path: - /obs/output/bwa-help-2018-0830-171114-00d34

概述 作业管理可查看分析作业模板执行过程数据、状态、进展、结果等信息。您可根据业务需求选择创建Argo作业、WDL作业和GCS作业。 Argo作业、WDL作业和GCS作业的说明如表1所示。 表1 作业说明 作业类型 说明 Argo作业 通过Argo workflow创建的批量计算作业。主要用于创建AI任务和HPC（High Performance Compute）任务。广泛应用于高性能计算、图片处理、美颜、游戏AGI、科学计算等领域。 WDL作业 通过Cromwell可以将WDL（Workflow Description Language）描述的workflow运行在CCI容器中。您只需为作业运行时实际消耗的计算和存储资源付费，不需要支付资源之外的附加费用。通过WDL格式的模板创建WDL作业。广泛应用于基因测序、药物检测等领域。 GCS作业 通过GCS格式的模板创建GCS作业。广泛应用于DNA、RNA、液态活检等主流生物基因分析、药物检测等领域。 父主题： 作业管理

复杂依赖任务（DAG） 如果有四个任务，a/b/c/d 我们希望首先执行 任务 a，然后执行 b/c，b/c 同时完成后，最后执行 d，如下图所示： 为了实现这个目标，需要引入 depends 字段。以任务 d为例，完成任务 d 需要首先完成任务 b/c，则depends 字段为： depends: - target: b type: whole - target: c type: whole 完整代码如下： version: genecontainer_0_1inputs: memory: default: 1g type: string cpu: default: 1c type: string tool: default: bwa:0.7.12 type: string shell: default: sh type: stringworkflow: a: tool: bwa:0.7.12 type: GCS.Job resources: memory: 1g cpu: 1c commands: - echo "A" b: tool: bwa:0.7.12 type: GCS.Job resources: memory: 1g cpu: 1c commands: - echo "B" depends: - target: a type: whole c: tool: bwa:0.7.12 type: GCS.Job resources: memory: 1g cpu: 1c commands: - echo "C" depends: - target: a type: whole d: tool: bwa:0.7.12 type: GCS.Job resources: memory: 1g cpu: 1c commands: - echo "D" depends: - target: b type: whole - target: c type: wholevolumes: sample-data: mount_path: /obs mount_from: pvc: ${GCS_DATA_PVC} temp-data: mount_path: /sfs mount_from: pvc: ${GCS_SFS_PVC} ref-data: mount_path: /ref mount_from: pvc: ${GCS_REF_PVC} 父主题： 流程语法示例

workflow配置样例 workflow: job-a: tool: nginx:latest type: GCS.Job resources: memory: 2G cpu: 1c commands: - sleep `expr 3 \* ${wait-base}`; echo ${output-prefix}job-a | tee -a ${obs}/${output}/${result}; job-b: tool: nginx:latest type: GCS.Job commands_iter: command: sleep `expr ${1} \* ${wait-base}`; echo ${output-prefix}job-b-${item} | tee -a ${obs}/${output}/${result}; vars_iter: - range(0, 4) #内置函数range，实际表示 [0, 1, 2, 3]。最终并发执行4个容器，每个使用数组成员替代 depends: - target: job-a type: whole #可不写，whole为默认值 job-c: tool: nginx:latest type: GCS.Job resources: memory: 8G cpu: 2c commands_iter: command: sleep `expr ${1} \* ${wait-base}`; echo ${output-prefix}job-c-${item} | tee -a ${obs}/${output}/${result}; vars_iter: - [3, 20] #最终并发2个容器，每个使用数组成员替代 depends: - target: job-a type: iterate - target: job-b

查看专属资源池 登录BCE控制台，在左侧导航栏单击“资源池管理”。 在“专属资源池”页签下，在资源池列表中可以查看资源池的名称、资源池状态、集群版本、集群规格、节点池和可用节点等信息。 在专属资源池卡片上，单击专属资源池名称，例如：bce-test0421，可查看专属资源池的详细信息。 单击右上角“休眠”，可以对集群进行休眠，单击“删除”可以删除资源池。 单击“资源池名称”， “资源池描述”， 可对资源池的名称，描述进行修改更新。 单击“集群名称”，可进入CCE服务页面，查看集群的详细信息。

如何选择区域？ 选择区域时，您需要考虑以下几个因素： 地理位置 一般情况下，建议就近选择靠近您或者您的目标用户的区域，这样可以减少网络时延，提高访问速度。不过，在基础设施、BGP网络品质、资源的操作与配置等方面，中国大陆各个区域间区别不大，如果您或者您的目标用户在中国大陆，可以不用考虑不同区域造成的网络时延问题。 在除中国大陆以外的亚太地区有业务的用户，“亚太-曼谷”或“亚太-新加坡”区域。 在非洲地区有业务的用户，可以选择“南非-约翰内斯堡”区域。 在欧洲地区有业务的用户，可以选择“欧洲-巴黎”区域。 在拉丁美洲地区有业务的用户，可以选择“拉美-圣地亚哥”区域。 “拉美-圣地亚哥”区域位于智利。 资源的价格 不同区域的资源价格可能有差异，请参见华为云服务价格详情。