参数 是否必填 参数类型 说明 示例 下级对象 natOid 是 String NAT网关ID snatOid 是 String SNAT规则ID

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

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

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

枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body 无 响应示例 {"statusCode":800,"message":"OK.","returnObj":{"total":1,"list":[{"snapshotPolicyOid":"sspxxx","snapshotPolicyName":"fooName","description":"","createTime":"20221112T09:03:19Z"}]}} 状态码 请参考 状态码 错误码 请参考 错误码

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

接口功能介绍 快照策略功能请联系客户经理开通。 快照策略仅支持资源包来源的云电脑（即不支持单实例来源的云电脑）。 如果云电脑已存在快照，且上一个快照时间点到执行周期时一直关机，则不自动创建快照，当用户开机后且到下一个执行周期，再创建快照。 幂等接口，重复分配给同一个电脑会忽略并视为分配成功。 注意！若云电脑已分配快照策略，原有快照策略会被取消。 接口约束 无 URI POST /v3/snapshotPolicy/applyToDesktops 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 snapshotPolicyOid 是 String 快照策略ID。 sspgg7576hc59fkph1b3xe4y desktopOidList 是 Array of Strings 云电脑ID列表。长度限制[1,10]。 D0023092201180710 响应参数 参数 参数类型 说明 示例 下级对象 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 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"snapshotPolicyOid":"sspxxx","snapshotPolicyName":"fooName","snapshotType":"sys","snapshotTimePoints":["00:00","01:00"],"cycleType":"Day","daysOfWeek":null,"cycleDayCnt":3,"retentionRule":"Day","retentionMonthCnt":null,"retentionDayCnt":4,"retentionCnt":null,"autoDelete":false,"description":""} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }} 状态码 请参考 状态码 错误码 请参考 错误码

参数 是否必填 参数类型 说明 示例 下级对象 snapshotPolicyOid 是 String 快照策略ID。 sspgg7576hc59fkph1b3xe4y

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

参数 是否必填 参数类型 说明 示例 下级对象 pubUserOid 是 String 用户ID upg2lck6loc5swjlg2x6e16e userName 是 String 用户名称。字符数限制：[1,20]。 xiemushuxiugai email 否 String 邮箱。字符数限制：[1,50]。 email@foo.com gender 否 String 性别。枚举值范围：[男,女]。 null telephone 否 String 固定电话。字符数限制：[0,20]。 null position 否 String 职位。字符数限制：[0,50]。 null

枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body 无 响应示例 { "statusCode":800, "message":"OK.", "returnObj":{ "total":1, "list":[{ "pubUserOid":"upgxxx", "orgOid":"orgfoo", "email":"foo@foo.com", "gender":"男", "telephone":"xxxxxxxx", "position":"xxxxxxxxx", "userName":"foo", "desktopNums":0, "status":1, "loginAccount":"foo id", "userAccount":"foo", "lockStatus":0, "desktopAdminPriv":"DesktopUser" }] } } 状态码 请参考 状态码 错误码 请参考 错误码

响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 message String 提示信息。 OK. returnObj Object 返回数据结构体。 { } returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"activationType":2,"createUserList":[{"email":null,"userAccount":"foocreatevb79oWGt","password":"1a3!2aaaaaaaaaaaaa","userName":null,"gender":null,"telephone":null,"position":null}],"orgOid":"orgfoo"} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }} 状态码 请参考 状态码 错误码 请参考 错误码

参数 是否必填 参数类型 说明 示例 下级对象 snapshotPolicyName 是 String 快照策略名称。只能包含中文、数字、英文字母、下划线、中划线，长度限制164个字符。 ame1044 snapshotType 是 String 快照类型。枚举值范围：sys系统盘;data数据盘;all系统盘和数据盘，其中data和all是数据盘相关的快照类型，请联系客户经理开通。 sys snapshotTimePoints 是 Array of Strings 快照时间点集合。使用UTC+8时间。任意2个时间差必须大于等于1小时。时间点数量范围[1,24]。时间点格式：HH:mm。 cycleType 是 String 快照的周期类型。枚举值范围：Week按周;Day按天。 Week daysOfWeek 否 Array of Strings 一个星期中需要快照的天。快照周期为按周时必填。取值范围[1,7]，数量限制[1,7]，不允许重复值。 1，7 cycleDayCnt 否 Integer 快照周期天数。快照周期为按天时必填。取值范围[1,10000]。 1 retentionRule 是 String 保留规则。枚举值范围：Month按月;Day按天;Quantity按数量;Forever永久保留。 Quantity retentionMonthCnt 否 Integer 保留月数。retentionRule为Month时必填。取值范围[1,12]。 1 retentionDayCnt 否 Integer 保留天数。retentionRule为Day时必填。取值范围[1,99999]。 1 retentionCnt 否 Integer 保留数量。retentionRule为Quantity时必填。取值范围[1,99999]。 4 autoDelete 否 Boolean 是否自动删除。retentionRule为Quantity时需要填写，默认为true。 autoDelete description 否 String 描述。字符数限制[0,254]，默认为空。

枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"type":"sys","rollbackSettings":[{"desktopOid":"XXXXXXXXXXXXX6925","snapshotOid":"ssfoo"}]} 响应示例 {"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

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

枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body 无 响应示例 {"statusCode":800,"message":"OK.","returnObj":{"total":1,"list":[{"snapshotOid":"ssfoo","name":"foo","desktopOid":"XXXXXXXXXXXXX6925","description":"foo","type":"sys","status":"Active","createTime":"20220925T08:26:29Z"}]}} 状态码 请参考 状态码 错误码 请参考 错误码

参数 是否必填 参数类型 说明 示例 下级对象 snapshotOid 是 String 快照ID ssbmda2gjsbz89lkx2a1an5

接口功能介绍 创建快照 接口约束 无 URI POST /v3/snapshot/create 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 name 是 String 快照名称，只能包含汉字、数字、英文字母、中划线和下划线，长度限制116个字符 APIKZ desktopOid 是 String 云电脑ID D0023092701181644 resourcePackOid 是 String 资源包ID rsp8qvf6t33j2yh97s3t8drc type 是 String 快照类型，枚举值范围：[sys,data,all]（sys系统盘;data数据盘;all系统盘和数据盘），其中data和all是数据盘相关的快照类型，请联系客户经理开通 sys dataDiskOidList 否 Array of Strings 数据盘ID列表，长度上限是5，type为data或all时必传 null description 是 String 描述，字符数限制[0,250] API测试 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK returnObj Object 返回数据结构体。 returnObj

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

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

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

接口功能介绍 重启云电脑 接口约束 无 URI POST /v3/desktop/batch/reboot 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 desktopList 是 Array of Objects 云电脑列表，可设置一个或多个，最多 10 个 desktopList 表 desktopList 参数 是否必填 参数类型 说明 示例 下级对象 desktopOid 是 String 云电脑ID D0023101301183998 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 message String 提示信息。 OK. returnObj Object 返回数据结构体。 { } returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"desktopList":[{"desktopOid":"XXXXXXXXXXXXX6925"}]} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }} 状态码 请参考 状态码

参数 是否必填 参数类型 说明 示例 下级对象 volumeOid 是 String 云硬盘ID desktopOid 是 String 云电脑ID

错误码 请参考 错误码

接口功能介绍 绑定用户 接口约束 无 URI POST /v3/desktop/bindUser 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 pubUserOid 是 String 用户ID upg2lck6loc5swjlg2x6e16e desktopOid 是 String 云电脑ID D0023101301183998 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 message String 提示信息。 OK. returnObj Object 返回数据结构体。 { } returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"pubUserOid":"upgxxx","desktopOid":"XXXXXXXXXXXXX6925"} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }} 状态码 请参考 状态码 错误码 请参考 错误码

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

参数 是否必填 参数类型 说明 示例 下级对象 bandwidthOid 是 String 带宽ID size 是 Integer 带宽大小（单位：Mbps），需大于0 autoPay 否 Boolean 是否自动支付（仅订购类型为包周期的带宽），默认false。取值范围： true:是。（需账号有足够金额） false:否。

接口功能介绍 快照策略功能请联系客户经理开通。 幂等接口，重复取消会忽略并视为取消成功。 注意！若云电脑与快照策略不存在分配关系，取消时会直接忽略。 接口约束 无 URI POST /v3/snapshotPolicy/cancelFromDesktops 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 snapshotPolicyOid 是 String 快照策略ID。 sspgg7576hc59fkph1b3xe4y desktopOidList 是 Array of Strings 云电脑ID列表。长度限制[1,10]。 D0023092201180710 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 ok returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"snapshotPolicyOid":"sspxxx","desktopOidList":["XXXXXXXXXXXXX6925"]}

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

接口功能介绍 修改部门资源包配额 接口约束 无 URI POST /v3/resourcePack/orgQuota/modify 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 orgOid 是 String 部门ID org18qnu7l41v8fr2xif6jdq cpu 是 Integer 计算包CPU数量（单位：核），至少为0 4 memory 是 Integer 计算包内存数量（单位：GB），至少为0 8 diskSize 是 Integer 存储包空间大小（单位：GB），至少为0 80 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"orgOid":"orgdel","cpu":0,"memory":0,"diskSize":0}