检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
查询、创建、删除用户等接口。 用户组 查询、创建、删除用户组等接口。 磁盘 增加、扩容、删除磁盘接口。 连接信息 查询登录信息、导出连接记录等接口。 策略组 查询、创建、删除接入策略等接口。 产品套餐 查询产品套餐列表接口。 认证配置 查询、更新辅助认证配置接口。 配额 查询租户配额接口。 镜像
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID,所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下: 登录管理控制台。 单击用户名,在下拉列表中单击“我的凭证”。 在“API凭证”页面中查看账号ID。 图1 获取账号ID 父主题: 附录
如何调用API 构造请求 认证鉴权 返回结果
云桌面API 云办公服务 桌面 桌面统计 桌面名称策略 用户 用户组 磁盘 连接信息 策略组 产品套餐 认证配置 配额 镜像 可用分区 桌面标签 任务 委托 网络 定时任务 终端与桌面绑定 报表统计
云应用API 产品套餐管理 可用区管理 磁盘管理 服务器组管理 服务器管理 应用组管理 应用管理 应用授权管理 使用记录 策略管理 存储管理 查询Job状态 配额管理 应用仓库管理 镜像管理
忽略不存在的镜像实例,响应正常。 不允许操作状态为 创建中、镜像创建中的实例,响应异常。 不支持资源关联发生变化后,请求删除镜像实例关联资源,任务响应异常。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
GET:请求服务器返回指定资源。 PUT:请求服务器更新指定资源。 POST:请求服务器新增资源或执行特殊操作。 DELETE:请求服务器删除指定资源,如删除对象等。 HEAD:请求服务器资源头部。 PATCH:请求服务器更新资源的部分内容。当资源不存在的时候,PATCH可能会去创建一个新的资源。
配额校验 功能介绍 配额校验,购买服务器前可用调用该接口,校验本次创建服务器资源是否足够。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v1/{project_id}/check/quota
查询租户配额 功能介绍 Console Framework和WKSDesktopManager调用该接口查询租户配额。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET
用户会话注销 功能介绍 用户会话注销。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v1/{project_id}/session/logoff 表1
查询委托功能 功能介绍 查询委托功能 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{project_id}/agencies 表1 路径参数 参数
查询可用磁盘类型 功能介绍 该接口用于查询可用磁盘类型。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v1/{project_id}/volume-type
查询单个桌面详情 功能介绍 指定桌面Id查询详细信息。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{project_id}/desktops/{desktop_id}
创建用户 功能介绍 该接口用于创建桌面用户。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/{project_id}/users 表1 路径参数 参数
批量注销桌面 功能介绍 批量注销桌面(仅支持容器桌面,待下线,有疑问请联系管理员)。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/{projec
批量删除桌面 功能介绍 批量删除桌面,删除后无法恢复。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/{project_id}/desktops/batch-delete
开通委托功能 功能介绍 开通委托功能 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/{project_id}/agencies 表1 路径参数 参数
扩容桌面磁盘 功能介绍 扩容桌面磁盘。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/{project_id}/volumes/expand 表1
重建桌面 功能介绍 批量重建桌面系统盘。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/{project_id}/desktops/rebuild
删除桌面标签 功能介绍 该接口用于删除桌面标签。删除时,如果删除的标签不存在,默认处理成功。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v2/{