接口功能介绍 假设endTime代表前一天23点59分59秒（UTC+8），时间范围相关说明如下： 可供查询的数据时间范围是：[endTime 180 天, endTime]。 startTime的默认值是：endTime 30天。 endTime的默认值是：endTime。 startTime和endTime与连接时间的关系：startTime < startConnectTime，startConnectTime < endTime。 考虑到存在延迟，如需要完整导出某天的连接会话记录，建议延后至少24小时进行导出，导出时指定时间范围（UTF+8）：[此天0点, 此天23点59分59秒]。 单次查询的时间间距不可超过30天。 接口约束 无 URI GET /v3/statistic/describeDesktopConnectLog 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx pubUserOids 否 String 用户ID。取值由用户ID组成一个JSON数组，最多支持10个ID，ID之间用半角逗号（,）隔开。 startTime 否 String 起始时间。支持2种格式：秒级UNIX时间戳；以ISO 8601为标准，并使用UTC+0时间，格式为yyyyMMddTHH:mm:ssZ。 1700642186 endTime 否 String 结束时间。支持2种格式：秒级UNIX时间戳；以ISO 8601为标准，并使用UTC+0时间，格式为yyyyMMddTHH:mm:ssZ。 20231122T16:36:29Z limit 否 Integer 返回最大记录数。取值范围：[1, 100]。默认值：10。 10 cursor 否 String 游标。指定为上一个请求返回的nextCursor，获取下一页，达到翻页效果。未设置时默认返回首页数据。 ZWNwYzpudW1iZXI6MQ

错误码 请参考 错误码

参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx flavorType 是 String 主机规格类型。枚举值范围：[Common通用型, GpuGPU型, Hpn高性能网络型, Kp鲲鹏, Hg海光] forSysDisk 否 Boolean 是否用于系统盘。true则返回系统盘可用磁盘类型，false则返回数据盘可用磁盘类型。默认为true。

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

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

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

枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body { "resourcePackOid":"xxxvnbdImi5", "count":1, "band":{ "bandName":"bandwidth7zfp", "bandWidth":5 } } 响应示例 { "statusCode":800, "message":"OK.", "returnObj":{ "operationIds":["joborderijt76wqheisnidifibaf1","orderxxxxx"] } } 状态码 请参考 状态码 错误码 请参考 错误码

接口功能介绍 查询计算增强型云电脑镜像列表v3 接口约束 无 URI GET /v3/ecs/describeMirror 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx mirrorType 是 String 镜像类型。枚举值范围：[PUBLIC：公共镜像，PRIVATE：自定义镜像，SHARED：共享镜像] flavorType 是 String 主机规格类型。枚举值范围：[Common通用型, GpuGPU型, Hpn高性能网络型, Kp鲲鹏, Hg海光] billMode 否 String 计费方式。枚举值[ResBag资源包，Cycle包月计费]，默认为ResBag. 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Array of Objects 返回数据对象 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 imageOid String 镜像ID imageName String 镜像名称 osName String 操作系统名称 osType String 操作系统类型（Windows;Linux） platform String 操作系统平台（Windows;Centos;Ubuntu;UOS;Kylin银河麒麟;NeoKylin中标麒麟） gpuType Integer GPU类型[0:非GPU，1:GPU类型] mirrorType String 镜像类型[PUBLIC：公共镜像，PRIVATE：自定义镜像，SHARED：共享镜像] osBits String 操作系统位数 （32，64） sysDisk Object 系统盘相关信息 sysDisk 表 sysDisk 参数 参数类型 说明 示例 下级对象 diskSize Integer 盘大小（单位：GB）

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

参数 是否必填 参数类型 说明 示例 下级对象 resourcePackOid 是 String 资源包ID fipOid 是 String 弹性IP ID band 是 Object 带宽信息 band

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

接口功能介绍 分配基础策略给桌面。 接口约束 无 URI POST /v3/strategy/allocStrategyDesktop 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 strategyOid 是 String 待分配的基础策略Oid。 desktopOidList 是 Array of Strings 分配桌面Oid列表。可设置一个或多个，最多10个。 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 请求头header 无 请求体body { "strategyOid":"dsyxxxxxx", "desktopOidList":["Dxxxxxxx","Dxxxxxxx"] } 响应示例 { "statusCode":800, "message":"OK.", "returnObj":true } 状态码 请参考 状态码

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

参数 参数类型 说明 示例 下级对象 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。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

枚举参数 无 请求示例 请求url 请求头header 无 请求体body 无 响应示例 { "statusCode":800, "message":"OK.", "returnObj":{ "total":1, "list":[{ "vipOid":"vipxxyrk3utggvmmyeiunfic", "vipIpAddress":"192.168.1.82", "vpcOid":"vpcks38av7mklcehgu674ead", "networkId":"86bf2cd69e00446883a004327b716a07", "vpcName":"vpctest1", "subnetId":"b6deaadd0b334422aef00dceba639541", "subnetName":"subnettest", "cidr":"192.168.1.0/24", "status":1 }] } } 状态码 请参考 状态码 错误码 请参考 错误码

接口功能介绍 获取租户在物理池下可创建的vpc个数v3 接口约束 无 URI GET /v3/vpc/getTenantRegionVpcNum 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据对象 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 maximum Integer 最大可创建数量 available Integer 剩余可创建数量 枚举参数 无 请求示例 请求url 请求头header 无 请求体body 无 响应示例 { "statusCode":800, "message":"OK.", "returnObj":{ "maximum":254, "available":3 } } 状态码 请参考 状态码 错误码 请参考 错误码

接口功能介绍 查询可绑定VIP的弹性IP列表v3 接口约束 无 URI GET /v3/vip/canBindFip 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx floatingIpAddress 否 String 弹性ip地址 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 floatingIpAddress String 弹性ip地址 枚举参数 无 请求示例 请求url 请求头header 无 请求体body 无

参数 是否必填 参数类型 说明 示例 下级对象 vpcOid 是 String vpc id subvpcOid 是 String 子网id

参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 subnetOid 是 String 子网 ID ipAddr 否 String IP地址 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

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

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

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

参数 是否必填 参数类型 说明 示例 下级对象 vipOid 是 String vip id fipOid 是 String 弹性ip id

参数 是否必填 参数类型 说明 示例 下级对象 vipOid 是 String vip id fipOid 是 String 弹性ip id

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

参数 参数类型 说明 示例 下级对象 peeringOid String 对等连接id peeringName String 对等连接名称 status Integer 状态，0已删除，1待接受，2已接受，3已拒绝，4待处理，5创建中，6删除中，7激活，8错误，9隐藏 vpcOid String 本端vpc id vpcName String 本端vpc名称 vpcCidr String 本端vpc网段 acceptVpcOid String 对端vpc id acceptVpcName String 对端vpc名称 acceptVpcCidr String 对端vpc网段 acceptAccountType Integer 对端用户类型，[0：未知，1：当前账户，2：其他账户] regionOid String 资源池oid acceptRegionUuid String 对端资源池uuid

参数 是否必填 参数类型 说明 示例 下级对象 peeringOid 是 String 对等连接id peeringName 是 String 对等连接名称

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

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

参数 参数类型 说明 示例 下级对象 total Long 总记录数 list Array of Objects 数据列表 list