华为云用户手册

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

请求示例 PATCH /v1/a4da8115c9d8464ead3a38309130523f/app-servers/actions/batch-update-tsvi { "items" : [ { "id" : "3f791197-d166-4c8e-81e4-38c40ffc1989", "enable" : true }, { "id" : "62f48b59-0ebb-4b1e-ad35-f64948a0591b", "enable" : true } ] }

响应示例 状态码： 200 成功响应。 { "count" : 1, "items" : [ { "id" : "573548db-9a6f-4b31-a5cb-d7aa40975466", "name" : "APS-20230509102837-IVTU6S27OY", "machine_name" : "APS-PR6KRMAL00", "description" : "", "server_group_id" : "a0890780-7ef2-4aaf-b56d-b25fb53b717e", "flavor" : { "id" : "s2.large.2", "links" : [ { "rel" : "self" }, { "rel" : "bookmark" } ] }, "status" : "REGISTERED", "create_time" : "2023-05-09T10:28:38.755Z", "update_time" : "2023-05-09T10:39:03.484Z", "image_id" : "ca8be629-112e-4865-b4fb-bbbca257f1d9", "availability_zone" : "cn-north-7a", "domain" : "wksapp***.huawei.com", "ou_name" : "", "sid" : "S-1-5-21-1213649063-4191095369-2401105760-1399", "instance_id" : "4fa75b74-56bc-4a6b-b965-f2f139e17b5e", "os_version" : "Windows Server 2019 Datacenter 64bit", "os_type" : "Windows", "order_id" : "", "maintain_status" : false, "scaling_auto_create" : false, "resource_pool_id" : "10dd1a4f-ff85-4953-aa0f-2a37f28b6beb", "resource_pool_type" : "private", "server_group_name" : "Nas", "product_info" : { "product_id" : "workspace.appstream.general.xlarge.2", "flavor_id" : "s2.large.2", "type" : "BASE", "architecture" : "x86", "cpu" : "2", "memory" : "4096", "is_gpu" : false, "system_disk_type" : "SAS", "system_disk_size" : "80", "descriptions" : "s2.large.2 云应用通用型|2核|4GB内存", "charge_mode" : "0", "contain_data_disk" : false, "resource_type" : "hws.resource.type.workspace.appstream", "cloud_service_type" : "hws.service.type.vdi", "volume_product_type" : "workspace", "sessions" : 1, "status" : "abandon" }, "metadata" : { "charging_mode" : "0", "metering.resourcespeccode" : "s2.large.2.win", "metering.resourcetype" : "1" }, "session_count" : 1, "vm_status" : "ACTIVE", "task_status" : "null", "freeze" : [ ], "host_address" : [ { "addr" : "192.*.*.145", "version" : 4, "OS-EXT-IPS-MAC:mac_addr" : "fa:16:**:**:75:06", "OS-EXT-IPS:type" : "FIXED", "OS-EXT-IPS:port_id" : "257f2ff5-fe85-4b9a-86c2-5dacb64ac78f", "vpc_id" : "59785ba5-e5d5-4836-b9de-19f22ac15175", "subnet_id" : "a5842cb4-5718-4b0a-8b27-3a3e9c74f977", "tenant_type" : "tenant" }, { "addr" : "10.*.*.79", "version" : 4, "OS-EXT-IPS-MAC:mac_addr" : "fa:16:**:**:02:88", "OS-EXT-IPS:type" : "FIXED", "OS-EXT-IPS:port_id" : "c6fc6fcc-c99e-4604-b0e0-04e48246c7cd", "vpc_id" : "82f75215-9ae6-4e69-882c-fe4088324839", "subnet_id" : "e851a83c-8696-48ea-b078-466fe9d361ae", "tenant_type" : "resource_tenant" } ] } ] }

URI GET /v1/{project_id}/app-servers 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目唯一标识。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询的偏移量。 limit 否 Integer 查询的数量，值区间[1-100]。 server_group_id 否 String 服务器组唯一标识。 server_name 否 String 服务器名称，支持部分匹配。 server_id 否 String 服务器唯一标识。 maintain_status 否 String 服务器维护状态： true : 维护态的实例。 false: 非维护态的实例。 scaling_auto_create 否 String 是否是弹性创建： true : 通过弹性伸缩创建。 false: 不是通过弹性伸缩创建。

响应参数 状态码： 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 错误描述。 状态码： 415 表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 成功响应。 { "count" : 1, "items" : [ { "storage_claim_id" : "a0890780-7ef2-4aaf-b56d-b25fb53b717e", "folder_path" : "shares/video/", "delimiter" : "/", "claim_mode" : "SHARE", "count" : { "USER" : 0, "USER_GROUP" : 1 } } ] }

URI GET /v1/{project_id}/persistent-storages/actions/list-share-folders 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询的偏移量。 limit 否 Integer 单次查询的大小[1-100]。 storage_id 是 String WKS存储ID。 storage_claim_id 否 String WKS存储目录声明ID。 path 否 String 查询名称需满足如下规则: 可见字符+空格。 长度0~128个字符。

响应参数 状态码： 200 表72 响应Body参数 参数 参数类型 描述 id String 被修改策略主键。 状态码： 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 是 PolicyGroupForUpdate object 修改的策略组详情。 表4 PolicyGroupForUpdate 参数 是否必选 参数类型 描述 policy_group_name 是 String 策略组名称，名称需要满足如下规则： 由英文、数字或者下划线组成，不能有空格。 字符长度范围1-55。 description 否 String 策略组描述。 priority 否 Integer 优先级。 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：表示开启双向。 clipboard_length_limit_cts_enable 否 Boolean 本地到虚拟机长度限制开关。取值为： false: 标识关闭。 ture: 标识开启。 clipboard_length_limit_cts 否 Integer 本地到虚拟机长度限制。 clipboard_length_limit_stc_enable 否 Boolean 虚拟机到本地到长度限制开关。取值为： false: 标识关闭。 ture: 标识开启。 clipboard_length_limit_stc 否 Integer 虚拟机到本地长度限制。 表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内容。

请求示例 /v2/{project_id}/desktops/resource_instances/action { "offset" : "100", "limit" : "100", "action" : "filter", "matchs" : [ { "key" : "resource_name", "value" : "resource1" } ], "not_tags" : [ { "key" : "key1", "values" : [ "*value1", "value2" ] } ], "tags" : [ { "key" : "key1", "values" : [ "*value1", "value2" ] } ], "tags_any" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ], "not_tags_any" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 否 String 发送的实体的MIME类型 表3 请求Body参数 参数 是否必选 参数类型 描述 offset 否 String 默认为0 limit 否 String 默认为1000 action 否 String 如果是filter就是分页查询，如果是count只需按照条件将总条数返回即可 without_any_tag 否 Boolean 包含任意一个标签,该字段为true时查询所有不带标签的资源 matches 否 Array of Match objects match对象 tags 否 Array of Tags objects 包含的标签对象，只要有一个不包含，就不符合，一个key对应多个value tags_any 否 Array of Tags objects 包含任意标签，若全都不包含，不符合，一个key对应多个value not_tags 否 Array of Tags objects 不包含标签，只要有一个不包含，就符合了，一个key对应多个value not_tags_any 否 Array of Tags objects 不包含任意标签，只要包含其中一个，就不符合，一个key对应多个value 表4 Match 参数 是否必选 参数类型 描述 key 是 String 搜索时要匹配的字段 value 是 String 搜索时匹配的值，当key=resource_name时为模糊匹配 表5 Tags 参数 是否必选 参数类型 描述 key 否 String 标签key。 values 否 Array of strings 标签value。

响应示例 状态码： 200 成功响应。 { "id" : "702364883651395584", "job_type" : "CREATE_SERVER_IMAGE", "begin_time" : "2024-05-20T10:39:49.61Z", "end_time" : "2024-05-20T11:03:24.206Z", "status" : "SUC CES S", "sub_jobs_total" : 1, "sub_jobs" : [ { "id" : "702364884037271552", "job_type" : "CREATE_SERVER_IMAGE", "job_resource_info" : { "resource_id" : "f5d443de-a623-4950-a74d-569fe63c1f7a", "resource_name" : "123" }, "begin_time" : "2024-05-20T10:39:50.723Z", "end_time" : "2024-05-20T11:03:24.194Z", "status" : "SUCCESS", "job_execute_info" : { "error_code" : "", "error_message" : "" }, "project_id" : "a4da8115c9d8464ead3a38309130523f", "job_id" : "702364883651395584" } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 id String 任务ID。 job_type String 任务类型。 begin_time String 任务创建时间。 end_time String 任务结束时间。 status String 任务状态。 sub_jobs_total Integer 子任务总数。 sub_jobs Array of ImageJobDetailInfo objects 子任务列表 表4 ImageJobDetailInfo 参数 参数类型 描述 id String 子任务ID。 job_type String job类型 CREATE_SERVER - 创建镜像实例 CREATE_SERVER_IMAGE - 构建镜像 DELETE_SERVER - 删除镜像实例 job_resource_info ImageJobResourceInfo object 任务结果对应的资源信息，根据任务类型区分： 镜像实例 - 镜像实例信息 镜像 - 镜像信息 begin_time String 任务创建时间。 end_time String 任务结束时间。 status String 任务状态。 job_execute_info ImageJobExecuteInfo object 任务执行失败信息 project_id String 项目ID。 job_id String 任务ID。 表5 ImageJobResourceInfo 参数 参数类型 描述 resource_id String 资源ID resource_name String 产物名称，或者被操作资源名称 表6 ImageJobExecuteInfo 参数 参数类型 描述 error_code String 任务执行失败时的错误码。 error_message String 任务失败原因。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 404 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 405 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 500 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 503 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

响应示例 状态码： 200 操作成功。 { "server_metrics" : [ { "datapoints" : [ { "average" : 0.23, "timestamp" : 1442341200000, "unit" : "%" } ], "metric_name" : "gpu_usage_encoder", "dimension_value" : "2e84018fc8b4484b94e89aae212fe615" }, { "datapoints" : [ { "average" : 0.23, "timestamp" : 1442341200000, "unit" : "%" } ], "metric_name" : "gpu_usage_encoder", "dimension_value" : "7784018fc8b4484b94e89aae212fe455" } ] }

请求示例 GET /v1/a4da8115c9d8464ead3a38309130523f/app-servers/server-metric-data/8115c9d8464ead3a38309130?namespace=AGT.ECS&metric_name=cpu_util&from=1691671739879&to=1691671739872&period=1&filter=average

URI GET /v1/{project_id}/app-servers/server-metric-data/{server_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目唯一标识。 server_id 是 String 服务器唯一标识。 表2 Query参数 参数 是否必选 参数类型 描述 namespace 是 String 服务的命名空间：例如 "SYS.ECS/AGT.ECS"，当namespace为AGT.ECS，则查询GPU监控指标： - SYS.ECS：弹性云服务器的基础监控指标。 - AGT.ECS：弹性云服务器操作系统监控的监控指标（GPU指标）。 metric_name 是 String 监控查询指标名称: - SYS.ECS命名空间的指标名称,请参考帮助文档：“弹性云服务器支持的基础监控指标”。 - AGT.ECS命名空间的指标名称,请参考帮助文档：“操作系统监控指标：GPU”。 from 是 String 查询数据起始时间，UNIX时间戳，单位毫秒。 to 是 String 查询数据截止时间UNIX时间戳，单位毫秒。from必须小于to。 period 是 Integer 监控数据粒度。 取值范围： - 1: 实时数据。 - 300: 5分钟粒度。 - 1200: 20分钟粒度。 - 3600: 1小时粒度。 - 14400: 4小时粒度。 - 86400: 1天粒度。 filter 是 String 数据聚合方式，支持的聚合方式如下: - average：聚合周期内指标数据的平均值。 - max：聚合周期内指标数据的最大值。 - min：聚合周期内指标数据的最小值。 - sum：聚合周期内指标数据的求和值。 - variance：聚合周期内指标数据的方差。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 server_metrics Array of ServerMetricData objects 监控数据。 表5 ServerMetricData 参数 参数类型 描述 metric_name String 监控指标名称。 datapoints Array of ServerDataPoints objects 指标数据列表。 dimension_value String 维度值，仅查询GPU监控信息时有值。 表6 ServerDataPoints 参数 参数类型 描述 average Double 聚合周期内指标数据的平均值。 max Double 聚合周期内指标数据的最大值。 min Double 聚合周期内指标数据的最小值。 sum Double 聚合周期内指标数据的求和值。 variance Double 聚合周期内指标数据的方差。 timestamp Long 指标采集时间，UNIX时间戳，单位毫秒。 unit String 指标单位。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 404 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 405 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 500 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 503 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 uri String 分发软件信息的URI。 状态码： 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 成功响应。 { "count" : 2, "items" : [ { "id" : "697612196993040384", "name" : "test_instance_1", "description" : "A test of creating an image instance.", "image_ref" : { "id" : "da02e5ca-c6ec-4685-8ecb-f116bb5bdd2c", "image_type" : "gold", "spce_code" : "90a6e84bb3e822fe54999b6be5bbae1e", "product_id" : "" }, "server_group_id" : "dae99966-76c4-4995-adaf-e8e2ab36869a", "app_group_id" : "", "server_id" : "", "instance_id" : "", "image_id" : "", "status" : "CREATING", "authorize_accounts" : [ { "account" : "user0012", "account_type" : "USER" } ], "create_time" : "2024-05-07T07:54:21.009Z", "update_time" : "2024-05-07T07:54:22.329Z", "enterprise_project_id" : "0" }, { "id" : "627989489700044800", "name" : "test_instance_2", "description" : "", "image_ref" : { "id" : "da02e5ca-c6ec-4685-8ecb-f116bb5bdd2c", "image_type" : "gold", "spce_code" : "90a6e84bb3e822fe54999b6be5bbae1e", "product_id" : "" }, "server_group_id" : "898dda82-4d61-4c3d-bff2-679e61cd34f3", "app_group_id" : "627991243116249088", "server_id" : "wksapp-08722b58-6900-4c03-bfc0-99e1a056b8ad", "instance_id" : "989e6391-43b5-49a7-a684-6c36e7ad714a", "image_id" : "", "status" : "ACTIVE", "authorize_accounts" : [ { "account" : "user001", "account_type" : "USER" } ], "create_time" : "2023-10-28T04:58:34.058Z", "update_time" : "2023-10-28T05:05:33.826Z", "enterprise_project_id" : "0" } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数 items Array of ImageServer objects 镜像实例列表返回列表条目数量上限为分页的最大上限值。 表5 ImageServer 参数 参数类型 描述 id String 实例的唯一标识。 name String 镜像实例名称。 description String 描述。 image_ref ImageRef object 镜像源信息。 server_group_id String APS服务器组ID。 app_group_id String 应用组ID。 server_id String APS实例ID。 instance_id String ECS服务器ID。 image_id String 镜像产物唯一标识。 status String 镜像实例的状态: 'CREATING' - 实例创建中 'ACTIVE' - 实例正常运行 'BUILDING' - 镜像创建中 'BUILT' - 镜像任务结束 'ERROR' - 实例处于异常 'DELETING' - 实例删除中 'NULL' - 未设置 authorize_accounts Array of ImageAccountInfo objects 应用组授权用户， 限制用户类型：'USER' - 用户 create_time String 镜像实例创建时间 update_time String 更新时间 enterprise_project_id String 企业项目ID,仅企业项目需配置(字段为空或者0表示使用默认default企业项目) 表6 ImageRef 参数 参数类型 描述 id String 镜像源的唯一标识。 image_type String 镜像源的镜像类型: gold - 云市场镜像 public - 公共镜像 private - 私有镜像 shared - 共享镜像 other - 其他 spce_code String 镜像源的规格编码，对于gold镜像类型，这个值是的必须项。 product_id String 镜像源的产品ID，对于gold镜像类型，这个值是的必须项。 表7 ImageAccountInfo 参数 参数类型 描述 account String 用户(组)。 account_type String 用户类型： USER - 用户 USER_GROUP - 用户组 domain String 域名 城。 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 401 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 403 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 404 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 405 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 500 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 503 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

URI GET /v1/{project_id}/image-servers 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目唯一标识。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询的偏移量。 limit 否 Integer 查询的数量，值区间[1-100]。 server_name 否 String 镜像实例名称，支持部分匹配。 server_id 否 String 镜像实例唯一标识。 enterprise_project_id 否 String 企业项目ID(字段为空或者0表示使用默认default企业项目)。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 items Array of AttachServerAppInfo objects 分发软件信息列表。 表4 AttachServerAppInfo 参数 参数类型 描述 id String 分发软件版本ID。 app_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 错误描述。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 items 是 Array of strings 批量唯一标识请求列表，一次请求数量区间 [1, 20] recursive 是 Boolean 是否同时删除镜像实例关联资源： ⚠ 警告: 关联资源删除，对应的应用将不可用 true 同时删除关联资源，包括APS服务器组，APS服务器，应用组相关资源。镜像产物相关信息保留。 false 只删除镜像实例记录，保留关联资源。

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

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 type String 登录类型: novnc vnc url String 远程登录控制台地址。 protocol 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 错误描述。

请求示例 PATCH /v1/a4da8115c9d8464ead3a38309130523f/app-warehouse/apps/5298741256415 { "app_name" : "记事本", "app_category" : "GAME", "os_type" : "Windows", "version_id" : "3.1.2", "app_description" : "XXX公司 XX软件开发应用", "version_name" : "测试版本", "app_icon" : "a2FybWEK" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 app_name 否 String 应用名称,名称需满足如下规则: 由中文，英文大小写，数字，_-组成。 长度范围1~64个字符。 app_category 否 String 应用分类。 os_type 否 String 操作系统类型。 version_id 否 String 版本号,名称需满足如下规则: 由可见字符组成。 长度范围1~64个字符。 app_description 否 String 应用仓库中的应用描述。 version_name 否 String 版本描述,名称需满足如下规则: 由可见字符组成。 长度范围1~255个字符。 app_icon 否 String 说明： 图片的默认大小当前限制为8KB，即1024 * 8字节。 如果数据格式为data;image/png;base64,iVBORw0KGgoAAAANS时实际大小约为字段约为：size * 4/3 + 4bytes。

响应参数 状态码： 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 错误描述。 状态码： 409 表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 表4 响应Body参数 参数 参数类型 描述 id String 应用的记录id。 app_id String 应用id。 tenant_id String 租户id。 app_name String 应用名称。 app_category String 应用分类。 os_type String 操作系统类型。 version_id String 版本号。 version_name String 版本名称。 appfile_store_path String 应用文件的存放路径。 app_file_size String 应用文件的大小，以KB为单位。 app_description String 应用描述。 appicon_store_path String 应用文件的存放路径。 create_time String 应用创建时间。 modify_time String 应用修改时间。 verify_time String 应用审核时间。 verify_status String 审核状态。 verify_comment String 审核的评论意见。 app_icon String app的图标文件。 状态码： 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 错误描述。 状态码： 415 表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/app-warehouse/apps { "app_name" : "Postman", "app_category" : "PRODUCTIVITY_AND_COLLABORATION", "os_type" : "Windows", "version_name" : "Canary", "version_id" : "7.9.0.0", "appfile_store_path" : "file/Postman.exe", "app_description" : "A postman setup exe.", "app_icon" : "data:image/png;base64,iVBORw0KGWBUwmyIgfBRgjsA88DJ9OxpLdgbbFDuB+Pt***********w59LFEQHa+0QrAJNBfiSUVORK5CYII=", "app_file_size" : 401 }