使用前必读
欢迎使用云桌面（Workspace）。云桌面（Workspace）是一种基于云计算的桌面服务。与传统PC和VDI不同，企业无需投入大量的资金和花费数天的部署时间，即可快速构建桌面办公环境。云桌面支持多种登录方式，可让您灵活存取文件及使用应用，实现移动办公。
您可以使用本文档提供的API对云桌面进行相关操作，如创建、查询、删除等。支持的全部操作请参见API概览。
在调用云桌面服务的API之前，请确保已经充分了解云桌面服务的相关概念，详细信息请参见《云桌面用户指南（管理员）》。
调用说明
云桌面（Workspace）服务提供了REST（Representational State Transfer）风格API，支持您通过HTTPS请求调用，调用方法请参见如何调用API。
终端节点
终端节点（Endpoint）即调用API的请求地址，不同服务不同区域的终端节点不同。您可以从地区和终端节点中查询所有服务的终端节点。
区域名称 | 区域 | 终端节点（Endpoint） |
|---|---|---|
中国-香港 | ap-southeast-1 | workspace.ap-southeast-1.myhuaweicloud.com |
拉美-圣地亚哥 | la-south-2 | workspace.la-south-2.myhuaweicloud.com |
亚太-新加坡 | ap-southeast-3 | workspace.ap-southeast-3.myhuaweicloud.com |
拉美-圣保罗 | sa-brazil-1 | workspace.sa-brazil-1.myhuaweicloud.com |
拉美-墨西哥城一 | na-mexico-1 | workspace.na-mexico-1.myhuaweicloud.com |
拉美-墨西哥城二 | la-north-2 | workspace.la-north-2.myhuaweicloud.com |
约束与限制
云桌面Workspace服务端API设置了调用次数限制，避免出现短时间内重复调用API，服务中断的情况，如表2所示。
接口分类 | 接口名称 | 接口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次/分钟 |
基本概念
- 账号
账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用他们进行日常管理工作。
- 用户
由账号在IAM中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。
通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。
- 区域（Region）
- 可用区（AZ，Availability Zone）
一个AZ是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。
- 项目
区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中购买资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。
图1 项目隔离模型
