参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002

参数 参数类型 说明 示例 下级对象 operation Object 扩容云电脑数据盘操作。可用于查询操作状态（相关接口：查询操作列表）。 operation

参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK returnObj Object 返回数据结构体。 returnObj

接口功能介绍 删除用户 接口约束 无 URI POST /v3/user/batchRemove 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 pubUserOidList 是 Array of Strings 用户ID列表，最大数量50 upg8to5zvs52v2g01h6h8fy2 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 message String 提示信息。 OK. returnObj Object 返回数据结构体。 { } returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"pubUserOidList":["upgfoo","upgbar"]} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }} 状态码 请参考 状态码 错误码 请参考 错误码

参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK returnObj Object 返回数据结构体。 returnObj

接口功能介绍 查询弹性IP列表v3 接口约束 无 URI GET /v3/fip/describe 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx floatingIpAddress 否 String 弹性IP地址 desktopOid 否 String 已绑定的桌面ID ipAddr 否 String 已绑定的桌面的IP地址 bandName 否 String 带宽名称 resourcePackName 否 String 资源包名称 pageNum 否 Integer 页码，至少1，默认1 pageSize 否 Integer 每页数量，最大100，默认10 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据对象 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 total Long 总记录数 list Array of Objects 数据列表 list 表 list 参数 参数类型 说明 示例 下级对象 fipOid String 弹性IP ID fipUuid String 弹性IP UUID floatingIpAddress String 弹性IP地址 bindObjType String 绑定状态和已绑定实例的对象类型，[0：未绑定，1：虚机，2：仅SNAT规则，3：仅DNAT规则，4：VIP，5：SNAT规则和DNAT规则，5：PORT，12：ELB，98：绑定中，99：解绑中] bandName String 带宽名称 bandWidth Integer 带宽，单位：MBps desktopName String 绑定弹性IP的对象名称 desktopOid String 绑定弹性IP的对象编码 ipAddr String 已绑定对象的IP地址 resourcePackOid String 资源包ID resourcePackName String 资源包名称 status Integer 弹性IP状态，[0：创建中，1：正常，2：已删除，3：DOWN，4：错误，5：删除中，6：冻结]

参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 imageName 否 String 镜像名称 DYF status 否 String 状态。枚举值范围：[Starting启用中, Available可用, Stopped停用, StartFailed启用失败, Uploading上传中, UploadFailed上传失败, WaitVerify待验证, Expired已过期, Deleting删除中, DeleteFailed删除失败]。 Available pageNum 否 Integer 页码，至少1，默认1 1 pageSize 否 Integer 每页数量，最大100，默认10 10

参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK returnObj Object 返回数据结构体。 returnObj

参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx sysRoleName 否 String 角色名称 test555 status 否 Integer 角色状态 1 orgOid 否 String 部门Oid orgtest isQuerySubOrg 否 Boolean 是否包含下级部门 false pageNum 否 Integer 页码，至少1，默认1 1 pageSize 否 Integer 每页数量，最大100，默认10 10

参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 ok returnObj Object 返回数据结构体。 returnObj

参数 参数类型 说明 示例 下级对象 pubUserOid String 用户ID upgm611u6q1vm9hekeo5dckl userName String 用户名 zizhanghao loginAccount String 登录账户 zizhanghao3851 userAccount String 用户账户 zizhanghao email String 通知邮箱 maxm756913@163.com status Byte 状态（1有效，3待确认） 1

接口功能介绍 并发桌面池功能请联系客户经理开通。 接口约束 无 URI POST /v3/concurrentDesktopPool/editPolicy 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 desktopPoolOid 是 String 并发桌面池ID dpurmb31l1two2so9us14ro keepDuration 否 Integer 用户断开连接后，云电脑所占并发额度的保留时长（单位：分钟），至少是3 33 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"desktopPoolOid":"dpxx","keepDuration":33} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }} 状态码 请参考 状态码

参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 message String 提示信息。 OK. returnObj Object 返回数据结构体。 { } returnObj

枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"snapshotPolicyOid":"sspxxx","desktopOidList":["XXXXXXXXXXXXX6925"]} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }} 状态码 请参考 状态码 错误码 请参考 错误码

错误码 请参考 错误码

参数 参数类型 说明 示例 下级对象 snapshotPolicyOid String 快照策略ID。 sspgg7576hc59fkph1b3xe4y snapshotPolicyName String 快照策略名称。 测oName1005 snapshotType String 快照类型。枚举值范围：sys系统盘;data数据盘;all系统盘和数据盘。 sys snapshotTimePoints Array of Objects 快照时间点集合。使用UTC+8时间。时间点格式：HH:mm。 '00:00','01:00' snapshotTimePoints cycleType String 快照的周期类型。枚举值范围：Week按周;Day按天。 Day daysOfWeek Array of Objects 一个星期中需要快照的天。取值范围[1,7]。只有cycleType取值为Week时有实际意义。 '1', '7' daysOfWeek cycleDayCnt Integer 快照周期天数。只有cycleType取值为Day时有实际意义。 1 retentionRule String 保留规则。枚举值范围：Month按月;Day按天;Quantity按数量;Forever永久保留。 Quantity retentionMonthCnt Integer 保留月数。只有retentionRule取值为Month时有实际意义。 1 retentionDayCnt Integer 保留天数。只有retentionRule取值为Day时有实际意义。 1 retentionCnt Integer 保留数量。只有retentionRule取值为Quantity时有实际意义。 4 autoDelete Boolean 是否自动删除。只有retentionRule取值为Quantity时有实际意义。 false description String 描述。 createTime String 创建时间。以ISO 8601为标准，并使用UTC+0时间，格式为yyyyMMddTHH:mm:ssZ。 20230927T10:08:11Z

参数 是否必填 参数类型 说明 示例 下级对象 snapshotPolicyOid 是 String 快照策略ID。 sspgg7576hc59fkph1b3xe4y desktopOidList 是 Array of Strings 云电脑ID列表。长度限制[1,10]。 D0023092201180710

参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002

错误码 请参考 错误码

接口功能介绍 查询用户列表v3 接口约束 无 URI GET /v3/user/describe 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx orgOid 否 String 部门Oid，默认为根部门 querySubOrg 否 Boolean 是否包含下级部门。默认为false。 userName 否 String 用户名称 email 否 String 通知邮箱 emails 否 String 通知邮箱集合。取值由邮箱组成一个JSON数组，最多支持10个邮箱，邮箱之间用半角逗号（,）隔开。 userAccount 否 String 用户账号 pubUserOids 否 String 用户ID。取值由用户ID组成一个JSON数组，最多支持10个ID，ID之间用半角逗号（,）隔开。 pageNum 否 Integer 页码，至少1，默认1 pageSize 否 Integer 每页数量，最大100，默认10 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据对象 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 total Long 总记录数 list Array of Objects 数据列表 list 表 list 参数 参数类型 说明 示例 下级对象 pubUserOid String 用户ID orgOid String 部门ID email String 通知邮箱 gender String 性别 telephone String 固定电话 position String 职位 userName String 用户名 desktopNums Integer 云电脑数量 status Byte 状态（1有效，3待确认） loginAccount String 登录账户 userAccount String 用户账户 lockStatus Byte 锁定状态(0未锁定;1锁定) desktopAdminPriv String 账号权限(DesktopUser普通权限;DesktopAdmin本地管理员权限)

参数 是否必填 参数类型 说明 示例 下级对象 vpcOid 是 String VPC ID vpcxx41k2vq5aj60nm22jty4

枚举参数 无 请求示例 请求url 请求头header 无 请求体body { "pubUserOid":"upgfoo", "password":"1a3!2aaaaaaaaaaaaa" } 响应示例 { "statusCode":800, "message":"OK.", "returnObj":{ } } 状态码 请参考 状态码 错误码 请参考 错误码

错误码 请参考 错误码

参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 message String 提示信息。 OK. returnObj Object 返回数据结构体。 { } returnObj

参数 是否必填 参数类型 说明 示例 下级对象 subnetOid 是 String VPC子网ID snvpma7obaz5i6wgv4fh38f

参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据对象 returnObj

参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据对象 returnObj

响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1006 message String 提示信息。 OK returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"imageName":"fooName","description":"fooDesc","desktopOid":"DXX","resourcePackOid":"rspxxx","type":null} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }} 状态码 请参考 状态码 错误码 请参考 错误码

下载AI云电脑 请前往天翼量子AI云电脑下载页，下载安装AI云电脑客户端。 软硬件兼容清单 请前往软硬件兼容性清单页面查看。