华为云用户手册

  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 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 表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 错误描述。 状态码: 409 表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 错误描述。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 否 String 应用组名称,名称需满足如下规则: 由中文,英文大小写,数字,_-组成。 长度范围1~64个字符。 app_server_group_id 否 String 应用服务器组ID(仅允许未设置的情形下进行绑定)。 description 否 String 应用组描述。
  • 响应示例 状态码: 200 成功响应。 { "id" : 560329060530520064, "name" : "user-file-persistent", "storage_metadata" : { "storage_handle" : "sfs-tmp", "storage_class" : "sfs", "name" : "sfs-tmp", "region" : "cn-north-5", "export_location" : "https://sfs3.cn*****.huaweicloud.com:443" }, "create_time" : "2023-06-08T06:50:39.704Z", "user_claim_count" : 0, "share_claim_count" : 0 }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String WKS存储名称,名称需满足如下规则: 名称允许可见字符或空格,不可为全空格。 长度1~128个字符。 storage_metadata 是 Storage object 存储定义元数据。 表4 Storage 参数 是否必选 参数类型 描述 storage_handle 是 String SFS文件系统名称。 storage_class 是 String 存储类型: sfs - sfs3.0存储。
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 id String WKS存储ID。 name String 名称。 storage_metadata StorageMetadata object 存储定义。 create_time String 创建时间。 user_claim_count Integer 个人目录声明数量。 share_claim_count Integer 共享目录声明数量。 表6 StorageMetadata 参数 参数类型 描述 storage_handle String SFS文件系统名称。 storage_class String 存储类型: sfs - sfs3.0存储。 name String 名称。 region String 所在区域。 export_location String 访问地址:protocol://[bucket-name].sfs3.[region-name].myhuaweicloud.com:port。 状态码: 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 错误描述。
  • 响应示例 状态码: 200 校验本次订单提交资源是否足额响应类。 { "is_enough" : true, "quota_remainder" : [ { "type" : "INSTAN CES ", "remainder" : 490, "need" : 1 }, { "type" : "VOLUME_GIGABYTES", "remainder" : 69360, "need" : 60 }, { "type" : "VOLUMES", "remainder" : 9990, "need" : 1 }, { "type" : "CORES", "remainder" : 39980, "need" : 2 }, { "type" : "MEMORY", "remainder" : 99959040, "need" : 4096 } ] }
  • URI GET /v1/{project_id}/check/quota 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目唯一标识。 表2 Query参数 参数 是否必选 参数类型 描述 product_id 是 String 产品id。 subscription_num 是 Integer 订单需要创建总实例数、订购数量。 disk_size 是 Integer 单台实例所需的磁盘大小(最大系统盘1块1024、数据盘10块32768)。 disk_num 是 Integer 单台实例所需的磁盘数量(最大系统盘1块、数据盘10块)。 is_period 否 Boolean 是否包周期。 deh_id 否 String 主机id。 cluster_id 否 String 云专属分布式存储池id。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 is_enough Boolean 配额是否足够true:足够 false:不足。 quota_remainder Array of QuotaRemainderData objects 配额剩余数量信息。 表5 QuotaRemainderData 参数 参数类型 描述 type String 配额-资源类型: GPU_INSTANCES:GPU资源实例数,单位个。 INSTANCES:普通实例数,单位个。 VOLUME_GIGABYTES:磁盘总容量,单位GB。 VOLUMES:磁盘数量,单位个。 CORES:CPU数量,单位个。 MEMORY:内存容量,单位MB。 remainder Integer 剩余配额。 need 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 错误描述。 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 actions 否 Array of strings 客户端访问存储可操作的权限合集 允许为空,为空时配置了该策略的用户,通过云办公客户端接入后仅可查看文件列表,不可上传下载。 PutObject - 上传、修改、重命名、移动。 DeleteObject - 删除。 GetObject - 下载。 注:PutObject和DeleteObject必须同时设置,不支持仅设置其中一个。 roam_actions 是 Array of strings 云端访问存储可操作的权限合集,不允许为空。 PutObject - 上传、修改、重命名、移动。 DeleteObject - 删除。 GetObject - 下载 。注:PutObject和DeleteObject必须同时设置,不支持仅设置其中一个。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 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 表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 成功响应。 { "id" : "575768277444198400", "job_type" : "CREATE_SERVER", "begin_time" : "2023-06-06T02:30:06.836Z", "end_time" : "2023-06-06T02:45:49.577Z", "status" : "SUCCESS", "sub_jobs_total" : 1, "sub_jobs" : [ { "id" : "575768277481947136", "job_type" : "CREATE_SERVER", "job_resource_info" : { "resource_id" : "a2a6f5af-cbf7-4242-8988-109426870886", "resource_name" : "APS-20230606023006-YM08IXT04C" }, "begin_time" : "2023-06-06T02:30:06.902Z", "end_time" : "2023-06-06T02:45:49.564Z", "status" : "SUCCESS", "error_code" : "", "error_message" : "", "project_id" : "a4da8115c9d8464ead3a38309130523f", "job_id" : "575768277444198400" } ] }
  • 响应参数 状态码: 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 错误描述。
  • 请求示例 POST /v1/a4da8115c9d8464ead3a38309130523f/persistent-storages/544959151881584640/actions/assign-share-folder { "storage_claim_id" : 544959151881584640, "add_items" : [ { "attach" : "USER001***@local.com", "attach_type" : "USER", "policy_statement_id" : 1 } ], "del_items" : [ { "attach" : "USER001***@local.com", "attach_type" : "USER" } ] }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 storage_claim_id 是 String WKS存储目录声明ID。 add_items 否 Array of Assignment objects 增加的成员列表。 del_items 否 Array of Attachment objects 移除的成员列表。 表4 Assignment 参数 是否必选 参数类型 描述 policy_statement_id 是 String 策略ID。 attach 是 String 目标。 attach_type 是 String 关联对象类型: USER - 用户 USER_GROUP - 用户组 表5 Attachment 参数 是否必选 参数类型 描述 attach 是 String 目标。 attach_type 是 String 关联对象类型: USER - 用户 USER_GROUP - 用户组
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 否 String 服务器组名称,名称需满足如下规则: 由中文,英文大小写,数字,_-组成,不能有空格。 长度范围1~64个字符。 description 否 String 服务器组描述。 route_policy 否 RoutePolicy object 路由策略。 storage_mount_policy 否 String 用户访问APS的应用时,对应NAS存储目录在APS上的挂载策略。 USER - 仅挂载个人目录。 SHARE - 仅挂载共享目录。 ANY - 挂载目录不做限制(个人和共享NAS存储目录都会自动挂载)。 image_id 否 String 服务器组关联的镜像ID,更新镜像ID只对组下新创建的云服务器生效。 image_product_id 否 String 服务器组的镜像的productId。 image_type 否 String 镜像类型: gold - 云市场镜像 public - 公共镜像 private - 私有镜像 shared - 共享镜像 other - 其他 system_disk_type 否 String 磁盘类型,获取可用磁盘类型详见接口磁盘管理ListVolumeType。 ESSD - 极速型SSD SSD - 超高IO GPSSD - 通用型SSD SAS - 高IO SATA - 普通IO system_disk_size 否 Integer 磁盘容量,单位GB。 ou_name 否 String 默认组织名称。 app_type 否 String 服务器组应用类型: SESSION_DESKTOP_APP - 会话桌面app COMMON_APP - 普通app 表4 RoutePolicy 参数 是否必选 参数类型 描述 max_session 否 Integer 单台服务器最大的链接会话数。 cpu_threshold 否 Integer cpu使用率阈值,单位为%。 mem_threshold 否 Integer 内存使用率阈值,单位为%。
  • 响应参数 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 405 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 503 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。
  • 响应参数 状态码: 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 查询会话列表响应成功。 { "session_types" : [ { "resource_spec_code" : "workspace.appstreamsession.premium", "session_type" : "GPU", "resource_type" : "hws.resource.type.workspace.appstreamsession", "cloud_service_type" : "hws.service.type.vdi" }, { "resource_spec_code" : "workspace.appstreamsession.standard", "session_type" : "CPU", "resource_type" : "hws.resource.type.workspace.appstreamsession", "cloud_service_type" : "hws.service.type.vdi" } ] }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 session_types Array of SessionTypeEntity objects 会话列表。 表4 SessionTypeEntity 参数 参数类型 描述 resource_spec_code String 资源规格编码。 session_type String 会话类型。 resource_type String 资源类型字段。 cloud_service_type String 资源所属云服务类型编码。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。
  • 请求示例 POST /v1/29dfe82ada564ac2b927e1ff036d9a9b/policy-groups { "policy_group" : { "policy_group_name" : "test123", "description" : "", "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" : "", "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" : "" } }, "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" : true, "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" : "\\var\\log", "linux_file_mount_path" : "\\media|\\Volumes|\\swdb\\mnt|\\home|\\storage|\\tmp|\\run\\media", "linux_fixed_drive_file_system_format" : "", "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" : false, "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" : "", "virtual_channel_plugin_details" : "", "third_party_plugin_name" : "" } }, "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" : "" } } } } }
  • 响应参数 状态码: 200 表72 响应Body参数 参数 参数类型 描述 id String 策略组ID。 状态码: 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 错误描述。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 policy_group 是 PolicyGroupForCreate object 策略组信息。 表4 PolicyGroupForCreate 参数 是否必选 参数类型 描述 policy_group_name 是 String 策略组名称,名称需要满足如下规则: 由英文、数字或者下划线组成,不能有空格。 字符长度范围1-55。 priority 否 Integer 优先级。 description 否 String 策略组描述。 targets 否 Array of Target objects 应用对象列表。 policies 否 Policies object 策略。 表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。 表6 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 自定义策略 表7 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 串口重定向。 表8 usb_port_redirection 参数 是否必选 参数类型 描述 usb_enable 否 Boolean 是否开启USB端口重定向。取值为: false:表示关闭。 true:表示开启。 options 否 UsbPortRedirectionOptions object USB端口重定向控制的选项。 表9 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:通用模式。 表10 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。 表11 printer_redirection 参数 是否必选 参数类型 描述 printer_enable 否 Boolean 是否开启打印机设备重定向。取值为: false:表示关闭。 true:表示开启。 options 否 PrinterRedirectionOptions object 打印机设备重定向控制的选项。 表12 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。 表13 session_printer 参数 是否必选 参数类型 描述 session_printer_enable 否 Boolean 是否开启会话打印机。取值为: false:表示关闭。 true:表示开启。 options 否 SessionPrinterOptions object 会话打印机控制选项。 表14 SessionPrinterOptions 参数 是否必选 参数类型 描述 session_printer_customization_policy 否 String 会话打印机自定义策略。 表15 camera_redirection 参数 是否必选 参数类型 描述 video_compress_enable 否 Boolean 是否开启摄像头设备重定向。取值为: false:表示关闭。 true:表示开启。 options 否 CameraRedirectionOptions object 摄像头设备重定向控制的选项。 表16 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。 表17 usb_device_common 参数 是否必选 参数类型 描述 pcsc_smart_card_enable 否 String 是否开启PC/SC智能卡重定向。取值为: Enable:表示已启动。 Closed:表示已关闭。 Disable:表示已禁用。 common_options 否 common_options object USB和设备智能卡共同控制的选项。 表18 common_options 参数 是否必选 参数类型 描述 remove_smart_card_disconnect_enable 否 Boolean 是否移除智能卡断开用户会话。取值为: false:表示关闭。 true:表示开启。 表19 serial_port_redirection 参数 是否必选 参数类型 描述 serial_port_enable 否 Boolean 是否开启串口重定向。取值为: false:表示关闭。 true:表示开启。 options 否 SerialPortRedirectionOptions object 串口重定向控制的选项。 表20 SerialPortRedirectionOptions 参数 是否必选 参数类型 描述 auto_connect_enable 否 Boolean 是否自动连接客户端串口。取值为: false:表示关闭。 true:表示开启。 表21 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。 表22 client 参数 是否必选 参数类型 描述 automatic_reconnection_interval 否 Integer 自动重连间隔(秒)。取值范围为[1-50]。默认:5。 session_persistence_time 否 Integer 自动重连会话保持时长(秒)。取值范围为[0-180]。默认:180。 forbid_screen_capture 否 Boolean 防截屏策略开关。 false:表示关闭。 true:表示开启。 表23 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:表示开启。 表24 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。 表25 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 表26 video_bit_rate_options 参数 是否必选 参数类型 描述 average_video_bit_rate 否 Integer 视频平均码率(Kbps)。取值范围为[256-100000]。默认:18000。 表27 video_quality_options 参数 是否必选 参数类型 描述 average_video_quality 否 Integer 视频平均质量。取值范围为[5-59]。默认:15。 lowest_video_quality 否 Integer 视频最低质量。取值范围为[5-69]。默认:25。 highest_video_quality 否 Integer 视频最高质量。取值范围为[1-59]。默认:7。 表28 rendering_acceleration_options 参数 是否必选 参数类型 描述 video_acceleration_enhancement_enable 否 Boolean 视频加速增强配置。取值为: false:表示关闭。 true:表示开启。 video_optimization_enable 否 Boolean 是否开启视频场景优化。取值为: false:表示关闭。 true:表示开启。 gpu_color_optimization_enable 否 Boolean 是否开启GPU色彩优化。取值为: false:表示关闭。 true:表示开启。 表29 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 剪切板重定向控制的选项。 表30 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 重定向和发送文件共同控制项。 表31 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:表示开启。 表32 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。 表33 compression_switch_options 参数 是否必选 参数类型 描述 compression_threshold 否 Integer 压缩阈值(Byte)。取值范围为[0-10240]。默认:512。 minimum_compression_rate 否 Integer 最小压缩率。取值范围为[0-1000]。默认:900。 表34 linux_file_size_supported_options 参数 是否必选 参数类型 描述 linux_file_size_supported_threshold 否 Integer Linux设置文件大小阈值(Byte)。取值范围为[0-4096]。默认:100。 表35 redirection_send_file_options 参数 是否必选 参数类型 描述 read_write_speed 否 Integer 读写速度(Kbps)。取值范围为[0-2147483647]。默认:0。 表36 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:表示开启双向。 表37 Session 参数 是否必选 参数类型 描述 sbc 否 Sbc object SBC结构体。 表38 Sbc 参数 是否必选 参数类型 描述 sbc_automatic_disconnection 否 String 连接策略: DISABLED:已禁用 AUTO_DISCONNECT:自动断开 AUTO_LOCK:自动锁屏 sbc_automatic_disconnection_options 否 SbcAutomaticDisconnectionOptions object 自动连接选项。 表39 SbcAutomaticDisconnectionOptions 参数 是否必选 参数类型 描述 disconnection_waiting_time 否 Integer 等待时间(分钟)。 sbc_auto_logout 否 Boolean 是否自动注销。取值为:false:表示是。true:表示否。 auto_logout_options 否 AutoLogoutOptions object 自动注销。 表40 AutoLogoutOptions 参数 是否必选 参数类型 描述 sbc_logout_waiting_time 否 Integer 会话断连保留时长(分钟)。 表41 VirtualChannel 参数 是否必选 参数类型 描述 virtual_channel_control_enable 否 Boolean 是否开启虚拟通道策略设置。取值为:false:表示关闭。true:表示开启。 options 否 VirtualChannelOptions object 虚拟通道策略控制的选项。 表42 VirtualChannelOptions 参数 是否必选 参数类型 描述 custom_virtual_channel_name 否 String 自定义虚拟通道注册名。 virtual_channel_plugin_details 否 String 虚拟通道下载配置信息,需Base64加密。 third_party_plugin_name 否 String 第三方插件名称。 表43 keyboard_mouse 参数 是否必选 参数类型 描述 mouse_feedback 否 String 虚拟机鼠标回馈。取值为: SELFADAPTION:自适应鼠标回馈。 FORCE:强制鼠标回馈。 CLOSE:关闭鼠标回馈。 mouse_simulation_mode 否 String 虚拟机鼠标模拟方式。取值为: ABSOLUTE_POSITION:绝对位置模拟。 RELATIVE_POSITION:相对位置模拟。 external_cursor_feedback 否 Boolean 虚拟机外部光标反馈。取值为: false:表示关闭。 true:表示开启。 表44 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 虚拟通道带宽控制的选项。 表45 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 虚拟通道带宽百分比控制的选项。 表46 DisplayBandwidthPercentageOptions 参数 是否必选 参数类型 描述 display_bandwidth_percentage_value 否 Integer 显示带宽百分比控制量(%)。取值范围为[0-100]。默认:65。 表47 MultimediaBandwidthPercentageOptions 参数 是否必选 参数类型 描述 multimedia_bandwidth_percentage_value 否 Integer 多媒体带宽百分比控制量(%)。取值范围为[0-100]。默认:50。 表48 UsbBandwidthPercentageOptions 参数 是否必选 参数类型 描述 usb_bandwidth_percentage_value 否 Integer USB带宽百分比控制量(%)。取值范围为[0-100]。默认:100。 表49 PcscBandwidthPercentageOptions 参数 是否必选 参数类型 描述 pcsc_bandwidth_percentage_value 否 Integer PCSC带宽百分比控制量(%)。取值范围为[0-100]。默认:5。 表50 TwainBandwidthPercentageOptions 参数 是否必选 参数类型 描述 twain_bandwidth_percentage_value 否 Integer TWAIN带宽百分比控制量(%)。取值范围为[0-100]。默认:15。 表51 PrinterBandwidthPercentageOptions 参数 是否必选 参数类型 描述 printer_bandwidth_percentage_value 否 Integer 打印机带宽百分比控制量(%)。取值范围为[0-100]。默认:5。 表52 ComBandwidthPercentageOptions 参数 是否必选 参数类型 描述 com_bandwidth_percentage_value 否 Integer 串口带宽百分比控制量(%)。取值范围为[0-100]。默认:3。 表53 FileRedirectionBandwidthPercentageOptions 参数 是否必选 参数类型 描述 file_redirection_bandwidth_percentage_value 否 Integer 文件重定向带宽百分比控制量(%)。取值范围为[0-100]。默认:30。 表54 ClipboardBandwidthPercentageOptions 参数 是否必选 参数类型 描述 clipboard_bandwidth_percentage_value 否 Integer 剪切板带宽百分比控制量(%)。取值范围为[0-100]。默认:3。 表55 SecureChannelBandwidthPercentageOptions 参数 是否必选 参数类型 描述 secure_channel_bandwidth_percentage_value 否 Integer 安全通道带宽百分比控制量(%)。取值范围为[0-100]。默认:30。 表56 CameraBandwidthPercentageOptions 参数 是否必选 参数类型 描述 camera_bandwidth_percentage_value 否 Integer 摄像头带宽百分比控制量(%)。取值范围为[0-100]。默认:30。 表57 VirtualChannelBandwidthPercentageOptions 参数 是否必选 参数类型 描述 virtual_channel_bandwidth_percentage_value 否 Integer 虚拟通道带宽百分比控制量(%)。取值范围为[0-100]。默认:65。 表58 DisplayBandwidthControlOptions 参数 是否必选 参数类型 描述 display_bandwidth_control_value 否 Integer 显示带宽控制量(Kbps)。取值范围为[500-50000]。默认:20000。 表59 MultimediaBandwidthControlOptions 参数 是否必选 参数类型 描述 multimedia_bandwidth_control_value 否 Integer 多媒体带宽控制量(Kbps)。取值范围为[5000-20000]。默认:15000。 表60 UsbBandwidthControlOptions 参数 是否必选 参数类型 描述 usb_bandwidth_control_value 否 Integer USB带宽控制量(Kbps)。取值范围为[1000-30000]。默认:30000。 表61 PcscBandwidthControlOptions 参数 是否必选 参数类型 描述 pcsc_bandwidth_control_value 否 Integer PCSC带宽控制量(Kbps)。取值范围为[1000-5000]。默认:2000。 表62 TwainBandwidthControlOptions 参数 是否必选 参数类型 描述 twain_bandwidth_control_value 否 Integer TWAIN带宽控制量(Kbps)。取值范围为[2000-10000]。默认:5000。 表63 PrinterBandwidthControlOptions 参数 是否必选 参数类型 描述 printer_bandwidth_control_value 否 Integer 打印机带宽控制量(Kbps)。取值范围为[1000-5000]。默认:2000。 表64 ComBandwidthControlOptions 参数 是否必选 参数类型 描述 com_bandwidth_control_value 否 Integer 串口带宽控制量(Kbps)。取值范围为[500-2000]。默认:1000。 表65 FileRedirectionBandwidthControlOptions 参数 是否必选 参数类型 描述 file_redirection_bandwidth_control_value 否 Integer 文件重定向带宽控制量(Kbps)。取值范围为[500-20000]。默认:10000。 表66 ClipboardBandwidthControlOptions 参数 是否必选 参数类型 描述 clipboard_bandwidth_control_value 否 Integer 剪切板带宽控制量(Kbps)。取值范围为[100-2000]。默认:1000。 表67 SecureChannelBandwidthControlOptions 参数 是否必选 参数类型 描述 secure_channel_bandwidth_control_value 否 Integer 安全通道带宽控制量(Kbps)。取值范围为[500-20000]。默认:10000。 表68 CameraBandwidthControlOptions 参数 是否必选 参数类型 描述 camera_bandwidth_control_value 否 Integer 摄像头带宽控制量(Kbps)。取值范围为[0-10000]。默认:10000。 表69 VirtualChannelBandwidthControlOptions 参数 是否必选 参数类型 描述 virtual_channel_bandwidth_control_value 否 Integer 虚拟通道带宽控制量(Kbps)。取值范围为[500-20000]。默认:20000。 表70 custom 参数 是否必选 参数类型 描述 custom_configuration1_enable 否 Boolean 自定义策略配置项1: false: 表示关闭 true: 表示开启 options 否 CustomOptions object 自定义策略设置项。 表71 CustomOptions 参数 是否必选 参数类型 描述 custom_configuration1_rule 否 String 配置项1内容。
  • 响应参数 状态码: 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 错误描述。
  • 响应参数 状态码: 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的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 items 是 Array of strings 批量请求的服务器ID列表,一次请求数量区间 [1, 20]。 type 是 String 停机类型: SOFT - 普通 HARD - 强制
  • 请求示例 POST /v1/29dfe82ada564ac2b927e1ff036d9a9b/policy-templates { "policy_group" : { "policy_group_name" : "policy_group_name1926076252", "policies" : { "peripherals" : { "device_redirection" : { "session_printer" : { "session_printer_enable" : false, "options" : { "session_printer_customization_policy" : "" } }, "printer_redirection" : { "options" : { "universal_printer_driver" : "Default", "sync_client_default_printer_enable" : true }, "printer_enable" : true } } }, "session" : { "sbc" : { "sbc_automatic_disconnection" : "DISABLED", "sbc_automatic_disconnection_options" : { "auto_logout_options" : { "sbc_logout_waiting_time" : 1440 }, "sbc_auto_logout" : false, "disconnection_waiting_time" : 10 } } }, "display" : { "change_resolution_vm" : false, "video_card_memory_size" : 64, "driver_delegation_mode_enable" : false, "options" : { "color_enhancement_enable" : false, "encoding_preset" : "Preset 1", "smoothing_factor" : 60, "video_quality_options" : { "lowest_video_quality" : 25, "highest_video_quality" : 7, "average_video_quality" : 15 }, "peak_video_bit_rate" : 18000, "gop_size" : 100, "video_frame_rate" : 30, "lossy_compression_quality" : 85, "video_bit_rate_options" : { "average_video_bit_rate" : 18000 }, "deep_compression_options" : { "deep_compression_level" : "Compression grade 0" }, "quality_bandwidth_first" : "Quality First", "lossless_compression_mode" : "Basic Compression", "frame_rate" : 25, "display_bandwidth" : 20000, "min_image_cache" : 200 }, "driver_delegation_latency" : 80, "video_latency" : 80, "display_level" : "LEVEL4" }, "client" : { "automatic_reconnection_interval" : 5, "session_persistence_time" : 180 }, "virtual_channel" : { "options" : { "custom_virtual_channel_name" : "", "virtual_channel_plugin_details" : "", "third_party_plugin_name" : "" }, "virtual_channel_control_enable" : false }, "keyboard_mouse" : { "mouse_simulation_mode" : "ABSOLUTE_POSITION", "external_cursor_feedback" : false, "mouse_feedback" : "SELFADAPTION" }, "file_and_clipboard" : { "file_redirection" : { "redirection_mode" : "DISABLED", "redirection_send_file_options" : { "read_write_speed" : 0 }, "options" : { "fixed_drive_enable" : true, "fluid_control_switch_enable" : false, "compression_switch_options" : { "compression_threshold" : 512, "minimum_compression_rate" : 900 }, "removable_drive_enable" : true, "linux_fixed_drive_file_system_format" : "", "compression_switch_enable" : false, "linux_removable_drive_file_system_format" : "vfat|ntfs|msdos|fuseblk|sdcardfs|exfat|fuse.fdredir", "linux_cdrom_drive_file_system_format" : "cd9660|iso9660|udf", "linux_root_mount_switch_enable" : true, "path_separator" : "|", "network_drive_enable" : true, "linux_file_mount_path" : "\\\\media|\\\\Volumes|\\\\swdb\\\\mnt|\\\\home|\\\\storage|\\\\tmp|\\\\run\\\\media", "linux_root_dir_list" : "\\\\var\\\\log", "cd_rom_drive_enable" : true, "fluid_control_options" : { "poor_network_latency" : 100, "reducing_step" : 20, "test_time_gap" : 10000, "test_block_size" : 64, "start_speed" : 1024, "normal_network_latency" : 70, "slow_increasing_step" : 10, "good_network_latency" : 30, "quick_increasing_step" : 20 }, "linux_file_size_supported_enable" : true, "linux_network_drive_file_system_format" : "smbfs|afpfs|cifs", "linux_file_size_supported_options" : { "linux_file_size_supported_threshold" : 100 } }, "vm_send_file_client" : false }, "clipboard_redirection" : "DISABLED", "clipboard_redirection_options" : { "rich_text_redirection_enable" : true, "file_clipboard_redirection" : "DISABLED", "rich_text_clipboard_redirection" : "DISABLED", "clipboard_file_redirection_enable" : true }, "fd_mobile_client_redir_enable" : true }, "audio" : { "record_classification" : "Speech Call", "play_redirection_enable" : true, "play_classification" : "Music Play", "record_redirection_enable" : true, "audio_redirection_enable" : true } }, "description" : "策略组description1713560713" } }
  • 响应参数 状态码: 200 表71 响应Body参数 参数 参数类型 描述 id String 策略组ID。 状态码: 400 表72 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 401 表73 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 403 表74 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 404 表75 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 405 表76 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 500 表77 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 503 表78 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 policy_group 是 PolicyTemplate object 策略模板。 表4 PolicyTemplate 参数 是否必选 参数类型 描述 policy_group_name 是 String 策略组名称,名称需要满足如下规则: 不能有空格和.开头,可以由中文、数字、英文大小写组成。 字符长度范围1-55。 description 否 String 描述。 policies 是 Policies object 策略。 表5 Policies 参数 是否必选 参数类型 描述 peripherals 否 peripherals object 外设。 audio 否 audio object 音频。 client 否 client object 客户端。 display 否 display object 显示。 file_and_clipboard 否 file_and_clipboard object 文件和剪切板。 session 否 Session object 会话 virtual_channel 否 VirtualChannel object 虚拟通道 keyboard_mouse 否 keyboard_mouse object 键盘鼠标。 bandwidth 否 Bandwidth object 带宽。 custom 否 custom object 自定义策略 表6 peripherals 参数 是否必选 参数类型 描述 usb_port_redirection 否 usb_port_redirection object USB端口重定向。 device_redirection 否 device_redirection object 设备重定向。 usb_device_common 否 usb_device_common object USB和设备智能卡控制选项。 serial_port_redirection 否 serial_port_redirection object 串口重定向。 表7 usb_port_redirection 参数 是否必选 参数类型 描述 usb_enable 否 Boolean 是否开启USB端口重定向。取值为: false:表示关闭。 true:表示开启。 options 否 UsbPortRedirectionOptions object USB端口重定向控制的选项。 表8 UsbPortRedirectionOptions 参数 是否必选 参数类型 描述 usb_image_enable 否 Boolean 是否开启图像设备(如: 扫描仪)。取值为: false:表示关闭。 true:表示开启。 usb_video_enable 否 Boolean 是否开启视频设备(如: 摄像头)。取值为: false:表示关闭。 true:表示开启。 usb_printer_enable 否 Boolean 是否开启打印设备(如: 打印机)。取值为: false:表示关闭。 true:表示开启。 usb_storage_enable 否 Boolean 是否开启存储设备(如: U盘)。取值为: false:表示关闭。 true:表示开启。 wireless_devices_enable 否 Boolean 是否开启无线设备(如:蓝牙)。取值为: false:表示关闭。 true:表示开启。 network_devices_enable 否 Boolean 是否开启网路设备(如:无线网卡)。取值为: false:表示关闭。 true:表示开启。 usb_smart_card_enable 否 Boolean 是否开启智能卡设备(如:Ukey)。取值为: false:表示关闭。 true:表示开启。 other_usb_devices_enable 否 Boolean 是否开启其他USB设备重定向。取值为: false:表示关闭。 true:表示开启。 usb_redirection_customization_policy 否 String USB端口重定向自定义策略。 usb_redirection_mode 否 String USB 重定向模式。取值为: Classical mode:经典模式。 Common mode:通用模式。 表9 device_redirection 参数 是否必选 参数类型 描述 printer_redirection 否 printer_redirection object 打印机重定向。 session_printer 否 session_printer object 会话打印机。 camera_redirection 否 camera_redirection object 摄像头重定向。 twain_redirection_enable 否 Boolean 是否开启TWAIN设备重定向。取值为: false:表示关闭。 true:表示开启。 image_compression_level 否 String 图形压缩级别。取值为: 不压缩:none。 低(速度最快):low。 中(速度适中):medium。 高(速度最慢):high。 无损(无损压缩):lossless。 低损(低损压缩):low-loss。 中损(中损压缩):medium-loss。 高损(高损压缩):high-loss。 表10 printer_redirection 参数 是否必选 参数类型 描述 printer_enable 否 Boolean 是否开启打印机设备重定向。取值为: false:表示关闭。 true:表示开启。 options 否 PrinterRedirectionOptions object 打印机设备重定向控制的选项。 表11 PrinterRedirectionOptions 参数 是否必选 参数类型 描述 sync_client_default_printer_enable 否 Boolean 是否开启同步客户端默认打印机。取值为: false:表示关闭。 true:表示开启。 universal_printer_driver 否 String 通用打印机驱动。取值为:- Default:linux客户端选择Universal Printing- PS,windows客户端选择HDP XPSDrv Driver。- HDP XPSDrv Driver。- Universal Printing PCL 5。- Universal Printing PCL 6。- Universal Printing PS。 表12 session_printer 参数 是否必选 参数类型 描述 session_printer_enable 否 Boolean 是否开启会话打印机。取值为: false:表示关闭。 true:表示开启。 options 否 SessionPrinterOptions object 会话打印机控制选项。 表13 SessionPrinterOptions 参数 是否必选 参数类型 描述 session_printer_customization_policy 否 String 会话打印机自定义策略。 表14 camera_redirection 参数 是否必选 参数类型 描述 video_compress_enable 否 Boolean 是否开启摄像头设备重定向。取值为: false:表示关闭。 true:表示开启。 options 否 CameraRedirectionOptions object 摄像头设备重定向控制的选项。 表15 CameraRedirectionOptions 参数 是否必选 参数类型 描述 camera_frame_rate 否 Integer 摄像头帧率(fps)。取值范围为[1-30]。默认:15。 camera_max_width 否 Integer 摄像头最大宽度(pixel)。取值范围为[1-9999]。默认:3000。 camera_max_heigth 否 Integer 摄像头最大高度(pixel)。取值范围为[1-9999]。默认:3000。 camera_compression_method 否 String 摄像头数据压缩方式。取值为:H.264。 表16 usb_device_common 参数 是否必选 参数类型 描述 pcsc_smart_card_enable 否 String 是否开启PC/SC智能卡重定向。取值为: Enable:表示已启动。 Closed:表示已关闭。 Disable:表示已禁用。 common_options 否 common_options object USB和设备智能卡共同控制的选项。 表17 common_options 参数 是否必选 参数类型 描述 remove_smart_card_disconnect_enable 否 Boolean 是否移除智能卡断开用户会话。取值为: false:表示关闭。 true:表示开启。 表18 serial_port_redirection 参数 是否必选 参数类型 描述 serial_port_enable 否 Boolean 是否开启串口重定向。取值为: false:表示关闭。 true:表示开启。 options 否 SerialPortRedirectionOptions object 串口重定向控制的选项。 表19 SerialPortRedirectionOptions 参数 是否必选 参数类型 描述 auto_connect_enable 否 Boolean 是否自动连接客户端串口。取值为: false:表示关闭。 true:表示开启。 表20 audio 参数 是否必选 参数类型 描述 audio_redirection_enable 否 Boolean 是否开启音频重定向。取值为: false:表示关闭。 true:表示开启。 play_redirection_enable 否 Boolean 是否开启播音重定向。取值为: false:表示关闭。 true:表示开启。 play_classification 否 String 播音场景。取值为: 无损播音:LossLess。 语音通话:Speech Call。 音乐播音:Music Play。 自动识别:Automatic Identification。 record_redirection_enable 否 Boolean 是否开启录音重定向。取值为: false:表示关闭。 true:表示开启。 record_classification 否 String 录音场景。取值为: 无损录音:LossLess。 语音通话:Speech Call。 音乐录音:Music Record。 自动识别:Automatic Identification。 表21 client 参数 是否必选 参数类型 描述 automatic_reconnection_interval 否 Integer 自动重连间隔(秒)。取值范围为[1-50]。默认:5。 session_persistence_time 否 Integer 自动重连会话保持时长(秒)。取值范围为[0-180]。默认:180。 forbid_screen_capture 否 Boolean 防截屏策略开关。 false:表示关闭。 true:表示开启。 表22 display 参数 是否必选 参数类型 描述 display_level 否 String 显示级别。取值为: LEVEL1:表示等级1。 LEVEL2:表示等级2。 LEVEL3:表示等级3。 LEVEL4:表示等级4(默认/推荐)。 LEVEL5:表示等级5。 options 否 DisplayOptions object 显示级别共同控制的选项。 rendering_acceleration_enable 否 Boolean 是否开启渲染加速。取值为: false:表示关闭。 true:表示开启。 rendering_acceleration_options 否 rendering_acceleration_options object 渲染加速控制选项。 video_card_memory_size 否 Integer 显卡缓存(MB)。取值范围为[0-64]。默认:64。 driver_delegation_mode_enable 否 Boolean 是否开启驱动托管模式。取值为: false:表示关闭。 true:表示开启。 driver_delegation_latency 否 Integer 驱动托管延时(*30ms)。取值范围为[1-100]。默认:80。 video_latency 否 Integer 驱动托管视频延时(*30ms)。取值范围为[1-100]。默认:80。 change_resolution_vm 否 Boolean 计算机修改分辨率:取值为: false:表示关闭。 true:表示开启。 表23 DisplayOptions 参数 是否必选 参数类型 描述 display_bandwidth 否 Integer 带宽(Kbps)。取值范围为[256-25000]。默认:20000。 frame_rate 否 Integer 帧率(fps)。取值范围为[1-60]。默认:25。 video_frame_rate 否 Integer 视频帧率(fps)。取值范围为[1-60]。默认:30。 min_image_cache 否 Integer 图像缓存最低容量(MB)。取值范围[0-300],默认:200。 smoothing_factor 否 Integer 有损压缩识别阈值。取值范围为[0-255]。默认:60。 lossless_compression_mode 否 String 无损压缩模式。取值为: Basic Compression:表示初级压缩。 Deep Compression:表示深度压缩。 deep_compression_options 否 deep_compression_options object 深度压缩控制选项。 lossy_compression_quality 否 Integer 有损压缩质量。取值范围为[20-100]。默认:85。 color_enhancement_enable 否 Boolean 办公场景色彩增强:取值为: false:表示关闭。 true:表示开启。 quality_bandwidth_first 否 String 质量或带宽优先。取值为: Quality First:表示初级压缩。 Bandwidth First:表示深度压缩。 video_bit_rate_options 否 video_bit_rate_options object 视频码率控制选项。 peak_video_bit_rate 否 Integer 视频峰值码率(Kbps)。取值范围为[256-100000]。默认:18000。 video_quality_options 否 video_quality_options object 视频质量控制选项。 gop_size 否 Integer GOP大小。取值范围为[0-65535]。默认:100。 encoding_preset 否 String 编码预置。取值为: 预置1:Preset 1。 预置2:Preset 2。 预置3:Preset 3。 预置4:Preset 4。 预置5:Preset 5。 预置6:Preset 6。 预置7:Preset 7。 表24 deep_compression_options 参数 是否必选 参数类型 描述 deep_compression_level 否 String 深度压缩级别。取值为: 压缩级别0:Compression grade 0 压缩级别1:Compression grade 1 压缩级别2:Compression grade 2 压缩级别3:Compression grade 3 压缩级别4:Compression grade 4 压缩级别5:Compression grade 5 压缩级别6:Compression grade 6 压缩级别7:Compression grade 7 压缩级别8:Compression grade 8 压缩级别9:Compression grade 9 表25 video_bit_rate_options 参数 是否必选 参数类型 描述 average_video_bit_rate 否 Integer 视频平均码率(Kbps)。取值范围为[256-100000]。默认:18000。 表26 video_quality_options 参数 是否必选 参数类型 描述 average_video_quality 否 Integer 视频平均质量。取值范围为[5-59]。默认:15。 lowest_video_quality 否 Integer 视频最低质量。取值范围为[5-69]。默认:25。 highest_video_quality 否 Integer 视频最高质量。取值范围为[1-59]。默认:7。 表27 rendering_acceleration_options 参数 是否必选 参数类型 描述 video_acceleration_enhancement_enable 否 Boolean 视频加速增强配置。取值为: false:表示关闭。 true:表示开启。 video_optimization_enable 否 Boolean 是否开启视频场景优化。取值为: false:表示关闭。 true:表示开启。 gpu_color_optimization_enable 否 Boolean 是否开启GPU色彩优化。取值为: false:表示关闭。 true:表示开启。 表28 file_and_clipboard 参数 是否必选 参数类型 描述 bypass_in_remote_app_enable 否 Boolean 应用聚合场景下是否双向放通:取值为: false:表示不放通。 true:表示放通。 file_redirection 否 file_redirection object 文件重定向。 fd_mobile_client_redir_enable 否 Boolean 移动客户端文件重定向:取值为: false:表示关闭。 true:表示开启。 clipboard_redirection 否 String 剪切板重定向。取值为: DISABLED:表示禁用。(默认) SERVER_TO_CLIENT_ENABLED:表示开启服务端到客户端。 CLIENT_TO_SERVER_ENABLED:表示开启客户端到服务端。 TWO_WAY_ENABLED:表示开启双向。 clipboard_redirection_options 否 clipboard_redirection_options object 剪切板重定向控制的选项。 表29 file_redirection 参数 是否必选 参数类型 描述 redirection_mode 否 String 文件重定向。取值为: DISABLED:表示禁用。(默认) READ_ONLY:表示只读。 READ_AND_WRITE:表示读写。 options 否 FileRedirectionOptions object 文件重定向控制的选项。 vm_send_file_client 否 Boolean 是否开启发送文件(虚机到客户端)。取值为: false:表示关闭。 true:表示开启。 redirection_send_file_options 否 redirection_send_file_options object 重定向和发送文件共同控制项。 表30 FileRedirectionOptions 参数 是否必选 参数类型 描述 fluid_control_switch_enable 否 Boolean 是否开启流控开关。取值为: false:表示关闭。 true:表示开启。 fluid_control_options 否 fluid_control_options object 流控控制项。 compression_switch_enable 否 Boolean 是否开启压缩开关。取值为: false:表示关闭。 true:表示开启。 compression_switch_options 否 compression_switch_options object 压缩开关控制项。 linux_file_size_supported_enable 否 Boolean 是否开启Linux支持设置文件大小。取值为: false:表示关闭。 true:表示开启。 linux_file_size_supported_options 否 linux_file_size_supported_options object Linux支持设置文件大小控制项。 linux_root_mount_switch_enable 否 Boolean 是否开启Linux根目录挂载开关。取值为: false:表示关闭。 true:表示开启。 linux_root_dir_list 否 String Linux根目录挂载路径。默认:"\home"。 linux_file_mount_path 否 String Linux文件系统挂载路径。默认:"\media|\Volumes|\swdb\mnt|\home|\storage|\tmp|\run\media"。 linux_fixed_drive_file_system_format 否 String Linux固定驱动器文件系统格式。 linux_removable_drive_file_system_format 否 String Linux可移动驱动器文件系统格式。默认:"vfat|ntfs|msdos|fuseblk|sdcardfs|exfat|fuse.fdredir"。 linux_cdrom_drive_file_system_format 否 String Linux光盘驱动器文件系统格式。默认:"cd9660|iso9660|udf"。 linux_network_drive_file_system_format 否 String Linux网络驱动器文件系统格式。默认:"smbfs|afpfs|cifs"。 path_separator 否 String 路径分隔符。默认:"|"。 fixed_drive_enable 否 Boolean 是否开启固定驱动器(如: 本地磁盘)。取值为: false:表示关闭。 true:表示开启。 removable_drive_enable 否 Boolean 是否开启可移除驱动器(如: U盘)。取值为: false:表示关闭。 true:表示开启。 cd_rom_drive_enable 否 Boolean 是否开启光盘驱动器。取值为: false:表示关闭。 true:表示开启。 network_drive_enable 否 Boolean 是否开启网络驱动器。取值为: false:表示关闭。 true:表示开启。 表31 fluid_control_options 参数 是否必选 参数类型 描述 good_network_latency 否 Integer 网络优的延时阈值(ms)。取值范围为[1-1000]。默认:30。 normal_network_latency 否 Integer 网络一般的延时阈值(ms)。取值范围为[1-1000]。默认:70。 poor_network_latency 否 Integer 网络差的延时阈值(ms)。取值范围为[1-1000]。默认:100。 reducing_step 否 Integer 降速步伐(KB)。取值范围为[1-100]。默认:20。 slow_increasing_step 否 Integer 慢增速步伐(KB)。取值范围为[1-100]。默认:10。 quick_increasing_step 否 Integer 快增速步伐(KB)。取值范围为[1-100]。默认:20。 start_speed 否 Integer 传输初始速度(KB/s)。取值范围为[1-10240]。默认:1024。 test_block_size 否 Integer 测速块大小(KB)。取值范围为[64-1024]。默认:64。 test_time_gap 否 Integer 测速块时间间隔(ms)。取值范围为[1000-100000]。默认:10000。 表32 compression_switch_options 参数 是否必选 参数类型 描述 compression_threshold 否 Integer 压缩阈值(Byte)。取值范围为[0-10240]。默认:512。 minimum_compression_rate 否 Integer 最小压缩率。取值范围为[0-1000]。默认:900。 表33 linux_file_size_supported_options 参数 是否必选 参数类型 描述 linux_file_size_supported_threshold 否 Integer Linux设置文件大小阈值(Byte)。取值范围为[0-4096]。默认:100。 表34 redirection_send_file_options 参数 是否必选 参数类型 描述 read_write_speed 否 Integer 读写速度(Kbps)。取值范围为[0-2147483647]。默认:0。 表35 clipboard_redirection_options 参数 是否必选 参数类型 描述 rich_text_redirection_enable 否 Boolean 是否开启剪切板富文本重定向。取值为: false:表示关闭。 true:表示开启。 rich_text_clipboard_redirection 否 String 剪切板富文本重定向。取值为: DISABLED:表示禁用。(默认) SERVER_TO_CLIENT_ENABLED:表示开启服务端到客户端。 CLIENT_TO_SERVER_ENABLED:表示开启客户端到服务端。 TWO_WAY_ENABLED:表示开启双向。 clipboard_file_redirection_enable 否 Boolean 是否开启剪切板文件重定向。取值为: false:表示关闭。 true:表示开启。 file_clipboard_redirection 否 String 剪切板文件重定向。取值为: DISABLED:表示禁用。(默认) SERVER_TO_CLIENT_ENABLED:表示开启服务端到客户端。 CLIENT_TO_SERVER_ENABLED:表示开启客户端到服务端。 TWO_WAY_ENABLED:表示开启双向。 表36 Session 参数 是否必选 参数类型 描述 sbc 否 Sbc object SBC结构体。 表37 Sbc 参数 是否必选 参数类型 描述 sbc_automatic_disconnection 否 String 连接策略: DISABLED:已禁用 AUTO_DISCONNECT:自动断开 AUTO_LOCK:自动锁屏 sbc_automatic_disconnection_options 否 SbcAutomaticDisconnectionOptions object 自动连接选项。 表38 SbcAutomaticDisconnectionOptions 参数 是否必选 参数类型 描述 disconnection_waiting_time 否 Integer 等待时间(分钟)。 sbc_auto_logout 否 Boolean 是否自动注销。取值为:false:表示是。true:表示否。 auto_logout_options 否 AutoLogoutOptions object 自动注销。 表39 AutoLogoutOptions 参数 是否必选 参数类型 描述 sbc_logout_waiting_time 否 Integer 会话断连保留时长(分钟)。 表40 VirtualChannel 参数 是否必选 参数类型 描述 virtual_channel_control_enable 否 Boolean 是否开启虚拟通道策略设置。取值为:false:表示关闭。true:表示开启。 options 否 VirtualChannelOptions object 虚拟通道策略控制的选项。 表41 VirtualChannelOptions 参数 是否必选 参数类型 描述 custom_virtual_channel_name 否 String 自定义虚拟通道注册名。 virtual_channel_plugin_details 否 String 虚拟通道下载配置信息,需Base64加密。 third_party_plugin_name 否 String 第三方插件名称。 表42 keyboard_mouse 参数 是否必选 参数类型 描述 mouse_feedback 否 String 虚拟机鼠标回馈。取值为: SELFADAPTION:自适应鼠标回馈。 FORCE:强制鼠标回馈。 CLOSE:关闭鼠标回馈。 mouse_simulation_mode 否 String 虚拟机鼠标模拟方式。取值为: ABSOLUTE_POSITION:绝对位置模拟。 RELATIVE_POSITION:相对位置模拟。 external_cursor_feedback 否 Boolean 虚拟机外部光标反馈。取值为: false:表示关闭。 true:表示开启。 表43 Bandwidth 参数 是否必选 参数类型 描述 intelligent_data_transport_flag 否 String 智能显示传输。取值为:DISABLE:表示关闭。ENABLE:表示开启。DIAGNOSTIC:诊断模式。 total_bandwidth_control_enable 否 Boolean 是否开启总带宽控制。取值为:false:表示关闭。true:表示开启。 options 否 TotalBandwidthControlOptions object 总带宽控制的选项。 display_bandwidth_control_enable 否 Boolean 是否开启显示带宽控制。取值为:false:表示关闭。true:表示开启。 display_bandwidth_control_options 否 DisplayBandwidthControlOptions object 显示带宽控制的选项。 multimedia_bandwidth_control_enable 否 Boolean 是否开启多媒体带宽控制。取值为:false:表示关闭。true:表示开启。 multimedia_bandwidth_control_options 否 MultimediaBandwidthControlOptions object 多媒体带宽控制的选项。 usb_bandwidth_control_enable 否 Boolean 是否开启USB带宽控制。取值为:false:表示关闭。true:表示开启。 usb_bandwidth_control_options 否 UsbBandwidthControlOptions object USB带宽控制的选项。 pcsc_bandwidth_control_enable 否 Boolean 是否开启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 虚拟通道带宽控制的选项。 表44 TotalBandwidthControlOptions 参数 是否必选 参数类型 描述 total_bandwidth_control_value 否 Integer 总带宽控制量(Kbps)。取值范围为[10000-1000000]。默认:30000。 display_bandwidth_percentage_enable 否 Boolean 显示带宽百分比控制。取值为:false:表示关闭。true:表示开启。 display_bandwidth_percentage_options 否 DisplayBandwidthPercentageOptions object 显示带宽百分比控制的选项。 multimedia_bandwidth_percentage_enable 否 Boolean 多媒体带宽百分比控制。取值为:false:表示关闭。true:表示开启。 multimedia_bandwidth_percentage_options 否 MultimediaBandwidthPercentageOptions object 多媒体带宽百分比控制的选项。 usb_bandwidth_percentage_enable 否 Boolean USB带宽百分比控制。取值为:false:表示关闭。true:表示开启。 usb_bandwidth_percentage_options 否 UsbBandwidthPercentageOptions object USB带宽百分比控制的选项。 pcsc_bandwidth_percentage_enable 否 Boolean PCSC带宽百分比控制。取值为:false:表示关闭。true:表示开启。 pcsc_bandwidth_percentage_options 否 PcscBandwidthPercentageOptions object PCSC带宽百分比控制的选项。 twain_bandwidth_percentage_enable 否 Boolean TWAIN带宽百分比控制。取值为:false:表示关闭。true:表示开启。 twain_bandwidth_percentage_options 否 TwainBandwidthPercentageOptions object TWAIN带宽百分比控制的选项。 printer_bandwidth_percentage_enable 否 Boolean 打印机带宽百分比控制。取值为:false:表示关闭。true:表示开启。 printer_bandwidth_percentage_options 否 PrinterBandwidthPercentageOptions object 打印机带宽百分比控制的选项。 com_bandwidth_percentage_enable 否 Boolean 串口带宽百分比控制。取值为:false:表示关闭。true:表示开启。 com_bandwidth_percentage_options 否 ComBandwidthPercentageOptions object 串口带宽百分比控制的选项。 file_redirection_bandwidth_percentage_enable 否 Boolean 文件重定向带宽百分比控制。取值为:false:表示关闭。true:表示开启。 file_redirection_bandwidth_percentage_options 否 FileRedirectionBandwidthPercentageOptions object 文件重定向带宽百分比控制的选项。 clipboard_bandwidth_percentage_enable 否 Boolean 剪切板带宽百分比控制。取值为:false:表示关闭。true:表示开启。 clipboard_bandwidth_percentage_options 否 ClipboardBandwidthPercentageOptions object 剪切板带宽百分比控制的选项。 secure_channel_bandwidth_percentage_enable 否 Boolean 安全通道带宽百分比控制。取值为:false:表示关闭。true:表示开启。 secure_channel_bandwidth_percentage_options 否 SecureChannelBandwidthPercentageOptions object 安全通道带宽百分比控制的选项。 camera_bandwidth_percentage_enable 否 Boolean 摄像头带宽百分比控制。取值为:false:表示关闭。true:表示开启。 camera_bandwidth_percentage_options 否 CameraBandwidthPercentageOptions object 摄像头带宽百分比控制的选项。 virtual_channel_bandwidth_percentage_enable 否 Boolean 虚拟通道带宽百分比控制。取值为:false:表示关闭。true:表示开启。 virtual_channel_bandwidth_percentage_options 否 VirtualChannelBandwidthPercentageOptions object 虚拟通道带宽百分比控制的选项。 表45 DisplayBandwidthPercentageOptions 参数 是否必选 参数类型 描述 display_bandwidth_percentage_value 否 Integer 显示带宽百分比控制量(%)。取值范围为[0-100]。默认:65。 表46 MultimediaBandwidthPercentageOptions 参数 是否必选 参数类型 描述 multimedia_bandwidth_percentage_value 否 Integer 多媒体带宽百分比控制量(%)。取值范围为[0-100]。默认:50。 表47 UsbBandwidthPercentageOptions 参数 是否必选 参数类型 描述 usb_bandwidth_percentage_value 否 Integer USB带宽百分比控制量(%)。取值范围为[0-100]。默认:100。 表48 PcscBandwidthPercentageOptions 参数 是否必选 参数类型 描述 pcsc_bandwidth_percentage_value 否 Integer PCSC带宽百分比控制量(%)。取值范围为[0-100]。默认:5。 表49 TwainBandwidthPercentageOptions 参数 是否必选 参数类型 描述 twain_bandwidth_percentage_value 否 Integer TWAIN带宽百分比控制量(%)。取值范围为[0-100]。默认:15。 表50 PrinterBandwidthPercentageOptions 参数 是否必选 参数类型 描述 printer_bandwidth_percentage_value 否 Integer 打印机带宽百分比控制量(%)。取值范围为[0-100]。默认:5。 表51 ComBandwidthPercentageOptions 参数 是否必选 参数类型 描述 com_bandwidth_percentage_value 否 Integer 串口带宽百分比控制量(%)。取值范围为[0-100]。默认:3。 表52 FileRedirectionBandwidthPercentageOptions 参数 是否必选 参数类型 描述 file_redirection_bandwidth_percentage_value 否 Integer 文件重定向带宽百分比控制量(%)。取值范围为[0-100]。默认:30。 表53 ClipboardBandwidthPercentageOptions 参数 是否必选 参数类型 描述 clipboard_bandwidth_percentage_value 否 Integer 剪切板带宽百分比控制量(%)。取值范围为[0-100]。默认:3。 表54 SecureChannelBandwidthPercentageOptions 参数 是否必选 参数类型 描述 secure_channel_bandwidth_percentage_value 否 Integer 安全通道带宽百分比控制量(%)。取值范围为[0-100]。默认:30。 表55 CameraBandwidthPercentageOptions 参数 是否必选 参数类型 描述 camera_bandwidth_percentage_value 否 Integer 摄像头带宽百分比控制量(%)。取值范围为[0-100]。默认:30。 表56 VirtualChannelBandwidthPercentageOptions 参数 是否必选 参数类型 描述 virtual_channel_bandwidth_percentage_value 否 Integer 虚拟通道带宽百分比控制量(%)。取值范围为[0-100]。默认:65。 表57 DisplayBandwidthControlOptions 参数 是否必选 参数类型 描述 display_bandwidth_control_value 否 Integer 显示带宽控制量(Kbps)。取值范围为[500-50000]。默认:20000。 表58 MultimediaBandwidthControlOptions 参数 是否必选 参数类型 描述 multimedia_bandwidth_control_value 否 Integer 多媒体带宽控制量(Kbps)。取值范围为[5000-20000]。默认:15000。 表59 UsbBandwidthControlOptions 参数 是否必选 参数类型 描述 usb_bandwidth_control_value 否 Integer USB带宽控制量(Kbps)。取值范围为[1000-30000]。默认:30000。 表60 PcscBandwidthControlOptions 参数 是否必选 参数类型 描述 pcsc_bandwidth_control_value 否 Integer PCSC带宽控制量(Kbps)。取值范围为[1000-5000]。默认:2000。 表61 TwainBandwidthControlOptions 参数 是否必选 参数类型 描述 twain_bandwidth_control_value 否 Integer TWAIN带宽控制量(Kbps)。取值范围为[2000-10000]。默认:5000。 表62 PrinterBandwidthControlOptions 参数 是否必选 参数类型 描述 printer_bandwidth_control_value 否 Integer 打印机带宽控制量(Kbps)。取值范围为[1000-5000]。默认:2000。 表63 ComBandwidthControlOptions 参数 是否必选 参数类型 描述 com_bandwidth_control_value 否 Integer 串口带宽控制量(Kbps)。取值范围为[500-2000]。默认:1000。 表64 FileRedirectionBandwidthControlOptions 参数 是否必选 参数类型 描述 file_redirection_bandwidth_control_value 否 Integer 文件重定向带宽控制量(Kbps)。取值范围为[500-20000]。默认:10000。 表65 ClipboardBandwidthControlOptions 参数 是否必选 参数类型 描述 clipboard_bandwidth_control_value 否 Integer 剪切板带宽控制量(Kbps)。取值范围为[100-2000]。默认:1000。 表66 SecureChannelBandwidthControlOptions 参数 是否必选 参数类型 描述 secure_channel_bandwidth_control_value 否 Integer 安全通道带宽控制量(Kbps)。取值范围为[500-20000]。默认:10000。 表67 CameraBandwidthControlOptions 参数 是否必选 参数类型 描述 camera_bandwidth_control_value 否 Integer 摄像头带宽控制量(Kbps)。取值范围为[0-10000]。默认:10000。 表68 VirtualChannelBandwidthControlOptions 参数 是否必选 参数类型 描述 virtual_channel_bandwidth_control_value 否 Integer 虚拟通道带宽控制量(Kbps)。取值范围为[500-20000]。默认:20000。 表69 custom 参数 是否必选 参数类型 描述 custom_configuration1_enable 否 Boolean 自定义策略配置项1: false: 表示关闭 true: 表示开启 options 否 CustomOptions object 自定义策略设置项。 表70 CustomOptions 参数 是否必选 参数类型 描述 custom_configuration1_rule 否 String 配置项1内容。
  • 响应示例 状态码: 200 成功响应。 { "availability_zones" : [ { "availability_zone" : "cn-north-7a", "display_name" : "cn-north-7a", "i18n" : { "en_us" : "AZ1", "zh_cn" : "可用区1" }, "sold_out" : { "products" : [ ] }, "product_ids" : [ ], "visible" : true, "default_availability_zone" : false }, { "availability_zone" : "cn-north-7b", "display_name" : "cn-north-7b", "i18n" : { "en_us" : "AZ2", "zh_cn" : "可用区2" }, "sold_out" : { "products" : [ ] }, "product_ids" : [ ], "visible" : true, "default_availability_zone" : false }, { "availability_zone" : "cn-north-7c", "display_name" : "cn-north-7c", "i18n" : { "en_us" : "AZ3", "zh_cn" : "可用区3" }, "sold_out" : { "products" : [ ] }, "product_ids" : [ ], "visible" : true, "default_availability_zone" : false } ], "total_count" : 3 }
  • 请求示例 POST /v1/a4da8115c9d8464ead3a38309130523f/app-groups/actions/batch-delete-authorization { "app_group_ids" : [ "571784876773081141" ], "accounts" : [ { "account" : "user000", "account_type" : "USER", "domain" : "wksapp***.huawei.com" } ] }
共100000条