华为云用户手册

约束与限制 云桌面Workspace 服务端API设置了调用次数限制，避免出现短时间内重复调用API，服务中断的情况，如表1和表2所示。 表1 云桌面 API流控限制 接口分类 接口名称 接口URI 用户流量限制 报表统计 查询对应指标维度是否存在满足通知规则的记录 GET /v2/{project_id}/statistics/notification-records 200次/分钟 查询接入云桌面或云应用各阶段时长数据 GET /v2/{project_id}/statistics/metrics/access-stages 200次/分钟 查询使用桌面的时长 POST /v2/{project_id}/desktops/statistics/used 100次/分钟 查询通知规则 GET /v2/{project_id}/statistics/notify-rules 200次/分钟 查询用户使用统计数据 GET /v2/{project_id}/statistics/metrics/users 200次/分钟 查询云应用接入统计数据 GET /v2/{project_id}/statistics/metrics/app-user-access 200次/分钟 查询在指定时间段未使用的桌面 GET /v2/{project_id}/desktops/statistics/unused 200次/分钟 查询指标 GET /v2/{project_id}/statistics/metrics 200次/分钟 查询指标环比值 GET /v2/{project_id}/statistics/growth-rate 200次/分钟 查询指标趋势 GET /v2/{project_id}/statistics/metrics/trend 200次/分钟 查询桌面使用情况统计数据 GET /v2/{project_id}/statistics/metrics/desktops 200次/分钟 登录状态统计 GET /v2/{project_id}/desktops/statistics/login-state 200次/分钟 更新通知规则 PUT /v2/{project_id}/statistics/notify-rules/{rule_id} 100次/分钟 删除通知规则 DELETE /v2/{project_id}/statistics/notify-rules/{rule_id} 100次/分钟 新增通知规则 POST /v2/{project_id}/statistics/notify-rules 100次/分钟 运行状态统计 GET /v2/{project_id}/desktops/statistics/run-state 200次/分钟 桌面统计 GET /v2/{project_id}/statistics 200次/分钟 策略组 查询策略组 GET /v2/{project_id}/policy-groups/{policy_group_id} 200次/分钟 查询策略组列表 GET /v2/{project_id}/policy-groups/{policy_group_id} 200次/分钟 查询策略组详情列表 GET /v2/{project_id}/policy-groups/detail 200次/分钟 查询策略组应用对象 GET /v2/{project_id}/policy-groups/{policy_group_id}/targets 200次/分钟 查询策略组中的策略项 GET /v2/{project_id}/policy-groups/{policy_group_id}/policies 200次/分钟 查询初始策略项 GET /v2/{project_id}/policy-groups/original-policies 200次/分钟 删除策略组 DELETE /v2/{project_id}/policy-groups/{policy_group_id} 100次/分钟 新增策略组 POST /v2/{project_id}/policy-groups 100次/分钟 修改策略组 PUT /v2/{project_id}/policy-groups/{policy_group_id} 100次/分钟 修改策略组应用对象 PUT /v2/{project_id}/policy-groups/{policy_group_id}/targets 100次/分钟 修改策略组中的策略项 PUT /v2/{project_id}/policy-groups/{policy_group_id}/policies 100次/分钟 查询接入策略 GET /v2/{project_id}/access-policy 200次/分钟 查询指定接入策略的应用对象 GET /v2/{project_id}/access-policy/{access_policy_id}/objects 200次/分钟 创建接入策略 POST /v2/{project_id}/access-policy 100次/分钟 更新指定接入策略 PUT /v2/{project_id}/access-policy/{access_policy_id} 100次/分钟 更新指定接入策略的应用对象 PUT /v2/{project_id}/access-policy/{access_policy_id}/objects 100次/分钟 删除接入策略 DELETE /v2/{project_id}/access-policy 100次/分钟 产品套餐 查询产品套餐列表 GET /v2/{project_id}/products 200次/分钟 查询可订购小时包类型 GET /v2/{project_id}/products/hour-packages 200次/分钟 查询协同套餐列表 GET /v2/{project_id}/products/sharer 200次/分钟 磁盘 查询磁盘产品信息 GET /v2/{project_id}/volume/products 200次/分钟 扩容磁盘 POST /v2/{project_id}/desktops/{desktop_id}/volumes/{volume_id}/expand 100次/分钟 扩容桌面磁盘 POST /v2/{project_id}/volumes/expand 100次/分钟 删除桌面数据盘 POST /v2/{project_id}/desktops/{desktop_id}/volumes/batch-delete 100次/分钟 增加桌面磁盘 POST /v2/{project_id}/desktops/{desktop_id}/volumes 100次/分钟 批量增加桌面磁盘 POST /v2/{project_id}/volumes 100次/分钟 订单 包周期下单 POST /v2/{project_id}/periodic/subscribe/order 100次/分钟 包周期云办公带宽变更下单 POST /v2/{project_id}/bandwidths/{bandwidth_id}/periodic/change/order 100次/分钟 包周期桌面池批量变更下单 POST /v2/{project_id}/desktop-pool/periodic/change/order 100次/分钟 包周期桌面批量变更下单 POST /v2/{project_id}/periodic/change/batch-order 100次/分钟 创建变更订单 POST /v2/{project_id}/periodic/{desktop_id}/change/order 100次/分钟 创建桌面订单 POST /v2/{project_id}/desktops/orders/subscribe 100次/分钟 定时任务 查询定时任务列表 GET /v2/{project_id}/scheduled-tasks/{task_id} 200次/分钟 查询定时任务详情 GET /v2/{project_id}/scheduled-tasks/{task_id} 200次/分钟 查询定时任务执行记录 GET /v2/{project_id}/scheduled-tasks/{task_id}/records 200次/分钟 查询定时任务执行记录详情 GET /v2/{project_id}/scheduled-tasks/{task_id}/records/{record_id} 200次/分钟 创建定时任务 POST /v2/{project_id}/scheduled-tasks 100次/分钟 获取时区配置 GET /v2/{project_id}/common/timezones 200次/分钟 批量删除定时任务 POST /v2/{project_id}/scheduled-tasks/batch-delete 100次/分钟 删除定时任务 DELETE /v2/{project_id}/scheduled-tasks/{task_id} 100次/分钟 未来执行的具体时间列表 POST /v2/{project_id}/scheduled-tasks/future-executions 100次/分钟 修改定时任务 PUT /v2/{project_id}/scheduled-tasks/{task_id} 100次/分钟 告警 查询告警列表 GET /v2/{project_id}/alarms 200次/分钟 查询告警统计 GET /v2/{project_id}/statistics/alarms 200次/分钟 脚本 查询脚本列表 GET /v2/{project_id}/scripts 200次/分钟 查询脚本任务列表 GET /v2/{project_id}/script-execution-tasks 200次/分钟 查询脚本详情 GET /v2/{project_id}/scripts/{script_id} 200次/分钟 查询脚本执行记录列表 GET /v2/{project_id}/script-execution-records 200次/分钟 查询脚本执行记录详情 GET /v2/{project_id}/script-execution-records/{record_id} 200次/分钟 更新脚本 PUT /v2/{project_id}/scripts/{script_id} 100次/分钟 批量执行脚本或命令 POST /v2/{project_id}/script-executions 100次/分钟 删除脚本 DELETE /v2/{project_id}/scripts/{script_id} 100次/分钟 停止脚本或者命令执行任务 POST /v2/{project_id}/script-executions/stop 100次/分钟 新增脚本 POST /v2/{project_id}/scripts 100次/分钟 重试脚本或执行脚本失败的任务 POST /v2/{project_id}/script-executions/retry 100次/分钟 镜像 查询产品镜像列表 GET /v2/{project_id}/images 200次/分钟 获取云市场镜像列表 GET /v2/{project_id}/market-images 200次/分钟 可用分区 查询可用分区列表 GET /v2/{project_id}/availability-zones 200次/分钟 查询可用分区列表概要 GET /v2/{project_id}/availability-zones/summary 200次/分钟 查询可用分区详情 GET /v2/{project_id}/availability-zones/detail 200次/分钟 快照 查询快照列表 GET /v2/{project_id}/snapshots 200次/分钟 批量创建快照 POST /v2/{project_id}/snapshots/batch-create 100次/分钟 批量恢复快照 POST /v2/{project_id}/snapshots/batch-restore 100次/分钟 批量删除快照 POST /v2/{project_id}/snapshots/batch-delete 100次/分钟 连接信息 查询登录人数 GET /v2/{project_id}/connections/online-users 200次/分钟 查询登录信息 GET /v2/{project_id}/connections/desktops 200次/分钟 查询桌面登录状态 GET /v2/{project_id}/connections/status 200次/分钟 导出连接记录 GET /v2/{project_id}/connections/desktops/export 200次/分钟 配额 查询租户单个站点配额详情 GET /v2/{project_id}/quotas/detail 200次/分钟 查询租户配额 GET /v2/{project_id}/quotas 200次/分钟 任务 查询任务详情 GET /v2/{project_id}/workspace-jobs/{job_id} 500次/分钟 删除子任务 POST /v2/{project_id}/workspace-sub-jobs/batch-delete 100次/分钟 重试任务 POST /v2/{project_id}/workspace-jobs/{job_id}/actions 100次/分钟 子任务查询 GET /v2/{project_id}/workspace-sub-jobs 500次/分钟 事件 查询用户事件 GET /v2/{project_id}/user-events 200次/分钟 网络 查询Nat网关列表 GET /v2/{project_id}/nat-gateways 200次/分钟 查询端口列表 GET /v2/{project_id}/ports 200次/分钟 查询上网功能 GET /v2/{project_id}/internet 200次/分钟 查询已绑定桌面和未绑定的Eip GET /v2/{project_id}/eips 200次/分钟 查询云办公带宽的控制配置 GET /v2/{project_id}/bandwidths/{bandwidth_id}/control-list 200次/分钟 查询云办公带宽列表 GET /v2/{project_id}/bandwidths 200次/分钟 查询正在被使用的子网id列表 GET /v2/{project_id}/subnets/using-subnets 200次/分钟 创建云办公带宽 POST /v2/{project_id}/bandwidths 100次/分钟 开通上网功能 POST /v2/{project_id}/internet 100次/分钟 开通桌面上网功能 POST /v2/{project_id}/eips 100次/分钟 批量桌面解绑EIP POST /v2/{project_id}/eips/unbinding 100次/分钟 删除云办公带宽 DELETE /v2/{project_id}/bandwidths/{bandwidth_id} 100次/分钟 修改云办公带宽 POST /v2/{project_id}/bandwidths/{bandwidth_id}/update 100次/分钟 修改云办公带宽的控制配置 PUT /v2/{project_id}/bandwidths/{bandwidth_id}/control-list 100次/分钟 桌面绑定EIP POST /v2/{project_id}/eips/binding 100次/分钟 委托 查询委托功能 GET /v2/{project_id}/agencies 200次/分钟 开通委托功能 POST /v2/{project_id}/agencies 100次/分钟 协同桌面 桌面购买附属资源 POST /v2/{project_id}/desktop/sub-resources 100次/分钟 桌面删除附属资源 POST /v2/{project_id}/desktop/delete-sub-resources 100次/分钟 询价 包周期桌面池变更规格批量询价 POST /v2/{project_id}/desktop-pool/periodic/inquiry/resize 100次/分钟 包周期桌面池扩容磁盘批量询价 POST /v2/{project_id}/desktop-pool/periodic/inquiry/extend-volume 100次/分钟 包周期桌面池切换镜像批量询价 POST /v2/{project_id}/desktop-pool/periodic/inquiry/change-image 100次/分钟 包周期桌面池添加单个磁盘批量询价 POST /v2/{project_id}/desktop-pool/periodic/inquiry/add-volume 100次/分钟 包周期桌面增配变更批量询价 POST /v2/{project_id}/periodic/inquiry/add-resources 100次/分钟 批量包周期桌面切换镜像询价 POST /v2/{project_id}/periodic/inquiry/change-image 100次/分钟 应用管控 查询管控规则列表 GET /v1/{project_id}/app-center/app-restricted-rules 200次/分钟 查询应用规则 GET /v1/{project_id}/app-center/app-rules 200次/分钟 创建应用规则 POST /v1/{project_id}/app-center/app-rules 100次/分钟 禁用规则管控 POST /v1/{project_id}/app-center/app-rules/actions/disable-rule-restriction 100次/分钟 批量删除管控规则列表 POST /v1/{project_id}/app-center/app-restricted-rules/actions/batch-delete 100次/分钟 批量删除规则 POST /v1/{project_id}/app-center/app-rules/batch-delete 100次/分钟 启用规则管控 POST /v1/{project_id}/app-center/app-rules/actions/enable-rule-restriction 100次/分钟 删除应用规则 DELETE /v1/{project_id}/app-center/app-rules/{rule_id} 100次/分钟 修改应用规则 PATCH /v1/{project_id}/app-center/app-rules/{rule_id} 100次/分钟 增加管控规则 POST /v1/{project_id}/app-center/app-restricted-rules 100次/分钟 应用中心 按照名称分页查询应用 GET /v1/{project_id}/app-center/apps 200次/分钟 查询应用安装job信息 GET /v1/{project_id}/app-center/jobs 200次/分钟 查询应用分类信息 GET /v1/{project_id}/app-center/app-catalogs 200次/分钟 查询应用授权信息 GET /v1/{project_id}/app-center/apps/{app_id}/authorizations 200次/分钟 批量删除job POST /v1/{project_id}/app-center/jobs/actions/batch-delete 100次/分钟 批量删除应用 POST /v1/{project_id}/app-center/apps/actions/batch-delete 100次/分钟 批量设置不可见 POST /v1/{project_id}/app-center/apps/actions/batch-disable 100次/分钟 批量设置可见 POST /v1/{project_id}/app-center/apps/actions/batch-enable 100次/分钟 批量设置应用授权 POST /v1/{project_id}/app-center/apps/actions/batch-assign-authorization 100次/分钟 批量自动安装应用 POST /v1/{project_id}/app-center/apps/actions/batch-auto-install 100次/分钟 删除应用 DELETE /v1/{project_id}/app-center/apps/{app_id} 100次/分钟 设置应用授权 POST /v1/{project_id}/app-center/apps/{app_id}/actions/assign-authorizations 100次/分钟 生成访问凭证信息 POST /v1/{project_id}/app-center/buckets/actions/create-credential 100次/分钟 添加并授权默认桶 POST /v1/{project_id}/app-center/buckets 100次/分钟 添加应用 POST /v1/{project_id}/app-center/apps 100次/分钟 修改应用 PATCH /v1/{project_id}/app-center/apps/{app_id} 100次/分钟 重试失败job POST /v1/{project_id}/app-center/jobs/actions/retry 100次/分钟 自动安装应用 POST /v1/{project_id}/app-center/apps/{app_id}/actions/auto-install 100次/分钟 用户 操作用户 POST /v2/{project_id}/users/{user_id}/actions 100次/分钟 查询OTP设备 GET /v2/{project_id}/users/{user_id}/otp-devices 200次/分钟 查询用户列表 GET /v2/{project_id}/users 200次/分钟 查询用户详情信息 GET /v2/{project_id}/users/{user_id} 200次/分钟 创建用户 POST /v2/{project_id}/users 100次/分钟 给用户重置随机密码 GET /v2/{project_id}/users/{user_id}/random-password 200次/分钟 解绑OTP设备 DELETE /v2/{project_id}/users/{user_id}/otp-devices 100次/分钟 批量创建用户 POST /v2/{project_id}/users/batch-create 100次/分钟 批量删除用户 POST /v2/{project_id}/users/batch-delete 100次/分钟 删除指定用户 DELETE /v2/{project_id}/users/{user_id} 100次/分钟 修改用户信息 PUT /v2/{project_id}/users/{user_id} 100次/分钟 重新发送邮件 POST /v2/{project_id}/users/{user_id}/resend-email 100次/分钟 用户组 操作用户组 POST /v2/{project_id}/groups/{group_id}/actions 100次/分钟 查询用户组列表 GET /v2/{project_id}/groups 200次/分钟 查询用户组中的用户 GET /v2/{project_id}/groups/{group_id}/users 200次/分钟 创建用户组 POST /v2/{project_id}/groups 100次/分钟 批量删除用户组 POST /v2/{project_id}/groups/batch-delete 100次/分钟 删除用户组 DELETE /v2/{project_id}/groups/{group_id} 100次/分钟 修改用户组信息 PUT /v2/{project_id}/groups/{group_id} 100次/分钟 云办公服务 查询边缘小站列表 GET /v2/{project_id}/wks-edge-sites 200次/分钟 查询云办公服务是否被锁定 GET /v2/{project_id}/workspaces/lock-status 200次/分钟 查询云办公服务详情 GET /v2/{project_id}/workspaces 200次/分钟 查询站点信息 GET /v2/{project_id}/sites 200次/分钟 解除云办公服务锁定状态 PUT /v2/{project_id}/workspaces/lock-status 100次/分钟 开通云办公服务 POST /v2/{project_id}/workspaces 100次/分钟 删除站点 DELETE /v2/{project_id}/sites/{site_id} 100次/分钟 新增站点 POST /v2/{project_id}/sites 100次/分钟 修改企业ID PUT /v2/{project_id}/workspaces/enterprise-id 100次/分钟 修改云办公服务属性 PUT /v2/{project_id}/workspaces 100次/分钟 修改站点接入方式 PUT /v2/{project_id}/sites/{site_id}/access-mode 100次/分钟 修改站点业务子网 PUT /v2/{project_id}/sites/{site_id}/subnet-ids 100次/分钟 注销云办公服务 DELETE /v2/{project_id}/workspaces 100次/分钟 终端与桌面绑定 查询终端与桌面绑定的开关配置信息 GET /v2/{project_id}/terminals/binding-desktops/config 200次/分钟 查询终端与桌面绑定配置列表 GET /v2/{project_id}/terminals/binding-desktops 200次/分钟 删除终端与桌面绑定配置 POST /v2/{project_id}/terminals/binding-desktops/batch-delete 100次/分钟 设置终端与桌面绑定的开关配置 POST /v2/{project_id}/terminals/binding-desktops/config 100次/分钟 修改终端与桌面绑定配置 PUT /v2/{project_id}/terminals/binding-desktops 100次/分钟 增加终端与桌面绑定配置 POST /v2/{project_id}/terminals/binding-desktops 100次/分钟 桌面 AD场景支持桌面更换关联用户名 PUT /v2/{project_id}/desktops/change-username 100次/分钟 安装agent POST /v2/{project_id}/desktops/agents 100次/分钟 变更规格 POST /v2/{project_id}/desktops/resize 100次/分钟 操作桌面 POST /v2/{project_id}/desktops/action 100次/分钟 查询sysprep版本信息 GET /v2/{project_id}/desktops/{desktop_id}/sysprep 200次/分钟 查询单个桌面详情 GET /v2/{project_id}/desktops/{desktop_id} 200次/分钟 查询桌面安装agent详情 GET /v2/{project_id}/desktops/agents 200次/分钟 查询桌面监控信息 GET /v2/{project_id}/desktop-monitor/{desktop_id} 200次/分钟 查询桌面开关机信息 GET /v2/{project_id}/desktops/{desktop_id}/actions 200次/分钟 查询桌面列表 GET /v2/{project_id}/desktops 200次/分钟 查询桌面网络 GET /v2/{project_id}/desktops/{desktop_id}/networks 200次/分钟 查询桌面详情列表 GET /v2/{project_id}/desktops/detail 200次/分钟 创建远程协助 POST /v2/{project_id}/desktops/{desktop_id}/remote-assistance 100次/分钟 创建桌面 POST /v2/{project_id}/desktops 100次/分钟 发送 消息通知 POST /v2/{project_id}/desktops/notifications 100次/分钟 分配用户 POST /v2/{project_id}/desktops/attach 100次/分钟 根据桌面id查询远程协助信息 GET /v2/{project_id}/desktops/{desktop_id}/remote-assistance 200次/分钟 根据子网id查询该子网下可用的ip GET /v2/{project_id}/subnets/{subnet_id}/available-ip 200次/分钟 更新桌面SID PUT /v2/{project_id}/desktops/sids 100次/分钟 解绑用户 POST /v2/{project_id}/desktops/detach 100次/分钟 批量查询桌面网络 GET /v2/{project_id}/desktops/networks 200次/分钟 批量分配用户 POST /v2/{project_id}/desktops/batch-attach 100次/分钟 批量解绑用户 POST /v2/{project_id}/desktops/batch-detach 100次/分钟 批量切换桌面网络 POST /v2/{project_id}/desktops/networks/batch-change 100次/分钟 批量删除桌面 POST /v2/{project_id}/desktops/batch-delete 100次/分钟 批量设置桌面维护模式 PUT /v2/{project_id}/desktops/maintenance-mode 100次/分钟 批量修改用户权限组 POST /v2/{project_id}/desktops/change-user-privilege-group 100次/分钟 切换桌面网络 PUT /v2/{project_id}/desktops/{desktop_id}/networks 100次/分钟 取消远程协助 DELETE /v2/{project_id}/desktops/{desktop_id}/remote-assistance 100次/分钟 删除单个桌面 DELETE /v2/{project_id}/desktops/{desktop_id} 100次/分钟 修改桌面属性 PUT /v2/{project_id}/desktops/{desktop_id} 100次/分钟 预批量分配用户 POST /v2/{project_id}/desktops/pre-batch-attach 100次/分钟 远程登录控制台 GET /v2/{project_id}/desktops/{desktop_id}/remote-consoles 200次/分钟 重建桌面 POST /v2/{project_id}/desktops/rebuild 100次/分钟 重新加入AD域 POST /v2/{project_id}/desktops/{desktop_id}/rejoin-domain 100次/分钟 桌面转镜像 POST /v2/{project_id}/desktops/desktop-to-image 100次/分钟 桌面标签 批量删除多个桌面标签 DELETE /v2/{project_id}/desktops/batch-tags 100次/分钟 批量添加多个桌面标签 POST /v2/{project_id}/desktops/batch-tags 100次/分钟 批量添加删除标签 POST /v2/{project_id}/desktops/{desktop_id}/tags/action 100次/分钟 删除桌面标签 DELETE /v2/{project_id}/desktops/{desktop_id}/tags/{key} 100次/分钟 使用标签过滤桌面 POST /v2/{project_id}/desktops/resource_instances/action 100次/分钟 桌面池 操作桌面池 POST /v2/{project_id}/desktop-pools/{pool_id}/action 100次/分钟 查询桌面池的脚本执行任务列表 GET /v2/{project_id}/desktop-pools/script-execution-tasks/detail 200次/分钟 查询桌面池列表 GET /v2/{project_id}/desktop-pools 200次/分钟 查询桌面池授权的用户、用户组 GET /v2/{project_id}/desktop-pools/{pool_id}/users 200次/分钟 查询桌面池下的桌面信息 GET /v2/{project_id}/desktop-pools/{pool_id}/desktops 200次/分钟 查询桌面池详情 GET /v2/{project_id}/desktop-pools/{pool_id} 200次/分钟 创建桌面池 POST /v2/{project_id}/desktop-pools 100次/分钟 扩容桌面池 POST /v2/{project_id}/desktop-pools/{pool_id}/expand 100次/分钟 删除桌面池 DELETE /v2/{project_id}/desktop-pools/{pool_id} 100次/分钟 修改桌面池属性 PUT /v2/{project_id}/desktop-pools/{pool_id} 100次/分钟 桌面池变更规格 POST /v2/{project_id}/desktop-pools/{pool_id}/resize 100次/分钟 桌面池发送消息通知 POST /v2/{project_id}/desktop-pools/{pool_id}/notifications 100次/分钟 桌面池批量扩容磁盘 POST /v2/{project_id}/desktop-pools/{pool_id}/volumes/batch-expand 100次/分钟 桌面池批量删除磁盘 POST /v2/{project_id}/desktop-pools/{pool_id}/volumes/batch-delete 100次/分钟 桌面池批量添加磁盘 POST /v2/{project_id}/desktop-pools/{pool_id}/volumes/batch-add 100次/分钟 桌面池批量执行脚本 POST /v2/{project_id}/desktop-pools/{pool_id}/script-executions 100次/分钟 桌面池授权用户、用户组 POST /v2/{project_id}/desktop-pools/{pool_id}/users 100次/分钟 桌面池重建系统盘 POST /v2/{project_id}/desktop-pools/{pool_id}/rebuild 100次/分钟 桌面名称策略 创建桌面名称策略 POST /v2/{project_id}/desktop-name-policies 100次/分钟 更新桌面名称策略 PUT /v2/{project_id}/desktop-name-policies/{policy_id} 100次/分钟 获取桌面名称策略 GET /v2/{project_id}/desktop-name-policies 200次/分钟 批量删除桌面名称策略 POST /v2/{project_id}/desktop-name-policies/batch-delete 100次/分钟 租户配置 查询辅助认证配置 PUT /v2/{project_id}/auth-config/method-config 200次/分钟 查询认证登录方式 GET /v2/{project_id}/auth-config/method-config 200次/分钟 查询租户的NAT映射配置项 GET /v2/{project_id}/nat-mapping-configs 200次/分钟 查询租户个性配置列表 GET /v2/{project_id}/tenant-configs 200次/分钟 查询租户功能状态 GET /v1/{project_id}/app-center/profiles 200次/分钟 更新辅助认证策略配置 PUT /v2/{project_id}/assist-auth-config/method-config 100次/分钟 更新认证策略配置 PUT /v2/{project_id}/auth-config/method-config 100次/分钟 获取云办公服务接入地址备份配置 GET /v2/{project_id}/access-config/address-backup 200次/分钟 启禁用租户功能 PATCH /v1/{project_id}/app-center/profiles 100次/分钟 修改云办公服务接入地址备份配置 POST /v2/{project_id}/access-config/address-backup 100次/分钟 修改租户的NAT映射配置项 PUT /v2/{project_id}/nat-mapping-configs 100次/分钟 修改租户个性配置 PUT /v2/{project_id}/tenant-configs 100次/分钟 查询协同桌面默认用户配置 GET /v2/{project_id}/share-space/configuration 200次/分钟 设置协同桌面默认用户配置 PUT /v2/{project_id}/share-space/configuration 100次/分钟 组织单元 查询OU下用户信息 GET /v2/{project_id}/ou-users 200次/分钟 查询AD里的OU列表 GET /v2/{project_id}/ad-ous 200次/分钟 查询OU信息 GET /v2/{project_id}/ous 200次/分钟 更新OU信息 PUT /v2/{project_id}/ous/{ou_id} 100次/分钟 删除OU信息 DELETE /v2/{project_id}/ous/{ou_id} 100次/分钟 新增OU信息 POST /v2/{project_id}/ous 100次/分钟 表2 云应用API流控限制 接口分类 接口名称 接口URI 用户流量限制 产品套餐管理 查询云应用套餐 GET /v1/{project_id}/product 200次/分钟 查询会话套餐列表 GET /v1/{project_id}/session-type 200次/分钟 策略管理 查询策略组列表 GET /v1/{project_id}/policy-groups 200次/分钟 新增策略组 POST /v1/{project_id}/policy-groups 100次/分钟 删除策略组 DELETE /v1/{project_id}/policy-groups/{policy_group_id} 100次/分钟 修改策略组 PATCH /v1/{project_id}/policy-groups/{policy_group_id} 100次/分钟 查询策略组详情 GET /v1/{project_id}/policy-groups/{policy_group_id} 200次/分钟 查询策略组中的策略项 GET /v1/{project_id}/policy-groups/{policy_group_id}/policy 200次/分钟 查询策略组应用对象 GET /v1/{project_id}/policy-groups/{policy_group_id}/target 200次/分钟 查询初始策略项 GET /v1/{project_id}/policy-groups/actions/list-original-policy 200次/分钟 查询策略组详情列表 GET /v1/{project_id}/policy-groups/show/detail 200次/分钟 查询策略模板列表 GET /v1/{project_id}/policy-templates 200次/分钟 新增策略模板 POST /v1/{project_id}/policy-templates 100次/分钟 删除策略模板 DELETE /v1/{project_id}/policy-templates/{policy_template_id} 100次/分钟 修改策略模板 PATCH /v1/{project_id}/policy-templates/{policy_template_id} 100次/分钟 磁盘管理 查询可用磁盘类型 GET /v1/{project_id}/volume-type 200次/分钟 订单 创建订单 POST /v1/{project_id}/bundles/subscribe/order 100次/分钟 存储管理 查询WKS存储 GET /v1/{project_id}/persistent-storages 200次/分钟 创建WKS存储 POST /v1/{project_id}/persistent-storages 100次/分钟 删除WKS存储 DELETE /v1/{project_id}/persistent-storages/{storage_id} 100次/分钟 创建个人存储目录 POST /v1/{project_id}/persistent-storages/{storage_id}/actions/assign-folder 100次/分钟 修改共享目录成员 POST /v1/{project_id}/persistent-storages/{storage_id}/actions/assign-share-folder 100次/分钟 创建共享存储目录 POST /v1/{project_id}/persistent-storages/{storage_id}/actions/create-share-folder 100次/分钟 删除共享目录 POST /v1/{project_id}/persistent-storages/{storage_id}/actions/delete-storage-claim 100次/分钟 删除个人存储目录 POST /v1/{project_id}/persistent-storages/{storage_id}/actions/delete-user-attachment 100次/分钟 批量删除WKS存储 POST /v1/{project_id}/persistent-storages/actions/batch-delete 100次/分钟 查询个人存储目录 GET /v1/{project_id}/persistent-storages/actions/list-attachments 200次/分钟 查询共享存储目录 GET /v1/{project_id}/persistent-storages/actions/list-share-folders 200次/分钟 新增或更新存储目录访问权限自定义策略 PUT /v1/{project_id}/storages-policy/actions/create-statements 100次/分钟 查询存储目录访问权限策略 GET /v1/{project_id}/storages-policy/actions/list-statements 200次/分钟 查询SFS3.0存储 GET /v1/persistent-storages/actions/list-sfs-storages 200次/分钟 定时任务 查询定时任务列表 GET /v1/{project_id}/schedule-task 200次/分钟 新增定时任务 POST /v1/{project_id}/schedule-task 100次/分钟 查询定时任务执行子任务列表 GET /v1/{project_id}/schedule-task/{execute_history_id}/execute-detail 200次/分钟 删除任务 DELETE /v1/{project_id}/schedule-task/{task_id} 100次/分钟 查询指定定时任务详情 GET /v1/{project_id}/schedule-task/{task_id} 200次/分钟 修改定时任务 PATCH /v1/{project_id}/schedule-task/{task_id} 100次/分钟 查询定时任务执行列表 GET /v1/{project_id}/schedule-task/{task_id}/execute-history 200次/分钟 批量删除定时任务 POST /v1/{project_id}/schedule-task/actions/batch-delete 100次/分钟 未来执行的具体时间列表 POST /v1/{project_id}/schedule-task/future-executions 200次/分钟 服务器管理 查询服务器列表 GET /v1/{project_id}/app-servers 200次/分钟 修改服务器 PATCH /v1/{project_id}/app-servers/{server_id} 100次/分钟 删除服务器 DELETE /v1/{project_id}/app-servers/{server_id} 100次/分钟 查询指定服务器 GET /v1/{project_id}/app-servers/{server_id} 200次/分钟 修改服务器的镜像 POST /v1/{project_id}/app-servers/{server_id}/actions/change-image 100次/分钟 重装服务器 POST /v1/{project_id}/app-servers/{server_id}/actions/reinstall 100次/分钟 获取VNC远程登录地址 GET /v1/{project_id}/app-servers/{server_id}/actions/vnc 200次/分钟 查询租户的所有HDA最新版本 GET /v1/{project_id}/app-servers/access-agent/actions/show-latest-version 200次/分钟 批量升级服务器HDA版本 PATCH /v1/{project_id}/app-servers/access-agent/actions/upgrade 100次/分钟 查询租户的HDA最新版本 GET /v1/{project_id}/app-servers/access-agent/latest-version 200次/分钟 查询服务器的HDA相关信息 GET /v1/{project_id}/app-servers/access-agent/list 200次/分钟 查询服务器的HDA升级跟踪记录 GET /v1/{project_id}/app-servers/access-agent/upgrade-record 200次/分钟 批量修改服务器的镜像 POST /v1/{project_id}/app-servers/actions/batch-change-image 100次/分钟 批量删除服务器 POST /v1/{project_id}/app-servers/actions/batch-delete 100次/分钟 标记服务器维护状态 PATCH /v1/{project_id}/app-servers/actions/batch-maint 100次/分钟 重启服务器 PATCH /v1/{project_id}/app-servers/actions/batch-reboot 100次/分钟 批量重装服务器 POST /v1/{project_id}/app-servers/actions/batch-reinstall 100次/分钟 批量服务器重新加域 PATCH /v1/{project_id}/app-servers/actions/batch-rejoin-domain 100次/分钟 启动服务器 PATCH /v1/{project_id}/app-servers/actions/batch-start 100次/分钟 关闭服务器 PATCH /v1/{project_id}/app-servers/actions/batch-stop 100次/分钟 批量更新服务器虚拟会话IP配置 PATCH /v1/{project_id}/app-servers/actions/batch-update-tsvi 100次/分钟 创建云服务器 POST /v1/{project_id}/app-servers/actions/create 100次/分钟 迁移云办公主机下面的服务器到目标云办公主机 PATCH /v1/{project_id}/app-servers/hosts/batch-migrate 100次/分钟 查询云应用服务器监控信息 GET /v1/{project_id}/app-servers/metric-data/{server_id} 200次/分钟 查询指定时间范围指定指标的指定粒度的监控数据 GET /v1/{project_id}/app-servers/server-metric-data/{server_id} 200次/分钟 服务器组标签管理 查询服务器组的标签 GET /v1/{project_id}/server-group/{server_group_id}/tags 200次/分钟 添加服务器组标签 POST /v1/{project_id}/server-group/{server_group_id}/tags/create 100次/分钟 删除服务器组标签 DELETE /v1/{project_id}/server-group/{server_group_id}/tags/delete 100次/分钟 查询租户在所有服务器组上的标签 GET /v1/{project_id}/server-group/tags 200次/分钟 批量添加服务器组标签 POST /v1/{project_id}/server-group/tags/batch-create 100次/分钟 批量删除服务器组标签 DELETE /v1/{project_id}/server-group/tags/batch-delete 100次/分钟 服务器组管理 删除弹性伸缩策略 DELETE /v1/{project_id}/scaling-policy 100次/分钟 查询服务器组弹性伸缩策略 GET /v1/{project_id}/scaling-policy 200次/分钟 新增次/修改弹性伸缩策略 PUT /v1/{project_id}/scaling-policy 100次/分钟 查询服务器组列表 GET /v1/{project_id}/app-server-groups 200次/分钟 创建服务器组 POST /v1/{project_id}/app-server-groups 100次/分钟 删除服务器组 DELETE /v1/{project_id}/app-server-groups/{server_group_id} 100次/分钟 修改服务器组 PATCH /v1/{project_id}/app-server-groups/{server_group_id} 100次/分钟 查询指定服务器组 GET /v1/{project_id}/app-server-groups/{server_group_id} 200次/分钟 查询指定服务器组内服务器状态 GET /v1/{project_id}/app-server-groups/{server_group_id}/state 200次/分钟 查询租户服务器组基础信息列表 GET /v1/{project_id}/app-server-groups/actions/list 200次/分钟 指定租户服务器组限制查询 GET /v1/{project_id}/app-server-groups/resources/restrict 100次/分钟 镜像管理 查询镜像实例列表 GET /v1/{project_id}/image-servers 200次/分钟 创建镜像实例 POST /v1/{project_id}/image-servers 100次/分钟 修改镜像实例 PATCH /v1/{project_id}/image-servers/{server_id} 100次/分钟 查询指定镜像实例 GET /v1/{project_id}/image-servers/{server_id} 200次/分钟 分发软件信息至镜像实例 POST /v1/{project_id}/image-servers/{server_id}/actions/attach-app 100次/分钟 查询最近一次分发软件信息列表 GET /v1/{project_id}/image-servers/{server_id}/actions/latest-attached-app 200次/分钟 构建云应用镜像 POST /v1/{project_id}/image-servers/{server_id}/actions/recreate-image 100次/分钟 批量删除镜像实例 PATCH /v1/{project_id}/image-servers/actions/batch-delete 100次/分钟 可用区管理 查询可用分区列表 GET /v1/{project_id}/availability-zone 200次/分钟 查询可用分区列表（按站点分类） GET /v1/{project_id}/availability-zone/summary 200次/分钟 任务管理 子任务查询 GET /v1/{project_id}/app-server-sub-jobs 200次/分钟 批量删除子任务 POST /v1/{project_id}/app-server-sub-jobs/actions/batch-delete 100次/分钟 子任务数量查询 GET /v1/{project_id}/app-server-sub-jobs/actions/count 200次/分钟 查询租户的镜像任务列表 GET /v1/{project_id}/image-server-jobs 200次/分钟 查询镜像任务详情 GET /v1/{project_id}/image-server-jobs/{job_id} 200次/分钟 镜像子任务查询 GET /v1/{project_id}/image-server-sub-jobs 200次/分钟 批量删除镜像子任务 PATCH /v1/{project_id}/image-server-sub-jobs/actions/batch-delete 100次/分钟 查询任务的执行状态 GET /v1/{project_id}/job/{job_id} 200次/分钟 查询任务的执行状态详情 GET /v2/{project_id}/job/{job_id} 200次/分钟 配额管理 配额校验 GET /v1/{project_id}/check/quota 200次/分钟 使用记录 查询应用使用记录 POST /v1/{project_id}/session/app-connection 200次/分钟 查询用户会话列表 GET /v1/{project_id}/session/list-sessions 200次/分钟 用户会话注销 POST /v1/{project_id}/session/logoff 100次/分钟 查询用户登录记录 POST /v1/{project_id}/session/user-connection 200次/分钟 根据用户名查询当前会话 GET /v1/{project_id}/session/user-session-info 200次/分钟 应用管理 查询已发布应用 GET /v1/{project_id}/app-groups/{app_group_id}/apps 200次/分钟 发布应用 POST /v1/{project_id}/app-groups/{app_group_id}/apps 100次/5分钟 修改应用信息 PATCH /v1/{project_id}/app-groups/{app_group_id}/apps/{app_id} 100次/分钟 查询应用详细信息 GET /v1/{project_id}/app-groups/{app_group_id}/apps/{app_id} 100次/分钟 修改自定义应用图标 POST /v1/{project_id}/app-groups/{app_group_id}/apps/{app_id}/icon 100次/分钟 删除自定义应用图标 DELETE /v1/{project_id}/app-groups/{app_group_id}/apps/{app_id}/icon 100次/分钟 批量禁用应用 POST /v1/{project_id}/app-groups/{app_group_id}/apps/actions/disable 100次/分钟 批量启用应用 POST /v1/{project_id}/app-groups/{app_group_id}/apps/actions/enable 100次/分钟 批量取消应用发布 POST /v1/{project_id}/app-groups/{app_group_id}/apps/batch-unpublish 100次/分钟 可发布应用列表 GET /v1/{project_id}/app-groups/{app_group_id}/publishable-app 200次/分钟 应用仓库管理 获取上传至OBS桶的临时ak次/sk POST /v1/{project_id}/app-warehouse/action/authorize 100次/分钟 批量删除应用仓库中的指定应用 POST /v1/{project_id}/app-warehouse/actions/batch-delete 100次/分钟 查询租户应用仓库中的应用列表 GET /v1/{project_id}/app-warehouse/apps 200次/分钟 在应用仓库中新增应用 POST /v1/{project_id}/app-warehouse/apps 100次/分钟 修改应用仓库中的指定应用信息 PATCH /v1/{project_id}/app-warehouse/apps/{id} 100次/分钟 删除应用仓库中的指定应用 DELETE /v1/{project_id}/app-warehouse/apps/{id} 100次/分钟 在应用仓库中上传图标文件 POST /v1/{project_id}/app-warehouse/apps/icon 100次/分钟 添加桶或者桶授权 POST /v1/{project_id}/app-warehouse/bucket-and-acl/create 100次/分钟 应用授权管理 移除应用组授权 POST /v1/{project_id}/app-groups/actions/batch-delete-authorization 100次/5分钟 查询应用组授权记录 GET /v1/{project_id}/app-groups/actions/list-authorizations 200次/分钟 增加应用组授权 POST /v1/{project_id}/app-groups/authorizations 100次/5分钟 应用组管理 查询应用组 GET /v1/{project_id}/app-groups 200次/分钟 创建应用组 POST /v1/{project_id}/app-groups 100次/分钟 修改应用组 PATCH /v1/{project_id}/app-groups/{app_group_id} 100次/分钟 应用组删除 DELETE /v1/{project_id}/app-groups/{app_group_id} 100次/分钟 查询应用组详情 GET /v1/{project_id}/app-groups/{app_group_id} 200次/分钟 解除服务组关联的所有应用组 POST /v1/{project_id}/app-groups/actions/disassociate-app-group 100次/分钟 批量删除应用组 POST /v1/{project_id}/app-groups/batch-delete 100次/分钟 查询应用组授权邮件发送记录 GET /v1/{project_id}/mails 200次/分钟 重发应用组授权邮件（根据授权邮件记录） POST /v1/{project_id}/mails/actions/send 100次/分钟 重发应用组授权邮件（根据授权记录） POST /v1/{project_id}/mails/actions/send-by-authorization 100次/分钟 租户配置 查询企业系统配置 POST /v1/{project_id}/bundles/batch-query-config-info 200次/分钟 租户服务激活、初始化 POST /v1/{project_id}/tenant/action/active 100次/分钟 查询租户信息 GET /v1/{project_id}/tenant/profile 200次/分钟 父主题： 使用前必读

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 tags Array of TmsTag objects 标签列表。 sys_tags Array of TmsTag objects 仅op_service权限才可以获取此字段，非op_service场景不能返回此字段，目前只包含一个resource_tag结构体。 说明： key：_sys_enterprise_project_id。 value：企业项目id，0表示默认企业项目。 表4 TmsTag 参数 参数类型 描述 key String 键。最大长度128个unicode字符。 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格，以及以下字符： _ . : = + - @。 两头不能有空白字符。 value String 值。每个值最大长度255个unicode字符。 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格，以及以下字符： _ . : = + - @。 状态码：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" : "62f48b59-0ebb-4b1e-ad35-f64948a0591b", "task_name" : "定时开机任务", "last_status" : "WAITING", "task_type" : "RESTART_SERVER", "task_cron" : "*/10 * * * * ?", "next_execution_time" : "2022-12-23 09:00:00", "schedule_task_policy" : { "enforcement_enable" : false }, "scheduled_type" : "day", "day_interval" : 1, "week_list" : "1,2,7", "month_list" : "1,3,12", "date_list" : "1,2,28,L", "time_zone" : "Asia/Shanghai", "scheduled_date" : "2022-12-23", "scheduled_time" : "09:00:00", "expire_time" : "2022-03-07T10:40:43.858Z", "description" : "用于开关机。", "is_enable" : false, "create_time" : "2022-03-07T10:40:43.858Z", "update_time" : "2024-12-25T12:37:28.715Z" }

请求示例 { "scheduled_type" : "day", "day_interval" : 1, "week_list" : "1,2,7", "month_list" : "1,3,12", "date_list" : "1,2,28,L", "time_zone" : "Asia/Shanghai", "scheduled_date" : "2022-12-23", "scheduled_time" : "09:00:00", "expire_time" : "2022-03-07T10:40:43.858Z", "task_name" : "定时开机任务", "task_type" : "RESTART_SERVER", "schedule_task_policy" : { "enforcement_enable" : false }, "description" : "用于开关机。", "target_infos" : [ { "target_type" : "SERVER", "target_id" : [ "3f791197-d166-4c8e-81e4-38c40ffc1989" ], "target_name" : "测试桌面" } ] }

响应参数 状态码：200 表6 响应Body参数 参数 参数类型 描述 id String 定时任务主键id。 task_name String 任务名称。 last_status String job状态： WAITING - 等待 RUNNING - 运行中 SUC CES S - 完成 FAILED - 失败 task_type String 定时任务类型： RESTART_SERVER - 定时重启服务器 START_SERVER - 定时开机 STOP_SERVER - 定时关机 REINSTALL_OS - 定时重装操作系统 task_cron String 定时任务表达式。 next_execution_time String 下一次执行时间。 schedule_task_policy ScheduleTaskPolicy object 定时任务策略。 scheduled_type String 执行周期： FIXED_TIME - 指定时间 DAY - 按天 WEEK - 按周 MONTH - 按月 day_interval Integer 周期按天时：按x天间隔执行。 week_list String 周期按周时：取值1~7，英文逗号分隔，如1,2,7。 month_list String 周期按月时：取值1~12，英文逗号分隔，如1,3,12。 date_list String 周期按月时：取值1~31及L(代表当月最后一天)，英文逗号分隔，如1,2,28,L。 time_zone String 时区。 scheduled_date String 周期指定时间时：表示指定的日期，格式为yyyy-MM-dd。 scheduled_time String 指定的执行时间点，格式为HH:mm:ss。 expire_time String 到期时间。 description String 任务描述。 is_enable Boolean 是否是开启状态。 create_time String 创建时间。 update_time String 更新时间。 表7 ScheduleTaskPolicy 参数 参数类型 描述 enforcement_enable Boolean 当存在会话的时候，是否强制执行，强制执行开关。取值为： false：表示关闭。 true：表示开启。 状态码：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 错误描述。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 scheduled_type 是 String 执行周期： FIXED_TIME - 指定时间 DAY - 按天 WEEK - 按周 MONTH - 按月 day_interval 否 Integer 周期按天时：按x天间隔执行。 week_list 否 String 周期按周时：取值1~7，英文逗号分隔，如1,2,7。 month_list 否 String 周期按月时：取值1~12，英文逗号分隔，如1,3,12。 date_list 否 String 周期按月时：取值1~31及L(代表当月最后一天)，英文逗号分隔，如1,2,28,L。 time_zone 否 String 时区。 scheduled_date 否 String 周期指定时间时：表示指定的日期，格式为yyyy-MM-dd。 scheduled_time 否 String 指定的执行时间点，格式为HH:mm:ss。 expire_time 否 String 到期时间。 task_name 是 String 任务名称，名称需满足如下规则: 由中文，英文大小写，数字，_-组成，不能有空格。 长度范围1~64个字符。 task_type 是 String 定时任务类型： RESTART_SERVER - 定时重启服务器 START_SERVER - 定时开机 STOP_SERVER - 定时关机 REINSTALL_OS - 定时重装操作系统 schedule_task_policy 否 ScheduleTaskPolicy object 定时任务策略。 description 否 String 任务描述。 target_infos 否 Array of TargetInfo objects 定时任务对象列表。 表4 ScheduleTaskPolicy 参数 是否必选 参数类型 描述 enforcement_enable 否 Boolean 当存在会话的时候，是否强制执行，强制执行开关。取值为： false：表示关闭。 true：表示开启。 表5 TargetInfo 参数 是否必选 参数类型 描述 target_type 是 String 定时任务对象类型： SERVER - 服务器 SERVER_GROUP - 服务器组 target_id 是 String 对象id。

URI GET /v2/{project_id}/alarms 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 level 否 Integer 告警级别 | 1 - 紧急 2 - 重要 3 - 次要 4 - 提示。 offset 否 Integer 分页偏移量。 limit 否 Integer 分页大小，默认100。

响应示例 状态码：200 响应成功。 { "alarm_histories" : [ { "record_id" : "string", "alarm_id" : "al1603131199286dzxpqK3Ez", "name" : "alarm-test01", "status" : "alarm", "type" : "EVENT.SYS", "level" : 1, "begin_time" : 231025, "metric" : { "namespace" : "SYS.IES", "metric_name" : "cpu_util", "dimensions" : [ { "name" : "instance_id", "value" : "4270ff17-aba3-4138-89fa-820594c39755" } ] }, "condition" : { "period" : 1, "filter" : "average", "comparison_operator" : "", "value" : 0, "unit" : "percent", "count" : 10, "suppress_duration" : 300 }, "additional_info" : { "resource_id" : "22d98f6c-16d2-4c2d-b424-50e79d82838f", "resource_name" : "E CS -Test01", "event_id" : "ev16031292300990kKN8p17J" }, "data_points" : [ { "time" : "string", "value" : 7.019 } ] } ], "count" : 0 }

响应示例 状态码：200 查询策略组信息的成功响应。 { "policy_group" : { "id" : "574141368704696320", "name" : "updatePolicy_20230601144442564522", "priority" : 1, "description" : "策略组description01271237542。", "targets" : [ { "target_id" : "1010101012", "target_name" : "user0012", "target_type" : "USER" } ], "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" : false, "rendering_acceleration_options" : { "video_acceleration_enhancement_enable" : true, "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" : "DISABLED", "sbc_automatic_disconnection_options" : { "disconnection_waiting_time" : 10, "sbc_auto_logout" : false, "auto_logout_options" : { "sbc_logout_waiting_time" : 1440 } } } }, "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" : "" } } }, "create_time" : "2023-06-01T14:45:21.566Z", "update_time" : "2023-06-01T14:45:21.566Z" } }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 policy_group PolicyGroup object 策略组。 表4 PolicyGroup 参数 参数类型 描述 id String 策略组的唯一标识。 name String 策略组名称。 priority Integer 优先级。 description String 服务器组描述。 targets Array of Target objects 应用对象列表。 policies Policies object 策略。 create_time String 策略组创建时间。 update_time String 策略组更新时间。 表5 Target 参数 参数类型 描述 target_id String 对象ID。 target_name String 对象名称。 target_type String 对象类型。 USER：表示用户。 USERGROUP：表示用户组。 APPGROUP：应用组。 OU：组织单元。 ALL：表示所有。 target_id：为用户ID。 target_name：为用户name。 target_id：为用户组ID。 target_name：为用户组name。 target_id：应用组id。 target_name：应用组名称。 target_id：OUID。 target_name：OU名称。 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 自定义策略。 cloud_storage cloud_storage object 云存储 配置。 user_profile user_profile 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 是否开启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 虚拟通道带宽控制的选项。 表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内容。 rail_transparent_config RailTransparentConfig object 应用镜像策略设置项。 表72 RailTransparentConfig 参数 参数类型 描述 select_policy Integer 策略选值原则。 transparent_list_custom String 配置项内容。 表73 cloud_storage 参数 参数类型 描述 cloud_storage_enable Boolean 云存储配置开关： false: 表示关闭 true: 表示开启 options CloudStorageOptions object 云存储配置。 表74 CloudStorageOptions 参数 参数类型 描述 cloud_storage_rule String 配置项内容。 表75 user_profile 参数 参数类型 描述 user_profile_enable Boolean 配置文件漫游技术配置开关： false: 表示关闭 true: 表示开启 options UpmOptions object 配置文件漫游技术配置。 表76 UpmOptions 参数 参数类型 描述 user_profile_rule String 配置项内容。 redir_exclude_common_folders String 排除常用文件夹。 redir_exclude_copy0s String 禁止自定义文件夹/copy base = 0,copy back = 0。 redir_exclude_copy1s String 禁止自定义文件夹/copy base = 0,copy back = 1。 redir_exclude_copy2s String 禁止自定义文件夹/copy base = 1,copy back = 0。 redir_exclude_copy3s String 禁止自定义文件夹/copy base = 1,copy back = 1。 redir_exclude_includes String 允许自定义文件夹 状态码：400 表77 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：401 表78 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：403 表79 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：404 表80 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：405 表81 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：500 表82 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：503 表83 响应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 成功响应。 { "azs" : { "CENTER" : [ { "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 } ], "IES" : [ { "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 } ] }, "default_type" : "CENTER", "support_type" : [ "CENTER" ] }

响应示例 状态码：200 成功响应。 { "id" : "222xx-xxxsdfsadf-xxx", "name" : "测试服务器", "machine_name" : "testy-xxxxx01-china.test.com", "description" : "测试服务器。", "server_group_id" : "11111xx-xxxsdfsadf-xxxxxxx", "flavor" : { "id" : "asdfjkl-2131f-xxx-123123", "links" : [ { "rel" : "", "hrel" : "" } ] }, "status" : "UNREGISTER", "create_time" : "2022-03-07T10:40:43.858Z", "update_time" : "2022-03-07T10:40:43.858Z", "image_id" : "xxx-xxx-xxx-xx", "availability_zone" : "", "domain" : "china.test.com", "ou_name" : "wksappusers", "sid" : "cc5279d6-xxxx-xx-xxx-b87a97cf02af", "instance_id" : "cc5279d6-xxxx-xx-xxx-b87a97cf02af", "os_version" : "", "os_type" : "Windows", "order_id" : "sdf2312-dfxxxx-sdfasdf-xxss", "maintain_status" : false, "scaling_auto_create" : false, "job_id" : "437415807337627690", "job_type" : "CREATE_SERVER", "job_status" : "WAITING", "job_time" : "2022-03-07T10:40:43.858Z", "resource_pool_id" : "cc5279d6-xxxx-xx-xxx-b87a97cf02af", "resource_pool_type" : "public", "host_id" : "cc5279d6-xxxx-xx-xxx-b87a97cf02af", "server_group_name" : "APS测试服务器组", "product_info" : { "product_id" : "workspace.appstream.general.2xlarge.4", "flavor_id" : "c3.large.4", "type" : "BASE", "architecture" : "x86", "cpu" : 2, "cpu_desc" : "云应用通用型|4核|8GB内存。", "memory" : 4096, "is_gpu" : false, "system_disk_type" : "SAS", "system_disk_size" : 80, "gpu_desc" : "GPU图形加速", "descriptions" : "GPU图形加速DG4型|32核128G内存32G显存|P02", "charge_mode" : 1, "contain_data_disk" : false, "resource_type" : "hws.resource.type.xxxx.vm", "cloud_service_type" : "hws.service.type.xxxxx", "volume_product_type" : "workspace", "sessions" : 2, "status" : "string", "cond_operation_az" : "cn-north-5a(normal),cn-north-5b(abandon),cn-north-5c(sellout)", "sub_product_list" : [ "xxx", "xxxx" ], "domain_ids" : [ "xxx", "xxxx" ], "package_type" : "general", "expire_time" : "2022-03-07T10:40:43Z", "support_gpu_type" : "A40" }, "metadata" : { "charging_mode" : 0 }, "session_count" : 10, "vm_status" : "BUILD", "task_status" : "scheduling", "freeze" : [ { "effect" : 1, "scene" : "ARREAR" } ], "host_address" : [ { "addr" : "127.*.*.1", "version" : 4, "OS-EXT-IPS-MAC:mac_addr" : "C8-XX-XX-XX-XX-57", "OS-EXT-IPS:type" : "fixed", "OS-EXT-IPS:port_id" : "4b5fe243-2f5f-4c68-9eb2-8af3a5366666", "vpc_id" : "3bb2b656-0b79-4975-b870-a407f19038bb", "subnet_id" : "0785eeba-bfbb-4da3-94f9-d311c792e875", "tenant_type" : "tenant" } ], "enterprise_project_id" : "0", "tags" : [ { "key" : "demo01", "value" : "01" } ], "addresses" : { "additionalProp1" : [ { "addr" : "127.*.*.1", "version" : 4, "OS-EXT-IPS-MAC:mac_addr" : "C8-XX-XX-XX-XX-57", "OS-EXT-IPS:type" : "fixed", "OS-EXT-IPS:port_id" : "4b5fe243-2f5f-4c68-9eb2-8af3a5366666" } ], "additionalProp2" : [ { "addr" : "127.*.*.1", "version" : 4, "OS-EXT-IPS-MAC:mac_addr" : "C8-XX-XX-XX-XX-57", "OS-EXT-IPS:type" : "fixed", "OS-EXT-IPS:port_id" : "4b5fe243-2f5f-4c68-9eb2-8af3a5366666" } ], "additionalProp3" : [ { "addr" : "127.*.*.1", "version" : 4, "OS-EXT-IPS-MAC:mac_addr" : "C8-XX-XX-XX-XX-57", "OS-EXT-IPS:type" : "fixed", "OS-EXT-IPS:port_id" : "4b5fe243-2f5f-4c68-9eb2-8af3a5366666" } ] }, "root_volume" : { "encrypt_flag" : 0, "kms_key" : "HJSADFHJKQWERVSADFSADF...", "key_alias" : "ADDJFKLJEWKLRJWKR4...", "type" : "SSD", "size" : 10, "kms_grant_id" : "adf123-123fgasdfxxxx-123sadasdf", "device" : "\tmp\test", "id" : "sdfasdf123-123asdfxxxxxxx-213adf", "volume_id" : "3213-df1234adsfxxxxxx-asdfsadf", "cluster_id" : "c950ee97-587c-4f24-8a74-3367e3da570f" }, "data_volumes" : [ { "encrypt_flag" : 0, "kms_key" : "HJSADFHJKQWERVSADFSADF...", "key_alias" : "ADDJFKLJEWKLRJWKR4...", "type" : "SSD", "size" : 10, "kms_grant_id" : "adf123-123fgasdfxxxx-123sadasdf", "device" : "\tmp\test", "id" : "sdfasdf123-123asdfxxxxxxx-213adf", "volume_id" : "3213-df1234adsfxxxxxx-asdfsadf", "cluster_id" : "c950ee97-587c-4f24-8a74-3367e3da570f" } ], "security_groups" : [ { "id" : "30789daf-e1c7-40ae-a3bc-11c84a8e5bb8", "name" : "" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 ids 是 Array of strings 应用ID,最多同时操作5个。 is_pre_boot 是 Boolean 是否设置应用预启动。

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

响应示例 状态码：200 成功响应。 { "count" : 1, "items" : [ { "id" : "94b8e5c7-008f-40d7-b59a-084de3638286", "name" : "user-file-persistent", "project_config_id" : "111ed8f4-2223-4b04-a4d1-12345a2f30d8", "create_time" : "2023-06-08T07:08:09.412Z", "user_claim_count" : 0, "share_claim_count" : 0 } ] }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数。 items Array of CloudStorage objects 存储列表。 表5 CloudStorage 参数 参数类型 描述 id String 云存储id。 name String 云存储名称。 project_config_id String 云存储id。 create_time String 创建时间。 user_claim_count Integer 个人目录声明数量。 share_claim_count Integer 共享目录声明数量。 状态码：400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：405 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：503 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

URI GET /v1/{project_id}/cloud-storages 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询的偏移量。 limit 否 Integer 单次查询的大小[1-100]。 storage_id 否 String 云存储id。 name 否 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参数 参数 是否必选 参数类型 描述 project_config_ids 是 Array of strings project_config_id,数量区间 [1, 50]。

操作步骤 登录管理控制台。 在左侧导航中单击“定时任务”页面。 进入“定时任务”页面。 单击定时任务页面右上角“创建定时任务”。 弹出“创建定时任务”界面。 配置定时任务信息。 任务类型：选择“重启”。 强制执行重启任务：您设置好定时重启任务后，当到达定时时间点时，当前桌面有用户连接，为保证用户体验，系统不会执行重启，将自动顺延到下一个定时时间点，如果勾选后，系统到达定时时间点后，将会强制执行重启。 定时任务名称：用户自定义。 执行周期：支持以下几种周期，根据用户需求自行选择。 指定时间：可精确到某年某月某日某时某分某秒。 按天：可设置具体时间、间隔天数、过期时间。 按周：可设置具体日期、时间、过期时间。 按月：可设置具体月份、具体日期、时间、过期时间。 时区：系统默认选择当地时区。 描述（可选）：根据实际情况自定义配置。 选择是否通知用户。 通知：设置“早于定时任务”时间，范围为1~10080分钟，并根据所需输入通知消息内容，仅支持文本消息，范围为1~400个字符。 不通知：执行6。 仅Windows系统支持“通知消息”。 点击“下一步：选择对象”。 跳转至“选择应用对象”界面。 在“可选对象”的下拉框中选择所有桌面/桌面/桌面池/标签，并在下方列表中勾选需要应用的对象。 单击“立即创建”。

操作场景 如果用户对桌面池配置、应用使用有相同要求，管理员可以在云桌面管理控制台中购买了一台使用Windows操作系统镜像生成的桌面池桌面，并登录该桌面进行一系列的配置、软件安装，然后将该桌面转换成镜像，再通过桌面转换成的镜像批量购买分配给目标人员使用。可节约人员配置成本，达到即开即用效果。 待转镜像的桌面中，当前桌面用户目录（C:\Users\当前桌面用户名）下的文件（包括安装在此目录下的应用），无法带入镜像中，使用该镜像购买的桌面，配置及应用与待转镜像的桌面不一致，请以实际为准。

修订记录 发布日期 修订记录 2025-04-22 第六十三次正式发布。 新增： Workspace支持的CES事件说明 2025-01-06 第六十二次正式发布。 新增： 客户端中新增终端设备加域校验。 2024-12-25 第六十一次正式发布。 新增： 客户端中防截屏功能新增Mac客户端。 2024-09-05 第六十次正式发布。 新增： Workspace支持的CES基础监控指标。 2024-08-26 第五十九次正式发布。 新增： 开启/关闭终端与桌面绑定功能章节中新增接入时自动绑定。 2024-08-13 第五十八次正式发布。 修改： 准备软件中Windows镜像制作工具的版本号。 2024-07-30 第五十七次正式发布。 新增： 导入用户 修改： 创建用户章节中用户名规则。 2024-07-24 第五十六次正式发布。 新增： Workspace运维监控指标 2024-07-15 第五十五次正式发布。 新增： 制作UOS操作系统桌面私有镜像 制作麒麟操作系统桌面私有镜像 删除： 租户配置下的修改互联网接入端口章节。 2024-06-26 第五十四次正式发布。 管理桌面添加快照相关操作。 管理桌面池添加快照相关操作。 快照管理 2024-06-20 第五十三次正式发布。 新增：管理MFA 关闭多因素认证 2024-06-18 第五十二次正式发布。 新增： 界面总览支持查看云桌面时延分布。 2024-05-06 第五十一次正式发布。 新增： 云专线支持开启NAT映射 2024-04-01 第五十次正式发布。 新增： 配置云服务器章节中新增“关闭混合睡眠”。 2024-03-01 第四十九次正式发布。 新增： 包年/包月转按需 2024-02-27 第四十八次正式发布。 新增： 导出中心 2024-01-30 第四十七次正式发布。 新增： 分配用户 解绑用户 2023-12-30 第四十六次正式发布。 新增： 脚本管理 2023-12-11 第四十五次正式发布。 新增： 协同桌面 为用户订阅多人协同 桌面命名规则 2023-11-23 第四十四次正式发布。 修改： 更新：准备软件章节中Windows镜像制作工具链接地址。 2023-11-20 第四十三次正式发布。 修改： 更新：准备软件章节中Windows镜像制作工具链接地址。 2023-09-20 第四十二次正式发布。 新增：桌面池管理 重建系统盘中新增批量重建系统盘 2023-07-05 第四十一次正式发布。 修改： 更新准备软件章节中HW.SysAgent.Installer_64.msi 和HW.SysPrep.Installer_64.msi软件包获取地址 2023-07-03 第四十次正式发布。 新增： 第三方单点认证 桌面网络设置 2023-06-25 第三十九次正式发布。 新增： 订阅事件 2023-04-26 第三十八次正式发布。 新增： 上网管理 定时任务 用户组管理 桌面退订 Linux桌面转镜像 2023-03-25 第三十七次正式发布。 修改： 准备软件中更新“Workspace_HDP_WindowsDesktop_Installer_x.x.x.iso”工具获取路径。 2023-01-12 第三十六次正式发布。 修改： 配置云服务器中调整修改跃点数脚本的配置步骤。 2022-12-14 第三十五次正式发布。 修改： 准备软件中更新“Workspace_HDP_WindowsDesktop_Installer_x.x.x.iso”工具获取路径。 2022-12-12 第三十四次正式发布。 修改： 重建系统盘中增加变更系统盘操作。 2022-12-08 第三十三次正式发布。 新增： 终端与桌面绑定关系管理 2022-11-11 第三十二次正式发布。 修改： 桌面转镜像优化操作系统描述。 2022-11-03 第三十一次正式发布。 新增： 删除磁盘 接入策略管理 配置是否屏蔽退订/删除桌面的通知邮件 数据备份与恢复 修改： 优化界面总览状态描述。 优化配置AD域中主域控制器名称描述。 修改准备软件中Windows镜像制作工具的获取地址。 2022-09-27 第三十次正式发布。 修改： 通过ISO文件注册私有镜像中修改启动方式选择“BIOS”。 配置云服务器中增加禁止Cloudbase-Init重启配置项。 2022-09-19 第二十九次正式发布。 新增： 导出策略 导入策略 修改： 重建系统盘中增加Windows操作系统的桌面检查及修改磁盘状态的参考链接。 配置云服务器中增加修改操作系统SAN策略操作步骤。 2022-09-16 第二十八次正式发布。 修改： 修改剪切板重定向的策略描述，涉及如下章节： 创建策略 编辑策略 配置高级策略参数 2022-09-06 第二十七次正式发布。 新增： 取消服务 修改： 配置云桌面可访问企业内网优化访问企业内网的端口描述。 2022-09-05 第二十六次正式发布。 修改： 管理桌面新增解绑用户和再分配用户的操作描述。 重建系统盘中优化操作描述。 2022-09-02 第二十五次正式发布。 新增： 重建系统盘 按需转包年/包月 为包年/包月桌面续费 重新激活服务状态 修改： 配置云桌面可访问企业内网增加端口使用限制。 2022-08-30 第二十四次正式发布。 新增： 企业自有认证系统认证 修改： 修改管理桌面中修改桌面名称的命名规则。 优化华为云多因素认证服务（虚拟MFA认证）配置描述，并增加终端用户操作参考链接。 2022-08-08 第二十三次正式发布。 新增： 配置多因素认证 2022-07-22 第二十二次正式发布。 修改： 变更规格修改套餐间规格变更说明。 2022-07-15 第二十一次正式发布。 修改： 变更规格增加套餐间规格变更说明。 配置云桌面可访问互联网增加多种开通途径说明。 配置云桌面和Windows AD网络互通修改RPC动态端口。 2022-07-04 第二十次正式发布。 修改： 配置AD域增加多个子项目可对接同一个Windows AD的说明。 配置云桌面可访问互联网优化配置。 配置云桌面可访问企业内网增加VPN配置说明。 2022-06-24 第十九次正式发布。 修改： 扩容磁盘优化磁盘可扩容容量说明。 配置云服务器优化禁用防火墙的配置。 2022-06-09 第十八次正式发布。 修改： 优化创建用户用户名称规则。 2022-05-30 第十七次正式发布。 修改： 更新准备软件中Workspace_HDP_WindowsDesktop_Installer_x.x.x.iso工具的获取地址。 2022-05-25 第十六次正式发布。 新增： 变更规格 修改： 界面总览优化在线人数查询描述。 2022-05-20 第十五次正式发布。 新增： 私有镜像管理 修改： 桌面转镜像修改桌面状态要求。 2022-04-29 第十四次正式发布。 修改： 配置高级策略参数新增Linux根目录挂载策略和移动客户端重定向策略。 修改网络接入方式增加切换网络接入方式的详细操作指导。 2022-04-18 第十三次正式发布。 修改： 配置云桌面和Windows AD网络互通修改需放通的端口。 2022-04-12 第十二次正式发布。 修改： 配置AD域证书认证新增启用AD服务器的LDAPS和导出其根证书的操作引导链接。 2022-03-30 第十一次正式发布。 修改： 管理桌面新增导出桌面列表操作描述。 配置AD域新增配置AD域证书认证的引导描述。 配置云桌面可访问互联网优化操作描述。 新增： 桌面转镜像 OU管理 配置AD域证书认证 2022-03-26 第十次正式发布。 2022-02-28 第九次正式发布。 修改： 调整管理桌面中各任务的呈现形式，新增修改桌面名称操作描述。 新增： 扩容磁盘 2022-01-28 第八次正式发布。 修改： 配置高级策略参数中新增水印特殊字符说明。 2022-01-26 第七次正式发布。 修改： 优化修改业务子网中子网修改描述。 2022-01-24 第六次正式发布。 修改： 修改配置AD域中虚拟私有云用户指南链接。 2022-01-05 第五次正式发布。 修改： 优化新增磁盘内容。 2021-11-22 第四次正式发布。 修改： 优化操作流程描述。 2021-10-29 第三次正式发布。 修改： 优化权限管理描述。 修改云桌面客户端软件包下载地址。 2021-10-14 第二次正式发布。 删除“进入开发者模式”章节。 删除“管理私有镜像”章节。 修改登录方式描述。 2021-09-18 第一次正式发布。

操作步骤 登录管理控制台。 在左侧导航中单击“定时任务”。 进入“定时任务”页面。 单击定时任务页面右上角“创建定时任务”。 弹出“创建定时任务”界面。 配置定时任务信息。 任务类型：选择“关机”。 强制执行关机任务：您设置好定时关机任务后，当到达定时时间点时，当前桌面有用户连接，为保证用户体验，系统不会执行关机，将自动顺延到下一个定时时间点，如果勾选后，系统到达定时时间点后，将会强制执行关机。 定时任务名称：用户自定义。 执行周期：支持以下几种周期，根据用户需求自行选择。 指定时间：可精确到某年某月某日某时某分某秒。 按天：可设置具体时间、间隔天数、过期时间。 按周：可设置具体日期、时间、过期时间。 按月：可设置具体月份、具体日期、时间、过期时间。 时区：系统默认选择当地时区。 描述（可选）：根据实际情况自定义配置。 选择是否通知用户。 通知：设置“早于定时任务”时间，范围为1~10080分钟，并根据所需输入通知消息内容，仅支持文本消息，范围为1~400个字符。 不通知：执行6。 仅Windows系统支持“通知消息”。 点击“下一步：选择对象”。 跳转至“选择应用对象”界面。 在“可选对象”的下拉框中选择所有桌面/桌面/桌面池/标签，并在下方列表中勾选需要应用的对象。 单击“立即创建”。

操作步骤 登录管理控制台。 在左侧导航中单击“定时任务”页面。 进入“定时任务”页面。 单击定时任务页面右上角“创建定时任务”。 弹出“创建定时任务”界面。 配置定时任务信息。 任务类型：选择“休眠”。 定时休眠当前只支持Windows操作系统。 强制执行任务：您设置好定时休眠任务后，当到达定时时间点时，当前桌面有用户连接，为保证用户体验，系统不会执行休眠，将自动顺延到下一个定时时间点，如果勾选后，系统到达定时时间点后，将会强制执行休眠。 定时任务名称：用户自定义。 执行周期：支持以下有几种周期，根据用户需求自行选择。 指定时间：可精确到某年某月某日某时某分某秒。 按天：可设置具体时间、间隔天数、过期时间。 按周：可设置具体日期、时间、过期时间。 按月：可设置具体月份、具体日期、时间、过期时间。 时区：系统默认选择当地时区。 描述（可选）：根据实际情况自定义配置。 选择是否通知用户。 通知：设置“早于定时任务”时间，范围为1~10080分钟，并根据所需输入通知消息内容，仅支持文本消息，范围为1~400个字符。 不通知：执行6。 仅Windows系统支持“通知消息”。 点击“下一步：选择对象”。 跳转至“选择应用对象”界面。 在“可选对象”的下拉框中选择所有桌面/桌面/桌面池/标签，并在下方列表中勾选需要应用的对象。 单击“立即创建”。

操作步骤 登录管理控制台。 在左侧导航中单击“定时任务”。 进入“定时任务”页面。 单击定时任务页面右上角“创建定时任务”。 弹出“创建定时任务”界面。 配置定时任务信息。 任务类型：选择“开机”。 定时任务名称：用户自定义。 执行周期：支持以下有几种周期，根据用户需求自行选择。 指定时间：可精确到某年某月某日某时某分某秒。 按天：可设置具体时间、间隔天数、过期时间。 按周：可设置具体日期、时间、过期时间。 按月：可设置具体月份、具体日期、时间、过期时间。 时区：系统默认选择当地时区。 描述（可选）：根据实际情况自定义配置。 点击“下一步：选择对象”。 跳转至“选择应用对象”界面。 在“可选对象”的下拉框中选择所有桌面/桌面/桌面池/标签，并在下方列表中勾选需要应用的对象。 单击“立即创建”。

为kubectl上下文指定Namespace 上面创建Network是在指定的Namespace下创建的，本文档后续的资源创建都是在某个命名空间下操作，每次都指定命名空间比较麻烦，您可以为kubectl上下文指定命名空间，这样在某个上下文中，创建的资源就都是在某个命名空间下，方便操作。 指定Namespace只需要在设置上下文命令中添加一个“--namespace”选项，如下所示。 kubectl config set-context $context --namespace=$ns 其中，$ns为Namespace的名称；$context 为上下文的名称，可以自定义，也可执行如下命令获取： # kubectl config get-contexts CURRENT NAME CLUSTER AUTHINFO NAMESPACE cci-context-cn-east-3-1C8PNI0POPPCSFGXPM6S cci-cluster-cn-east-3 cci-user-cn-east-3-1C8PNI0POPPCSFGXPM6S * cci-context-cn-east-3-hwuser_xxx cci-cluster-cn-east-3 cci-user-cn-east-3-hwuser_xxx kubernetes-admin@kubernetes kubernetes kubernetes-admin 假设，上面创建的Namespace名称为namespace-test，则示例如下。 # kubectl config set-context cci-context --namespace=namespace-test 指定Namespace后，就可以使用 kubectl 命令直接操作云容器实例的相关资源。如下所示，执行kubectl get pod，查看Pod资源，一切正常。 # kubectl get pod No resources found.

Namespace与网络的关系 从网络角度看，命名空间对应一个虚拟私有云（VPC）中一个子网，如图1所示，在创建命名空间时会关联已有VPC或创建一个新的VPC，并在VPC下创建一个子网。后续在该命名空间下创建Pod、Service等资源时都会在对应的VPC及子网之内，且占用子网中的IP地址。 通常情况下，如果您在同一个VPC下还会使用其他服务的资源，您需要考虑您的网络规划，如子网网段划分、IP数量规划等，确保有可用的网络资源。 图1 命名空间与VPC子网的关系

非安全环境配置kubectl 参照上述操作，安装并设置kubectl。 编辑kubeconfig文件，删除敏感信息参数。 Linux系统，kubeconfig文件默认位于$HOME/.kube/config。 表2 待删除敏感信息参数 Command Flag Environment Value Description --domain-name DOMAIN_NAME 租户名 --user-name USER_NAME 子用户名 --password PASSWORD 用户密码 --ak ACCESS_KEY_ID Access Key --sk SECRET_ACCESS_KEY Secret Key --cache CREDENTIAL_CACHE 是否开启缓存Token 配置删除参数相应的环境变量来使用kubectl，以AK/SK为例。 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险, 建议在配置文件或者环境变量中密文存放, 使用时解密, 确保安全。 export ACCESS_KEY_ID={Access Key} #替换为HUAWEICLOUD_SDK_AK export SECRET_ACCESS_KEY={Secret Key} #替换为HUAWEICLOUD_SDK_SK export CREDENTIAL_CACHE=false kubectl get ns 执行上述命令后，提示如下类似信息： No resources found.