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

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

参数 是否必填 参数类型 说明 示例 下级对象 pubUserOidList 是 Array of Strings 用户ID列表，最大数量100 desktopAdminPriv 否 String 账号权限(DesktopUser普通权限;DesktopAdmin本地管理员权限)

错误码 请参考 错误码

接口功能介绍 删除VPC子网 接口约束 无 URI POST /v3/vpc/subnet/delete 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 subnetOid 是 String VPC子网ID snvpma7obaz5i6wgv4fh38f 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"subnetOid":"subnetdel"} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }} 状态码 请参考 状态码 错误码 请参考 错误码

接口功能介绍 计算增强型云电脑功能请联系客户经理开通。 接口约束 无 URI GET /v3/ecs/describe 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx desktopOid 否 String 云电脑ID desktopNickName 否 String 云电脑别名 vpcOid 否 String vpcId subnetOidList 否 String VPC子网ID。取值由VPC子网ID组成一个JSON数组，最多支持20个ID，ID之间用半角逗号（,）隔开。 status 否 String 运行状态（Creating创建中;Stopped已关机;Starting启动中;Running运行中;Rebooting重启中;Rebuilding重装中;Stopping关闭中;Deleting删除中;Unhealthy异常;RollingBack回滚中;Resizing变更中;Evacuating迁移中;Rescuing救援中;BackingUp备份中;DeletingBackup删除备份中;Regaining恢复中;Hibernating休眠中;Hibernated已休眠;WakingUp唤醒中） pageNum 否 Integer 页码，至少1，默认1 pageSize 否 Integer 每页数量，最大100，默认10

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

参数 参数类型 说明 示例 下级对象 newOrderNo String 订单号（仅创建单独付费计算增强型云电脑有效）。 newOrderId String 订单id（仅创建单独付费计算增强型云电脑有效）。 totalPrice String 总价格（仅创建单独付费计算增强型云电脑有效）。 operations Array of Objects 创建计算增强型云电脑操作列表。可用于查询操作状态和新建计算增强型云电脑ID（相关接口：异步操作查询操作详情）（仅创建资源包计算增强型云电脑有效）。。 operations

枚举参数 无 请求示例 请求url 请求头header 无 请求体body 无 响应示例 { "statusCode":800, "message":"OK.", "returnObj":[{ "templateOid":"dftj5ep41td4ajo4o51v0cya", "templateName":"通用型(2核4G)", "type":"LinuxServer", "cpu":2, "memory":4, "gpuPatternName":null, "gpuTypeName":null, "gpuRam":null, "gpuSliceRam":null, "gpuSliceRamUnit":null, "multiCard":0, "parTemplateOid":null, "baseBandWidth":0.25, "maxBandWidth":1, "pps":60000, "nicQueue":1, "nicQuantity":2 }] } 状态码 请参考 状态码 错误码 请参考 错误码

参数 是否必填 参数类型 说明 示例 下级对象 desktopList 是 Array of Objects 云电脑列表，可设置一个或多个，最多 10 个 desktopList

枚举参数 无 请求示例 请求url 请求头header 无 请求体body 无 响应示例 { "statusCode":800, "message":"OK.", "returnObj":{ "total":1, "list":[{ "securityGroupOid":"sgdtnc9c4debuzvdy1u59pi", "securityGroupName":"security5gw6", "osSecurityGroupName":"security5gw68863904592908452223", "foreignGroupId":"60a7483e1a124c0badf2b4386e63d5dc", "isRelStrategy":false, "remark":"xxxxx", "createDate":1743040622000, "updateDate":1743040622000 }] } } 状态码 请参考 状态码 错误码 请参考 错误码

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

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

参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID rg1234567890abcdef1234567890abcd imageName 否 String 镜像名称 centos7.9 status 否 String 镜像状态。可选值：Sharing共享中，Shared已共享，Pending待接受共享，Declined拒绝共享 Sharing pageNum 否 Integer 页码，默认1 1 pageSize 否 Integer 每页数量，默认10 10

接口功能介绍 删除QOSv3 接口约束 无 URI POST /v3/qos/delete 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 qosOid 是 String qos id 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj String 返回数据结构体。 xxx 枚举参数 无 请求示例 请求url 请求头header 无 请求体body { "qosOid":"sqsxxx" } 响应示例 { "statusCode":800, "message":"OK.", "returnObj":"xxx" } 状态码 请参考 状态码 错误码 请参考 错误码

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

接口功能介绍 查询VIP详情v3 接口约束 无 URI GET /v3/vip/detail 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx vipOid 是 String vip id 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据对象 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 vipOid String vip id vipIpAddress String vip地址 networkId String vpc的uuid subnetOid String 子网id subnetId String 子网uuid vipPortId String vip的uuid 枚举参数 无 请求示例 请求url 请求头header 无 请求体body 无 响应示例 { "statusCode":800, "message":"OK.", "returnObj":{ "vipOid":"vipxxyrk3utggvmmyeiunfic", "vipIpAddress":"192.168.1.82", "networkId":"86bf2cd69e00446883a004327b716a07", "subnetOid":"snxxbfzimdno1l00k9a5yk4", "subnetId":"b6deaadd0b334422aef00dceba639541", "vipPortId":"70744a96d32041008c789fd1ae1c1539" } }

参数 是否必填 参数类型 说明 示例 下级对象 qosOid 是 String qos id qosName 是 String qos名称，不能为空 upBandwidth 否 Integer 上行带宽控制，单位Mbit/s，不传该参数代表不设置限制 downBandwidth 否 Integer 下行带宽控制，单位Mbit/s，不传该参数代表不设置限制 maxburst 否 Integer 最大突发值，单位Mbit/s，不传该参数代表不设置限制 remark 否 String 描述

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

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

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

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

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

请求示例 请求url 无 请求头header 无 请求体body { "desktopPoolOid":"dpxx", "keepDuration":33, "afterReleaseAction":null, "rebuildAfterStopOrReboot":null } 响应示例 { "statusCode":800, "message":"OK.", "returnObj":{ } } 状态码 请参考 状态码 错误码 请参考 错误码

接口功能介绍 并发桌面池功能请联系客户经理开通。 接口约束 无 URI GET /v3/concurrentDesktopPool/describeUsers 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 desktopPoolOid 是 String 并发桌面池ID dpw8djg4dwv35w4c19o932g orgOid 否 String 用户归属部门ID，默认为根部门 null querySubOrg 否 Boolean 是否包含下级部门，默认为是 true pageNum 否 Integer 页码，默认1 1 pageSize 否 Integer 每页数量，默认10，最大100 10 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据对象 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 total Long 总记录数 1 list Array of Objects 数据列表 list 表 list 参数 参数类型 说明 示例 下级对象 pubUserOid String 用户ID upgao6ve5mlakw01xk1c2no5 userName String 用户名 xindyh loginAccount String 登录账户 xindyh

接口功能介绍 快照策略功能请联系客户经理开通。 接口约束 无 URI POST /v3/snapshotPolicy/delete 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 snapshotPolicyOid 是 String 快照策略ID。 sspgg7576hc59fkph1b3xe4y 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 ok returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"snapshotPolicyOid":"sspxxx"} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }} 状态码 请参考 状态码 错误码 请参考 错误码

参数 是否必填 参数类型 说明 示例 下级对象 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

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

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

接口功能介绍 快照策略功能请联系客户经理开通。 接口约束 无 URI GET /v3/snapshotPolicy/list 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 snapshotPolicyName 否 String 快照策略名称 测oName1005 pageNum 否 Integer 页码，至少1，默认1 1 pageSize 否 Integer 每页数量，最大100，默认10 10 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1025 message String 提示信息。 ok returnObj Object 返回数据对象 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 total Long 总记录数 5 list Array of Objects 数据列表 list 表 list 参数 参数类型 说明 示例 下级对象 snapshotPolicyOid String 快照策略ID。 sspgg7576hc59fkph1b3xe4y snapshotPolicyName String 名称。 测oName1005 description String 描述。 createTime String 创建时间。以ISO 8601为标准，并使用UTC+0时间，格式为yyyyMMddTHH:mm:ssZ。 20230927T10:08:11Z

枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body {"vpcOid":"vpcFooId","subnetName":"fooName","cidr":"192.168.0.0/24","gatewayIp":"192.168.0.1","dnsList":["114.114.114.114"]} 响应示例 {"statusCode":800,"message":"OK.","returnObj":{ }} 状态码 请参考 状态码 错误码 请参考 错误码

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