响应示例 { "statusCode":800, "message":"OK.", "returnObj":{ "operationId":"jobtaskabc7211cb74fbb283e42809d2c" } } 状态码 请参考 状态码 错误码 请参考 错误码

参数 是否必填 参数类型 说明 示例 下级对象 desktopOidList 是 Array of Strings 云电脑ID列表，可设置一个或多个，最多10个 D0023092001180339 orgOid 是 String 部门ID org4eq48g7mes4dvuh011j2o includeUser 否 Boolean 是否包括云电脑关联用户，默认为否 includeUser

状态码 请参考 状态码 错误码 请参考 错误码

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

接口功能介绍 适用于此操作的计算增强型云电脑需要满足全部条件：计费方式为单实例、资源包。 此操作将先进行云电脑关机操作。 计算增强型云电脑功能请联系客户经理开通。 接口约束 无 URI POST /v3/ecs/resizeSystemDisk 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 desktopOid 是 String 云电脑ID diskSize 是 Integer 扩容后系统盘大小（单位：GB）。取值范围：大于当前系统盘大小 autoPay 否 Boolean 是否自动支付（仅创建单独付费云电脑有效），默认false。取值范围： true:是。（仅订购类型为包周期类型有效，需账号有足够金额） false:否。（仅订购类型为包周期类型有效） 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据对象 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 newOrderNo String 订单号（仅创建单独付费云电脑有效）。 newOrderId String 订单id（仅创建单独付费云电脑有效）。 totalPrice String 总价格（仅创建单独付费云电脑有效）。 operationId String 扩容计算增强型云电脑系统盘操作。可用于查询操作状态（相关接口：异步操作查询操作详情）。

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

接口功能介绍 建议开通前先检查云电脑服务状态。相关接口：查询云电脑服务开通状态。 接口约束 无 URI POST /v3/desktopService/subscribe 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1027' message String 提示信息。 0k returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body 无 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }} 状态码 请参考 状态码 错误码 请参考 错误码

参数 是否必填 参数类型 说明 示例 下级对象 desktopOid 是 String 云电脑ID password 是 String 密码，字符数限制：[8,26]。 必须至少包含大小写英文字母、数字和特殊符号三类字符，特殊字符集合：~!@$%^&()+{[]} ;:,.'?/<>。 密码不建议包含与账号相关的信息。 密码不能使用3个及以上键盘连续相邻字符，如123，Qwe等。 注意：如果传入password参数，建议您使用HTTPS协议发送请求，避免密码泄露

接口功能介绍 幂等接口，重复解绑会忽略并视为成功。 计算增强型云电脑功能请联系客户经理开通。 接口约束 无 URI POST /v3/ecs/unbindUser 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 desktopOid 是 String 云电脑ID 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body { "desktopOid":"XXXXXXXXXXXXX6925" } 响应示例 { "statusCode":800, "message":"OK.", "returnObj":{ } } 状态码 请参考 状态码 错误码 请参考 错误码

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

参数 参数类型 说明 示例 下级对象 portList Array of Objects 虚机网卡信息，当portOid为0，代表全部网卡 portList securityGroupList Array of Objects 虚机可绑定安全组信息 securityGroupList portSgList Array of Objects 虚机网卡和安全组的关联，portOid为0时代表全部网卡 portSgList

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

参数 是否必填 参数类型 说明 示例 下级对象 securityGroupOid 是 String 安全组ID

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

接口功能介绍 移除安全组v3 接口约束 无 URI POST /v3/securityGroup/remove 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 desktopOid 是 String 桌面id securityGroupOid 是 String 安全组id portOid 否 String 网卡id，参数为空表示桌面移除安全组，参数非空表示桌面网卡移除安全组 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj String 返回安全组id sgdes9ihmdrpas8pdge4e4l 枚举参数 无 请求示例 请求url 请求头header 无 请求体body { "desktopOid":"D0025042401321395", "securityGroupOid":"sgdes9ihmdrpas8pdge4e4l", "portOid":"portggpgxz5n5nhmro3fw34jg" }

参数 参数类型 说明 示例 下级对象 natOid String NAT网关ID XXXXXXXXXXXXX name String NAT网关名称 vpcOid String VPC ID vpcName String VPC名称 subnetName String 子网名称 subnetCidr String 子网网段 spec String 规格（LITTLE小型;LARGE大型） description String 描述 source String 来源（RESOURCEPACK资源包） status String NAT网关状态（CREATING创建中;ACTIVE正常;FROZEN冻结中;DELETING删除中;ERROR异常） createTime String 创建时间。以ISO 8601为标准，并使用UTC+0时间，格式为yyyyMMddTHH:mm:ssZ。

参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx natOid 是 String NAT网关ID floatingIpAddress 否 String 弹性IP subnetName 否 String 子网名称 pageNum 否 Integer 页码，至少1，默认1 pageSize 否 Integer 每页数量，最大100，默认10

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

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

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

枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body { "natOid":"xxxxxxxxx", "fipOid":"xxxxxxxxx", "privateIpAddress":"XXX.XXX.XXX.XXX", "portType":"SPECIAL", "externalPort":9000, "internalPort":8080, "protocol":"TCP" } 响应示例 { "statusCode":800, "message":"OK.", "returnObj":{ } } 状态码 请参考 状态码 错误码 请参考 错误码

参数 是否必填 参数类型 说明 示例 下级对象 orgOid 是 String 部门ID org3nnpslaj4erof73pw4rj6

参数 参数类型 说明 示例 下级对象 snapshotPolicyOid String 快照策略ID。 sspgg7576hc59fkph1b3xe4y snapshotPolicyName String 名称。 测oName1005 description String 描述。 createTime String 创建时间。以ISO 8601为标准，并使用UTC+0时间，格式为yyyyMMddTHH:mm:ssZ。 20230927T10:08:11Z

参数 是否必填 参数类型 说明 示例 下级对象 pubUserOidList 是 Array of Strings 用户ID列表，最大数量50 upg8to5zvs52v2g01h6h8fy2

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

接口功能介绍 快照策略功能请联系客户经理开通。 快照策略仅支持资源包来源的云电脑（即不支持单实例来源的云电脑）。 如果云电脑已存在快照，且上一个快照时间点到执行周期时一直关机，则不自动创建快照，当用户开机后且到下一个执行周期，再创建快照。 接口约束 无 URI POST /v3/snapshotPolicy/modify 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 snapshotPolicyOid 是 String 快照策略ID。 sspzf13as8ds7ccqb86z8s57 snapshotPolicyName 是 String 快照策略名称。只能包含中文、数字、英文字母、下划线、中划线，长度限制164个字符。 AS116 snapshotType 是 String 快照类型。枚举值范围：sys系统盘;data数据盘;all系统盘和数据盘，其中data和all是数据盘相关的快照类型，请联系客户经理开通。 sys snapshotTimePoints 是 Array of Strings 快照时间点集合。使用UTC+8时间。任意2个时间差必须大于等于1小时。时间点数量范围[1,24]。时间点格式：HH:mm。 cycleType 是 String 快照的周期类型。枚举值范围：Week按周;Day按天。 Day daysOfWeek 否 Array of Strings 一个星期中需要快照的天。快照周期为按周时必填。取值范围[1,7]，数量限制[1,7]，不允许重复值。 [2,7] cycleDayCnt 否 Integer 快照周期天数。快照周期为按天时必填。取值范围[1,10000]。 3 retentionRule 是 String 保留规则。枚举值范围：Month按月;Day按天;Quantity按数量;Forever永久保留。 Day retentionMonthCnt 否 Integer 保留月数。retentionRule为Month时必填。取值范围[1,12]。 2 retentionDayCnt 否 Integer 保留天数。retentionRule为Day时必填。取值范围[1,99999]。 1 retentionCnt 否 Integer 保留数量。retentionRule为Quantity时必填。取值范围[1,99999]。 4 autoDelete 否 Boolean 是否自动删除。retentionRule为Quantity时需要填写，默认为true。 autoDelete description 是 String 描述。字符数限制[0,254]。 0

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

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

枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"pubUserOid":"upgfoo","userName":"fooName","email":"email@foo.com","gender":null,"telephone":null,"position":null} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }} 状态码 请参考 状态码 错误码 请参考 错误码

接口功能介绍 查询用户列表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本地管理员权限)

接口功能介绍 幂等接口，已存在用户账号重复创建会忽略并视为创建成功。 接口约束 无 URI POST /v3/user/create 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 activationType 是 Integer 激活类型(1邮件通知激活；2管理员激活) 2 createUserList 是 Array of Objects 需要创建的用户列表, 最大数量50 createUserList orgOid 是 String 部门ID orgadhij4zha35v3knu9irlg 表 createUserList 参数 是否必填 参数类型 说明 示例 下级对象 userAccount 是 String 用户账号 xiemushutest3 email 否 String 通知邮箱。激活方式为邮件通知时，必填。 null password 否 String 用户账号密码 abc!ABC0927 userName 否 String 用户名称。字符数限制：[0,20]。 null gender 否 String 性别。枚举值范围：[男,女]。 null telephone 否 String 固定电话。字符数限制：[0,20]。 null position 否 String 职位。字符数限制：[0,50]。 null

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