VMOSCloud OpenAPI 3.1 规范
本文档提供 VMOSCloud OpenAPI 3.1 规范文件，供 AI 助手、大模型、代码生成工具及自动化脚本使用。规范内容与本站《接口文档》OpenAPI.md 完全一致，仅格式为机器可读的 OpenAPI 描述。
📥 下载 OpenAPI 规范文件 — 适合 Postman、Swagger Editor、AI 工具等直接导入
获取方式：
- 浏览器下载：点击此处下载 openapi.yaml，或访问：
https://cloud.vmoscloud.com/vmoscloud/doc/zh/server/openapi.yaml
若浏览器直接打开而非下载，可右键链接选择「另存为」。 - 命令行获取：
curl https://cloud.vmoscloud.com/vmoscloud/doc/zh/server/openapi.yaml -o vmoscloud-openapi.yaml - 直接引用：在 Postman、Swagger Editor、AI 等工具中使用上述 URL 直接导入
规范全文
以下为 OpenAPI 3.1 规范全文，可直接在本页复制使用，或通过上方链接下载文件。
openapi: 3.1.0
info:
title: VMOSCloud OpenAPI
description: |
VMOSCloud 服务端 OpenAPI 规范，供 AI/大模型/代码助手及自动化工具消费。
接口描述、请求/响应参数与业务语义以本站《接口文档》OpenAPI.md 为准；
认证与签名详见使用指南 example.md。
version: "1.0.0"
servers:
- url: https://api.vmoscloud.com
description: VMOSCloud API 服务器
security:
- VMOSCloudHMAC: []
tags:
- name: 实例管理
- name: 资源管理
- name: 应用管理
- name: 任务管理
- name: 云手机管理
- name: 邮箱接码服务
- name: 动态代理服务
- name: 静态住宅代理服务
- name: 流程自动化（RPA）
- name: 真机测试
- name: SDK Token
- name: 云号码服务
- name: 社媒账号服务
paths:
/vcpcloud/api/padApi/setWifiList:
post:
tags:
- 实例管理
summary: 修改实例WIFI属性
operationId: vcpcloud_api_padApi_setWifiList_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCodes
- wifiJsonList
- SSID
- BSSID
- MAC
- IP
- gateway
- DNS1
- DNS2
properties:
padCodes:
type: array
items:
type: string
description: 实例编号
wifiJsonList:
type: array
items:
type: string
description: wifi属性列表
SSID:
type: string
description: wifi名称 (不支持中文)
BSSID:
type: string
description: 接入点mac地址
MAC:
type: string
description: wifi网卡mac地址
IP:
type: string
description: wifi网络IP
gateway:
type: string
description: wifi网关
DNS1:
type: string
description: DNS1
DNS2:
type: string
description: DNS2
hessid:
type: integer
description: 网络标识符
anqpDomainId:
type: integer
description: ANQP（Access Network Query Protocol）域ID
capabilities:
type: string
description: WPA/WPA2等信息
level:
type: integer
description: 信号强度（RSSI）
linkSpeed:
type: integer
description: 当前Wi-Fi连接速率
txLinkSpeed:
type: integer
description: 上传链路速度
rxLinkSpeed:
type: integer
description: 下载链路速度
frequency:
type: integer
description: Wi-Fi信道频率
distance:
type: integer
description: 估算的AP距离
distanceSd:
type: integer
description: 估算距离的标准差
channelWidth:
type: integer
description: 信道带宽
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/padDetails:
post:
tags:
- 实例管理
summary: 实例详情(待上线)
operationId: vcpcloud_api_padApi_padDetails_post
requestBody:
content:
application/json:
schema:
type: object
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/restart:
post:
tags:
- 实例管理
summary: 实例重启
operationId: vcpcloud_api_padApi_restart_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCodes
properties:
padCodes:
type: array
items:
type: string
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
taskId:
type: integer
description: 任务ID
padCode:
type: string
description: 实例编号
vmStatus:
type: integer
description: 实例在线状态（0：离线；1：在线）
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/reset:
post:
tags:
- 实例管理
summary: 实例重置
operationId: vcpcloud_api_padApi_reset_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCodes
properties:
padCodes:
type: array
items:
type: string
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
taskId:
type: integer
description: 任务ID
padCode:
type: string
description: 实例编号
vmStatus:
type: integer
description: 实例在线状态（0：离线；1：在线）
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/padProperties:
post:
tags:
- 实例管理
summary: 查询实例属性
operationId: vcpcloud_api_padApi_padProperties_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCode
properties:
padCode:
type: string
description: 实例编号
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
padCode:
type: string
description: 实例编号
modemPropertiesList:
type: array
items:
type: object
description: Modem-属性列表
propertiesName:
type: string
description: 属性名称
propertiesValue:
type: string
description: 属性值
systemPropertiesList:
type: array
items:
type: object
description: 系统-属性列表
settingPropertiesList:
type: array
items:
type: object
description: setting-属性列表
oaidPropertiesList:
type: array
items:
type: object
description: oaid-属性列表
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/batchPadProperties:
post:
tags:
- 实例管理
summary: 批量查询实例属性
operationId: vcpcloud_api_padApi_batchPadProperties_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCodes
properties:
padCodes:
type: array
items:
type: string
description: 实例数量不多余200个
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
padCode:
type: string
description: 实例编号
modemPropertiesList:
type: array
items:
type: object
description: Modem-属性列表
propertiesName:
type: string
description: 属性名称
propertiesValue:
type: string
description: 属性值
systemPropertiesList:
type: array
items:
type: object
description: 系统-属性列表
settingPropertiesList:
type: array
items:
type: object
description: setting-属性列表
oaidPropertiesList:
type: array
items:
type: object
description: oaid-属性列表
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/updatePadProperties:
post:
tags:
- 实例管理
summary: 修改实例属性(动态生效)
operationId: vcpcloud_api_padApi_updatePadProperties_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCodes
properties:
padCodes:
type: array
items:
type: string
modemPersistPropertiesList:
type: array
items:
type: string
description: Modem-持久化-属性列表
propertiesName:
type: string
description: 属性名称
propertiesValue:
type: string
description: 属性值
modemPropertiesList:
type: array
items:
type: string
description: Modem-非持久化-属性列表
systemPersistPropertiesList:
type: array
items:
type: string
description: 系统-持久化-属性列表
systemPropertiesList:
type: array
items:
type: string
description: 系统-非持久化-属性列表
settingPropertiesList:
type: array
items:
type: string
description: setting-属性列表
oaidPropertiesList:
type: array
items:
type: string
description: oaid-属性列表
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
taskId:
type: integer
description: 任务ID
padCode:
type: string
description: 实例编号
vmStatus:
type: integer
description: 实例在线状态（0：离线；1：在线）
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/updatePadAndroidProp:
post:
tags:
- 实例管理
summary: 修改实例安卓改机属性(需重启)
operationId: vcpcloud_api_padApi_updatePadAndroidProp_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- props
- ro.product.vendor.name
properties:
padCode:
type: string
description: 实例id
restart:
type: boolean
description: 设置完成后自动重启（默认false）
props:
type: object
description: 系统属性（此字段为key-value定义）
ro.product.vendor.name:
type: string
description: 属性设置
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
taskId:
type: integer
description: 任务id
padCode:
type: string
description: 实例id
taskStatus:
type: integer
description: 任务状态（-1：任务已存在，请勿重复提交；1：任务已添加）
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/updateSIM:
post:
tags:
- 实例管理
summary: 根据国家Code修改SIM卡信息
operationId: vcpcloud_api_padApi_updateSIM_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCode
properties:
padCode:
type: string
description: 实例id
countryCode:
type: string
description: 国家code
props:
type: object
description: 系统属性（此字段为key-value定义）
ro.product.vendor.name:
type: string
description: 属性设置
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
traceId:
type: string
description: 链路追踪ID
taskId:
type: integer
description: 任务ID
padCode:
type: string
description: 实例编号
vmStatus:
type: integer
description: 实例在线状态（0：离线；1：在线）
taskStatus:
type: integer
description: 任务状态（-1：任务已存在，请勿重复提交；1：任务已添加）
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/updateSIMByCountryAndPhone:
post:
tags:
- 实例管理
summary: 按国家和手机号修改SIM卡信息
operationId: vcpcloud_api_padApi_updateSIMByCountryAndPhone_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCode
- countryCode
- phoneNumber
properties:
padCode:
type: string
description: 实例编号
countryCode:
type: string
description: 两位国家码
phoneNumber:
type: string
description: 6～15位数字，可带加号
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
taskId:
type: string
description: 任务ID
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/dissolveRoom:
post:
tags:
- 实例管理
summary: 停止推流
operationId: vcpcloud_api_padApi_dissolveRoom_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCodes
properties:
padCodes:
type: array
items:
type: string
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
traceId:
type: string
description: 链路追踪ID
successList:
type: array
items:
type: object
description: 成功集合
padCode:
type: string
description: 实例编号
failList:
type: array
items:
type: object
description: 失败集合
errorCode:
type: integer
description: 错误码
errorMsg:
type: string
description: 失败的原因
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/checkIP:
post:
tags:
- 实例管理
summary: 智能IP代理检测
operationId: vcpcloud_api_padApi_checkIP_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- host
- port
- account
- password
- type
properties:
host:
type: string
description: 代理信息 (ip或host)
port:
type: integer
description: 代理端口 (数字类型)
account:
type: string
description: 代理用户名
password:
type: string
description: 代理密码
type:
type: string
description: 代理协议类型 Socks5、 http、https
country:
type: string
description: "国家-强行指定时必填 - 参数请参考：curl -x http://用户名:密码@ip:端口 https://ipinfo.io?token=注册就有的token 当使用了强行指定后，系统会直接使用指"
ip:
type: string
description: ip-强行指定时必填
loc:
type: string
description: 经，纬度-强行指定时必填
city:
type: string
description: 城市-强行指定时必填
region:
type: string
description: 地区-强行指定时必填
timezone:
type: string
description: 时区-强行指定时必填
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
proxyLocation:
type: string
description: 归属地
publicIp:
type: string
description: 出口IP
proxyWorking:
type: boolean
description: 检测成功-true 检测失败-false
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/smartIp:
post:
tags:
- 实例管理
summary: 设置智能IP
operationId: vcpcloud_api_padApi_smartIp_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCodes
- host
- port
- account
- password
- type
- mode
properties:
padCodes:
type: array
items:
type: string
host:
type: string
description: 代理信息 (ip或host)
port:
type: integer
description: 代理端口 (数字类型)
account:
type: string
description: 代理用户名
password:
type: string
description: 代理密码
type:
type: string
description: 代理协议类型 socks5、 http、https
mode:
type: string
description: 设置代理的模式 vpn / proxy
bypassPackageList:
type: array
items:
type: string
description: 包名 设置该包名不走代理
bypassIpList:
type: array
items:
type: string
description: ip 设置该ip不走代理
bypassDomainList:
type: array
items:
type: string
description: 域名 设置该域名不走代理
followLanguage:
type: boolean
description: 是否跟随代理IP自动切换云机语言
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/notSmartIp:
post:
tags:
- 实例管理
summary: 取消智能IP
operationId: vcpcloud_api_padApi_notSmartIp_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCodes
properties:
padCodes:
type: array
items:
type: string
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/getTaskStatus:
post:
tags:
- 实例管理
summary: 设备任务执行结果查询(智能IP)
operationId: vcpcloud_api_padApi_getTaskStatus_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- taskId
properties:
taskId:
type: string
description: 任务ID
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
padCode:
type: string
description: 实例编号
taskStatus:
type: string
description: 任务状态：Executing-执行中 Successfully-已成功 Failed-已失败 Timedout-已超时
taskType:
type: integer
description: 任务类型：10010-设置智能IP 10011-取消智能IP
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/getListInstalledApp:
post:
tags:
- 实例管理
summary: 获取指定云机安装的应用信息
operationId: vcpcloud_api_padApi_getListInstalledApp_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCodeList
properties:
padCodeList:
type: array
items:
type: string
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
appName:
type: string
description: APP名称
packageName:
type: string
description: APP包名
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/updateTimeZone:
post:
tags:
- 实例管理
summary: 修改实例时区
operationId: vcpcloud_api_padApi_updateTimeZone_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- timeZone
- padCodes
properties:
timeZone:
type: string
description: UTC标准时间
padCodes:
type: array
items:
type: string
description: 实例列表
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
traceId:
type: string
description: 链路追踪ID
taskId:
type: integer
description: 任务ID
padCode:
type: string
description: 房间号
vmStatus:
type: integer
description: 实例在线状态（0：离线；1：在线）
taskStatus:
type: integer
description: 任务状态（-1：任务已存在，请勿重复提交；1：任务已添加）
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/updateLanguage:
post:
tags:
- 实例管理
summary: 修改实例语言
operationId: vcpcloud_api_padApi_updateLanguage_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- language
- padCodes
properties:
language:
type: string
description: 语言
country:
type: string
description: 国家
padCodes:
type: array
items:
type: string
description: 实例列表
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
traceId:
type: string
description: 链路追踪ID
taskId:
type: integer
description: 任务ID
padCode:
type: string
description: 房间号
vmStatus:
type: integer
description: 实例在线状态（0：离线；1：在线）
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/gpsInjectInfo:
post:
tags:
- 实例管理
summary: 设置实例经纬度
operationId: vcpcloud_api_padApi_gpsInjectInfo_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- longitude
- latitude
- padCodes
properties:
longitude:
type: string
description: 经度
latitude:
type: string
description: 纬度
altitude:
type: string
description: 海拔 (需要更新到最新镜像)
speed:
type: string
description: 速度，m/s (20251024之后的镜像)
bearing:
type: string
description: 速度方向，° (20251024之后的镜像)
horizontalAccuracyMeters:
type: string
description: 水平精度 (20251024之后的镜像)
padCodes:
type: array
items:
type: string
description: 实例列表
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
traceId:
type: string
description: 链路追踪ID
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/open/network/proxy/info:
post:
tags:
- 实例管理
summary: 查询实例代理信息(待上线)
operationId: vcpcloud_open_network_proxy_info_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCodes
properties:
padCodes:
type: array
items:
type: string
description: 实例列表
padCode:
type: string
description: 实例编号
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
traceId:
type: string
description: 链路追踪ID
taskId:
type: integer
description: 任务ID
padCode:
type: string
description: 房间号
vmStatus:
type: integer
description: 实例在线状态（0：离线；1：在线）
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/replacePad:
post:
tags:
- 实例管理
summary: 一键新机
operationId: vcpcloud_api_padApi_replacePad_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCodes
properties:
padCodes:
type: array
items:
type: string
description: 实例id列表
countryCode:
type: string
description: "国家编码(具体查看:https://chahuo.com/country-code-lookup.html)"
realPhoneTemplateId:
type: integer
description: "模板id参考 [分页获取真机模板](https://cloud.vmoscloud.com/vmoscloud/doc/zh/server/OpenAPI.html#分页获取真机模板)"
androidProp:
type: object
description: "参考 [安卓改机属性列表](https://cloud.vmoscloud.com/vmoscloud/doc/zh/server/InstanceAndroidPropList.html)"
replacementRealAdiFlag:
type: boolean
description: 真机是否随机adi模板(false 不随机 true 随机)
excludeRealPhoneTemplateIds:
type: integer
items:
type: string
description: 随机ADI模板时需排除的模板ID列表
certificate:
type: string
description: 手机根证书
wipeData:
type: boolean
description: 是否清除用户数据，默认true(CBS2.4.4以上版本支持)
wipeSpecificData:
type: array
items:
type: string
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
traceId:
type: string
description: 链路追踪ID
taskId:
type: integer
description: 任务ID
padCode:
type: string
description: 实例编号
vmStatus:
type: integer
description: 实例在线状态（0：离线；1：在线）
taskStatus:
type: integer
description: 任务状态（-1：任务已存在，请勿重复提交；1：任务已添加）
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/country:
get:
tags:
- 实例管理
summary: 查询一键新机支持国家列表
operationId: vcpcloud_api_padApi_country_get
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/webview/version/list:
post:
tags:
- 实例管理
summary: 查询可用WebView版本
operationId: vcpcloud_api_padApi_webview_version_list_post
requestBody:
content:
application/json:
schema:
type: object
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
traceId:
type: string
description: 链路追踪ID
id:
type: integer
description: 版本ID
version:
type: string
description: WebView版本号
ossUrl:
type: string
description: 安装包下载地址
fileMd5:
type: string
description: 安装包文件MD5
description:
type: string
description: 版本说明
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/updateContacts:
post:
tags:
- 实例管理
summary: 更新通讯录
operationId: vcpcloud_api_padApi_updateContacts_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCodes
properties:
padCodes:
type: array
items:
type: string
description: 实例id列表
fileUniqueId:
type: string
description: 通讯录文件ID
operateType:
type: integer
description: -1 新增联系人 0 删除联系人 1 覆盖联系人 ,默认为-1
info:
type: array
items:
type: string
description: 通讯录信息
firstName:
type: string
description: 姓名
phone:
type: string
description: 手机号
email:
type: string
description: 邮箱
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
traceId:
type: string
description: 链路追踪ID
taskId:
type: integer
description: 任务ID
padCode:
type: string
description: 实例编号
taskStatus:
type: integer
description: 任务状态（-1：任务已存在，请勿重复提交；1：任务已添加）
vmStatus:
type: integer
description: 实例在线状态（0：离线；1：在线）
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/setProxy:
post:
tags:
- 实例管理
summary: 实例设置代理
operationId: vcpcloud_api_padApi_setProxy_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- enable
- padCodes
properties:
account:
type: string
description: 账号
password:
type: string
description: 密码
ip:
type: string
description: IP
port:
type: integer
description: 端口
enable:
type: boolean
description: 启用
padCodes:
type: array
items:
type: string
description: 实例列表
proxyType:
type: string
description: 支持参数：proxy、vpn
proxyName:
type: string
description: 支持参数：socks5、http-relay(包含http、https)
model:
type: string
description: 名单生效模式：bypass(默认)/limit
bypassPackageList:
type: array
items:
type: string
description: 包名，设置后不走代理（model=bypass）
bypassIpList:
type: array
items:
type: string
description: IP，设置后不走代理（model=bypass）
bypassDomainList:
type: array
items:
type: string
description: 域名，设置后不走代理（model=bypass）
limitPackageList:
type: array
items:
type: string
description: 包名，仅其走代理（model=limit）
limitIpList:
type: array
items:
type: string
description: IP，仅其走代理（model=limit）
limitDomainList:
type: array
items:
type: string
description: 域名，仅其走代理（model=limit）
sUoT:
type: boolean
description: 是否开启udp连接 默认为false
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
traceId:
type: string
description: 链路追踪ID
taskId:
type: integer
description: 任务ID
padCode:
type: string
description: 房间号
vmStatus:
type: integer
description: 实例在线状态（0：离线；1：在线）
taskStatus:
type: integer
description: 任务状态（-1：任务已存在，请勿重复提交；1：任务已添加）
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/listInstalledApp:
post:
tags:
- 实例管理
summary: 实时查询已安装的应用列表
operationId: vcpcloud_api_padApi_listInstalledApp_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCodes
properties:
padCodes:
type: array
items:
type: string
description: 实例编号
appName:
type: string
description: 应用名称
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
traceId:
type: string
description: 链路追踪ID
padCode:
type: string
description: 实例编号
apps:
type: array
items:
type: object
description: 应用集合
appName:
type: string
description: 应用名称
packageName:
type: string
description: 包名
versionCode:
type: string
description: 版本号
versionName:
type: string
description: 版本名称
appState:
type: integer
description: 0 已完成 1安装中 2下载中
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/setKeepAliveApp:
post:
tags:
- 实例管理
summary: 设置应用自启动
operationId: vcpcloud_api_padApi_setKeepAliveApp_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- applyAllInstances
- serverName
properties:
padCodes:
type: array
items:
type: string
description: 实例编号
applyAllInstances:
type: boolean
description: 是否应用所有实例模式
appInfos:
type: array
items:
type: string
serverName:
type: string
description: com.xxx.xxx（包名）/com.xxx.xxx.service.DomeService (需要启动的服务完整路径)
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/setHideAppList:
post:
tags:
- 实例管理
summary: 设置应用隐藏(待上线)
operationId: vcpcloud_api_padApi_setHideAppList_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCodes
- appInfos
- packageName
properties:
padCodes:
type: array
items:
type: string
appInfos:
type: array
items:
type: string
packageName:
type: string
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/replaceRealAdiTemplate:
post:
tags:
- 实例管理
summary: 修改真机ADI模板
operationId: vcpcloud_api_padApi_replaceRealAdiTemplate_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCodes
- wipeData
- realPhoneTemplateId
properties:
padCodes:
type: array
items:
type: string
wipeData:
type: boolean
description: 是否清除数据
realPhoneTemplateId:
type: integer
description: 云真机模板id
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
taskId:
type: integer
description: 任务ID
padCode:
type: string
description: 实例编号
vmStatus:
type: integer
description: 实例在线状态（0：离线；1：在线）
taskStatus:
type: integer
description: 任务状态（-1：任务已存在，请勿重复提交；1：任务已添加）
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/asyncCmd:
post:
tags:
- 实例管理
summary: 异步执行ADB命令
operationId: vcpcloud_api_padApi_asyncCmd_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCodes
- scriptContent
properties:
padCodes:
type: array
items:
type: string
scriptContent:
type: string
description: ADB命令，多条命令使用分号隔开
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
traceId:
type: string
description: 链路追踪ID
taskId:
type: integer
description: 任务ID
padCode:
type: string
description: 实例编号
vmStatus:
type: integer
description: 实例在线状态（0：离线；1：在线）
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/enableSmsSendCallback:
post:
tags:
- 实例管理
summary: 开启外发短信回调
operationId: vcpcloud_api_padApi_enableSmsSendCallback_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCodes
properties:
padCodes:
type: array
items:
type: string
description: 实例编号列表
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
traceId:
type: string
description: 链路追踪ID
taskId:
type: integer
description: 任务ID
padCode:
type: string
description: 实例编号
vmStatus:
type: integer
description: 实例在线状态（0：离线；1：在线）
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/switchRoot:
post:
tags:
- 实例管理
summary: 开关Root权限
operationId: vcpcloud_api_padApi_switchRoot_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCodes
- rootStatus
properties:
padCodes:
type: array
items:
type: string
globalRoot:
type: boolean
description: 是否开启全局root权限，默认不开启
packageName:
type: string
description: 应用包名(非全局root必传)多个包名通过,连接
rootStatus:
type: integer
description: root状态，0：关闭 1：开启
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
taskId:
type: integer
description: 任务ID
padCode:
type: string
description: 实例编号
vmStatus:
type: integer
description: 实例在线状态（0：离线；1：在线）
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/screenshot:
post:
tags:
- 实例管理
summary: 本地截图
operationId: vcpcloud_api_padApi_screenshot_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCodes
- rotation
properties:
padCodes:
type: array
items:
type: string
rotation:
type: integer
description: 截图画面横竖屏旋：0：截图方向不做处理，默认；1：截图画面旋转为竖屏时：a：手机竖屏的截图，不做处理。b：手机横屏的截图，截图顺时针旋转90度。
broadcast:
type: boolean
description: 事件是否广播(默认false)
definition:
type: integer
description: 清晰度 取值范围0-100
resolutionHeight:
type: integer
description: 分辨率 - 高 大于1
resolutionWidth:
type: integer
description: 分辨率 - 宽 大于1
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
taskId:
type: integer
description: 否
padCode:
type: string
description: 否
vmStatus:
type: integer
description: 是
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/getLongGenerateUrl:
post:
tags:
- 实例管理
summary: 获取实例实时预览图片
operationId: vcpcloud_api_padApi_getLongGenerateUrl_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCodes
properties:
padCodes:
type: array
items:
type: string
description: 实例列表
format:
type: string
description: 图片格式，枚举值：png、jpg，默认png， png格式不支持压缩
height:
type: string
description: 缩放高度（像素，不传则保持原始比例） 不填默认使用云机分辨率
width:
type: string
description: 缩放宽度（像素，不传则保持原始比例） 不填默认使用云机分辨率
quality:
type: integer
description: 图片质量（百分比：0~100，不传则为50%) 经测试低于60会图片模糊
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
padCode:
type: string
description: 实例编号
url:
type: string
description: 访问地址
expireAt:
type: integer
description: URL到期时间（毫秒时间戳）
success:
type: boolean
description: 是否成功生成URL
reason:
type: string
description: 失败原因（成功时为空）
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/upgradeImage:
post:
tags:
- 实例管理
summary: 升级镜像
operationId: vcpcloud_api_padApi_upgradeImage_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCodes
- imageId
- wipeData
properties:
padCodes:
type: array
items:
type: string
imageId:
type: string
description: 镜像ID
wipeData:
type: boolean
description: 是否清除实例数据(data分区), true清除，false不清除
enableCpuCoreConfig:
type: boolean
description: 是否启用CPU大小核配置，本功能基于 Android cpuset 机制，为云手机物理机上的多个容器提供静态错峰的 CPU 资源分配方案。通过精细化划分大小核（Little/Big Cores）资源，
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
traceId:
type: string
description: 链路追踪ID
padCode:
type: string
description: 实例编号
taskId:
type: integer
description: 任务ID
errorMsg:
type: string
description: 错误信息
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/virtualRealSwitch:
post:
tags:
- 实例管理
summary: 升级真机镜像
operationId: vcpcloud_api_padApi_virtualRealSwitch_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCodes
- imageId
- wipeData
- upgradeImageConvertType
properties:
padCodes:
type: array
items:
type: string
imageId:
type: string
description: 镜像ID
wipeData:
type: boolean
description: 是否清除实例数据(data分区), true清除，false不清除
realPhoneTemplateId:
type: integer
description: 真机模板ID upgradeImageConvertType=real时必填
upgradeImageConvertType:
type: string
description: 转换镜像类型 virtual：虚拟机 real：云真机
screenLayoutId:
type: integer
description: 屏幕布局ID upgradeImageConvertType=virtual时必填
certificate:
type: string
description: 自定义手机根证书
deviceAndroidProps:
type: object
description: "安卓属性配置，参考 [安卓改机属性列表](https://cloud.vmoscloud.com/vmoscloud/doc/zh/server/InstanceAndroidPropList.htm"
enableCpuCoreConfig:
type: boolean
description: 是否启用CPU大小核配置，本功能基于 Android cpuset 机制，为云手机物理机上的多个容器提供静态错峰的 CPU 资源分配方案。通过精细化划分大小核（Little/Big Cores）资源，
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
traceId:
type: string
description: 链路追踪ID
padCode:
type: string
description: 实例编号
taskId:
type: integer
description: 任务ID
errorMsg:
type: string
description: 错误信息
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/userTemplateList:
post:
tags:
- 实例管理
summary: 查询个人上传模板
operationId: vcpcloud_api_padApi_userTemplateList_post
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/UserTemplateQueryRequest"
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
$ref: "#/components/schemas/UserTemplatePage"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/templateList:
post:
tags:
- 实例管理
summary: 分页获取真机模板
operationId: vcpcloud_api_padApi_templateList_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- page
properties:
page:
type: integer
description: 页码 默认1
rows:
type: integer
description: 每页显示数量 默认10 取值范围为1-100
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/modelInfo:
post:
tags:
- 实例管理
summary: 批量获取实例机型信息(待上线)
operationId: vcpcloud_api_padApi_modelInfo_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCodes
properties:
padCodes:
type: array
items:
type: string
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
traceId:
type: string
description: 链路追踪ID
padCode:
type: string
description: 实例编号
imei:
type: string
description: IMEI
serialno:
type: string
description: 序列号
wifimac:
type: string
description: Wi-Fi的mac地址
androidid:
type: string
description: Android实例唯一标识
model:
type: string
description: 型号
brand:
type: string
description: 品牌
manufacturer:
type: string
description: 厂商
isRoot:
type: string
description: 是否是ROOT权限
width:
type: integer
description: 云手机的宽 最大不超过1080
height:
type: integer
description: 云手机的高 最大不超过1920
memoryLimit:
type: integer
description: 内存限额
bluetoothaddr:
type: string
description: 蓝牙地址
phonenum:
type: string
description: 手机号码
romVersion:
type: string
description: 安卓版本
dataSize:
type: integer
description: 内存大小(b)
dataSizeAvailable:
type: integer
description: 剩余可用(b)
dataSizeUsed:
type: string
description: 已使用(b)
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/setSpeed:
post:
tags:
- 实例管理
summary: 设置实例带宽(待上线)
operationId: vcpcloud_api_padApi_setSpeed_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCodes
- upBandwidth
- downBandwidth
properties:
padCodes:
type: array
items:
type: string
upBandwidth:
type: string
description: 上行带宽 Mbps (0：不限制；-1：限制上网)
downBandwidth:
type: string
description: 下行带宽 Mbps (0：不限制；-1：限制上网)
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
traceId:
type: string
description: 链路追踪ID
taskId:
type: integer
description: 任务ID
padCode:
type: string
description: 实例编号
vmStatus:
type: integer
description: 实例在线状态（0：离线；1：在线）
taskStatus:
type: integer
description: 任务状态（-1：任务已存在，请勿重复提交；1：任务已添加）
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/openOnlineAdb:
post:
tags:
- 实例管理
summary: 开启关闭ADB
operationId: vcpcloud_api_padApi_openOnlineAdb_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCodes
- openStatus
properties:
padCodes:
type: array
items:
type: string
description: 实例列表(传入实例数量1-200个)
openStatus:
type: integer
description: 开启关闭ADB状态(1开启 0或者不传默认关闭)
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
taskId:
type: integer
description: 任务id
padCode:
type: string
description: 实例编号
taskStatus:
type: integer
description: 任务状态（-1全失败，-2部分失败，-3取消，-4超时，-5异常，1，等待执行，2执行中，3完成）
taskResult:
type: string
description: 任务结果
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/adb:
post:
tags:
- 实例管理
summary: 获取ADB连接信息
operationId: vcpcloud_api_padApi_adb_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCode
- enable
properties:
padCode:
type: string
description: 实例编号
enable:
type: boolean
description: "ADB 状态 true:开启 false:关闭"
expireMinutes:
type: integer
description: ADB有效期，有效期长1天到7天，单位：分钟，默认1440
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
traceId:
type: string
description: 链路追踪ID
padCode:
type: string
description: 实例编号
command:
type: string
description: SSH 连接指令
expireTime:
type: string
description: adb 链接有效期
enable:
type: boolean
description: "ADB 状态 true:开启 false:关闭"
key:
type: string
description: 连接密钥
adb:
type: string
description: adb连接信息
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/batch/adb:
post:
tags:
- 实例管理
summary: 批量获取ADB连接信息(待上线)
operationId: vcpcloud_api_padApi_batch_adb_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCodes
- enable
properties:
padCodes:
type: array
items:
type: string
description: 实例编号列表，数量上限10个
enable:
type: boolean
description: 是否开启ADB，true为开启并返回连接信息，false为关闭ADB
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
traceId:
type: string
description: 链路追踪ID
successList:
type: array
items:
type: object
description: 批量执行成功的结果列表
failedList:
type: array
items:
type: object
description: 批量执行失败的结果列表
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/simulateTouch:
post:
tags:
- 实例管理
summary: 模拟触控
operationId: vcpcloud_api_padApi_simulateTouch_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCodes
properties:
padCodes:
type: array
items:
type: string
description: 需要触发点击的实例编码
width:
type: integer
description: 容器宽度
height:
type: integer
description: 容器高度
pointCount:
type: integer
description: 多点触控(多个手指点击云机屏幕效果)，默认1，范围1-10，传其他数字均使用默认值
positions:
type: array
items:
type: string
description: 点击坐标组
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
traceId:
type: string
description: 链路追踪ID
padCode:
type: string
description: 实例编号
taskId:
type: integer
description: 任务id
vmStatus:
type: string
description: 实例在线状态
taskStatus:
type: integer
description: 任务状态（-1：任务已存在，请勿重复提交；1：任务已添加）
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/padTaskDetail:
post:
tags:
- 实例管理
summary: 实例操作任务详情
operationId: vcpcloud_api_padApi_padTaskDetail_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- taskIds
- taskId
properties:
taskIds:
type: integer
items:
type: string
taskId:
type: integer
description: 任务ID
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
traceId:
type: string
description: 链路追踪ID
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/executeScriptInfo:
post:
tags:
- 实例管理
summary: 获取实例执行脚本结果(待上线)
operationId: vcpcloud_api_padApi_executeScriptInfo_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- taskIds
properties:
taskIds:
type: integer
description: 必填 数组长度为1-100
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
traceId:
type: string
description: 链路追踪ID
taskId:
type: integer
description: 任务ID
padCode:
type: string
description: 实例编号
taskStatus:
type: integer
description: 任务状态（-1：全失败；-2：部分失败；-3：取消；-4：超时；1：待执行；2：执行中；3：完成）
endTime:
type: integer
description: 任务执行结束时间
taskContent:
type: string
description: 任务内容
taskResult:
type: string
description: 任务结果
errorMsg:
type: string
description: 失败的原因
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/screenshotInfo:
post:
tags:
- 实例管理
summary: 获取实例截图结果(待上线)
operationId: vcpcloud_api_padApi_screenshotInfo_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- taskIds
properties:
taskIds:
type: integer
description: 必填
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
traceId:
type: string
description: 链路追踪ID
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/padExecuteTaskInfo:
post:
tags:
- 实例管理
summary: 实例重启重置执行结果(待上线)
operationId: vcpcloud_api_padApi_padExecuteTaskInfo_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- taskIds
properties:
taskIds:
type: integer
description: 必填
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
traceId:
type: string
description: 链路追踪ID
taskId:
type: integer
description: 任务ID
padCode:
type: string
description: 实例编号
taskStatus:
type: integer
description: 任务状态：（-1：全失败；-2：部分失败；-3：取消；-4：超时；1：待执行；2：执行中；3：完成）
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/infos:
post:
tags:
- 实例管理
summary: 实例分组列表/实例列表信息
operationId: vcpcloud_api_padApi_infos_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- page
- rows
properties:
page:
type: integer
description: 页码
rows:
type: integer
description: 条数
padType:
type: string
description: 实例类型（virtual：虚拟机；real：真机）
padCodes:
type: array
items:
type: string
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
page:
type: integer
description: 当前页
rows:
type: integer
description: 每页的数量
size:
type: integer
description: 当前页的数量
total:
type: integer
description: 总记录数
totalPage:
type: integer
description: 总页数
pageData:
type: array
items:
type: object
description: 列表
padCode:
type: string
description: 实例编号
padGrade:
type: string
description: 实例开数（q1-6六开，q1-2二开）
padStatus:
type: string
description: 实例状态 （10-运行中 11-重启中 12-重置中 13-升级中 14-异常 15-未就绪）
deviceIp:
type: string
description: 云机ip
padIp:
type: string
description: 实例ip
apps:
type: array
items:
type: object
description: 安装的应用列表
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/addPhoneRecord:
post:
tags:
- 实例管理
summary: 导入通话记录
operationId: vcpcloud_api_padApi_addPhoneRecord_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCodes
- callRecords
properties:
padCodes:
type: array
items:
type: string
description: 需要编辑通话记录的实例编码
callRecords:
type: array
items:
type: string
description: 通话记录
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
padCode:
type: string
description: 实例编号
taskId:
type: integer
description: 任务id
vmStatus:
type: string
description: 实例在线状态
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/inputText:
post:
tags:
- 实例管理
summary: 云机文本信息输入
operationId: vcpcloud_api_padApi_inputText_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCodes
- text
properties:
padCodes:
type: array
items:
type: string
description: 实例编码
text:
type: string
description: 输入文本
code:
type: integer
description: 状态码
msg:
type: string
description: 响应消息
ts:
type: integer
description: 时间戳
data:
type: array
items:
type: string
padCode:
type: string
description: 实例编号
taskId:
type: integer
description: 任务id
vmStatus:
type: string
description: 实例在线状态
taskStatus:
type: string
description: 任务当前状态
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
padCode:
type: string
description: 实例编号
taskId:
type: integer
description: 任务id
vmStatus:
type: string
description: 实例在线状态
taskStatus:
type: string
description: 任务当前状态
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/simulateSendSms:
post:
tags:
- 实例管理
summary: 模拟发送短信
operationId: vcpcloud_api_padApi_simulateSendSms_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCodes
- senderNumber
- smsContent
properties:
padCodes:
type: array
items:
type: string
description: 实例编码列表，数量1-100个
senderNumber:
type: string
description: 发送方号码，不支持大陆号码。（格式：长度限制16位，允许数字、英文、空格、+-号）
smsContent:
type: string
description: 短信内容（长度限制127位）
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
traceId:
type: string
description: 追踪ID
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/resetGAID:
post:
tags:
- 实例管理
summary: 重置GAID
operationId: vcpcloud_api_padApi_resetGAID_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCodes
- resetGmsType
- taskSource
properties:
padCodes:
type: array
items:
type: string
resetGmsType:
type: string
description: 重置gms类型, 可选：GAID
oprBy:
type: string
description: 操作人
taskSource:
type: string
description: 任务来源，可选：OPEN_PLATFORM
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
taskId:
type: integer
description: 任务ID
padCode:
type: string
description: 实例编号
vmStatus:
type: integer
description: 实例在线状态（0：离线；1：在线）
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/injectAudioToMic:
post:
tags:
- 实例管理
summary: 注入音频到实例麦克风
operationId: vcpcloud_api_padApi_injectAudioToMic_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCodes
- enable
properties:
padCodes:
type: array
items:
type: string
description: 实例编码
url:
type: string
description: 音频文件下载地址 （此字段和fileUniqueId 2选1传值）
fileUniqueId:
type: string
description: 文件id唯一标识（此字段和url 2选1传值）
enable:
type: boolean
description: 注入开关
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
padCode:
type: string
description: 实例编号
taskId:
type: integer
description: 任务id
vmStatus:
type: string
description: 实例在线状态
taskStatus:
type: string
description: 任务当前状态
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/cleanAppHome:
post:
tags:
- 实例管理
summary: 清除进程并返回桌面(待上线)
operationId: vcpcloud_api_padApi_cleanAppHome_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCodes
properties:
padCodes:
type: array
items:
type: string
description: 实例编码
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
traceId:
type: string
description: 追踪ID
padCode:
type: string
description: 实例编号
taskId:
type: integer
description: 任务id
vmStatus:
type: string
description: 实例在线状态
taskStatus:
type: string
description: 任务当前状态
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/unmannedLive:
post:
tags:
- 实例管理
summary: 无人直播
operationId: vcpcloud_api_padApi_unmannedLive_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCodes
properties:
padCodes:
type: array
items:
type: string
description: 实例编码(1-100个)
injectSwitch:
type: boolean
description: "是否开启注入视频(true:开启 false:取消) 默认是false"
injectLoop:
type: boolean
description: "是否循环播放(true:是 false：否) 默认是false"
injectUrl:
type: string
description: "单个视频注入地址，支持 http/https/rtmp:// 以及本地路径，与injectUrls至少传一项"
injectUrls:
type: array
items:
type: string
description: "视频注入地址列表(最多5个)，支持 http/https/rtmp:// 以及本地路径，与injectUrl至少传一项"
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
traceId:
type: string
description: 追踪ID
padCode:
type: string
description: 实例编号
taskId:
type: integer
description: 任务id
vmStatus:
type: string
description: 实例在线状态
taskStatus:
type: string
description: 任务当前状态
errMsg:
type: string
description: 错误提示
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/injectPicture:
post:
tags:
- 实例管理
summary: 图片注入(待上线)
operationId: vcpcloud_api_padApi_injectPicture_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCodes
- injectUrl
properties:
padCodes:
type: array
items:
type: string
description: 实例编码(1-100个)
injectSwitch:
type: boolean
description: "是否开启注入图片(true:开启 false:取消) 默认是false"
injectLoop:
type: boolean
description: "是否循环播放(true:是 false：否) 默认是false"
injectUrl:
type: string
description: "图片注入地址,支持 http https rtmp://"
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
traceId:
type: string
description: 追踪ID
padCode:
type: string
description: 实例编号
taskId:
type: integer
description: 任务id
vmStatus:
type: string
description: 实例在线状态
taskStatus:
type: string
description: 任务当前状态
errMsg:
type: string
description: 错误提示
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/addUserRom:
post:
tags:
- 实例管理
summary: 上传用户镜像
operationId: vcpcloud_api_padApi_addUserRom_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- name
- updateLog
- androidVersion
- version
- downloadUrl
- packageSize
properties:
name:
type: string
description: ROM名称
updateLog:
type: string
description: 更新日志
androidVersion:
type: string
description: 安卓版本
version:
type: string
description: 版本
downloadUrl:
type: string
description: 地址
packageSize:
type: string
description: 大小（单位：Byte）
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
字段名:
type: string
description: 说明
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/replacement:
post:
tags:
- 实例管理
summary: 换机
operationId: vcpcloud_api_padApi_replacement_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCode
properties:
padCode:
type: string
description: 实例编号
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
equipmentId:
type: integer
description: 设备编号
padCode:
type: string
description: 实例编号
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/confirmTransfer:
post:
tags:
- 实例管理
summary: 云机转移
operationId: vcpcloud_api_padApi_confirmTransfer_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCodes
- makeOverMobilePhone
properties:
padCodes:
type: array
items:
type: string
description: 要转移的实例编号列表
makeOverMobilePhone:
type: string
description: 接收转移设备的账户邮箱
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/setHideAccessibilityAppList:
post:
tags:
- 实例管理
summary: 隐藏辅助服务
operationId: vcpcloud_api_padApi_setHideAccessibilityAppList_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCodes
- appInfos
properties:
padCodes:
type: array
items:
type: string
description: 实例编号数组（最多200个）
appInfos:
type: array
items:
type: string
description: "隐藏应用列表对象数组，传空数组[]表示清空（0-200个）"
packageName:
type: string
description: 是（数组非空时）
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/uninstallApp:
post:
tags:
- 应用管理
summary: 应用卸载
operationId: vcpcloud_api_padApi_uninstallApp_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- apkPackageList
- padCodeList
properties:
apkPackageList:
type: array
items:
type: string
description: 包名集合
padCodeList:
type: array
items:
type: string
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/startApp:
post:
tags:
- 应用管理
summary: 应用启动
operationId: vcpcloud_api_padApi_startApp_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- pkgName
- padCodes
properties:
pkgName:
type: string
description: 包名
padCodes:
type: array
items:
type: string
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
taskId:
type: integer
description: 任务ID
padCode:
type: string
description: 实例编号
vmStatus:
type: integer
description: 实例在线状态（0：离线；1：在线）
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/stopApp:
post:
tags:
- 应用管理
summary: 应用停止
operationId: vcpcloud_api_padApi_stopApp_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- pkgName
- padCodes
properties:
pkgName:
type: string
description: 包名
padCodes:
type: array
items:
type: string
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
taskId:
type: integer
description: 任务ID
padCode:
type: string
description: 实例编号
vmStatus:
type: integer
description: 实例在线状态（0：离线；1：在线）
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/restartApp:
post:
tags:
- 应用管理
summary: 应用重启
operationId: vcpcloud_api_padApi_restartApp_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- pkgName
- padCodes
properties:
pkgName:
type: string
description: 包名
padCodes:
type: array
items:
type: string
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
taskId:
type: integer
description: 任务ID
padCode:
type: string
description: 实例编号
vmStatus:
type: integer
description: 实例在线状态（0：离线；1：在线）
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/uploadFileV3:
post:
tags:
- 应用管理
summary: 文件通过链接直接上传
operationId: vcpcloud_api_padApi_uploadFileV3_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCodes
properties:
padCodes:
type: array
items:
type: string
padCode:
type: string
description: 实例编号
autoInstall:
type: integer
description: 是否需要⾃动安装 1需要、0不需要。不填默认不需要。仅对apk类型的⽂件⽣效
fileUniqueId:
type: string
description: 系文件id唯一标识
customizeFilePath:
type: string
description: "⾃定义路径。非必传，需以/开头。（示例：\"/DCIM/\", \"/Documents/\", \"/Download/\", \"/Movies/\", \"/Music/\", \"/Pictures/\"）"
fileName:
type: string
description: 文件名称
packageName:
type: string
description: 文件包名
url:
type: string
description: 文件安装路径
md5:
type: string
description: 系文件唯一标识
isAuthorization:
type: boolean
description: 是否授权(默认全授权)
iconPath:
type: string
description: 安装时的图标展示
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
padCode:
type: string
description: 实例编号
taskId:
type: integer
description: 任务ID
vmStatus:
type: integer
description: 实例在线状态（0：离线；1：在线）
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/uploadFile:
post:
tags:
- 应用管理
summary: 上传文件到云空间
operationId: vcpcloud_api_padApi_uploadFile_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- file
properties:
file:
type: string
description: 需要上传的文件
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
downloadUrl:
type: string
description: 文件下载链接
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/deleteOssFiles:
post:
tags:
- 应用管理
summary: 删除云空间文件
operationId: vcpcloud_api_padApi_deleteOssFiles_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- files
properties:
files:
type: integer
items:
type: string
description: 云空间文件唯一编号集合
urls:
type: array
items:
type: string
description: 云空间文件url地址集合
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/selectFiles:
post:
tags:
- 应用管理
summary: 查询用户的文件列表
operationId: vcpcloud_api_padApi_selectFiles_post
requestBody:
content:
application/json:
schema:
type: object
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
appName:
type: string
description: 文件名称
downloadUrl:
type: string
description: 文件下载链接
packageName:
type: string
description: APK包名，只有ap文件才有
fileId:
type: integer
description: 云空间文件编号
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/fileTaskDetail:
post:
tags:
- 任务管理
summary: 文件任务详情
operationId: vcpcloud_api_padApi_fileTaskDetail_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- taskIds
- taskId
properties:
taskIds:
type: integer
items:
type: string
taskId:
type: integer
description: 任务ID
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/createMoneyOrder:
post:
tags:
- 云手机管理
summary: 新建续费云手机
operationId: vcpcloud_api_padApi_createMoneyOrder_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- androidVersionName
- goodId
- goodNum
- autoRenew
properties:
androidVersionName:
type: string
description: Android 版本：Android10、Android12～Android17
goodId:
type: integer
description: "商品ID，见[SKU 套餐列表](#sku套餐列表)"
goodNum:
type: integer
description: 商品数量
autoRenew:
type: boolean
description: 是否自动续费，默认 true
equipmentId:
type: string
description: 续费设备ID，多个用逗号分隔
countryCode:
type: string
description: 云手机所属国家/区域代码
imageId:
type: string
description: 新购云机使用的镜像ID
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/selectPaidOrderList:
post:
tags:
- 云手机管理
summary: 查询账户流水（账单导出）
description: "分页查询当前账号的成功账户流水，包含计时设备扣费、充值、退款及其他收支。支持按订单号、流水号、收支方向、交易类型和交易时间筛选。 仅返回当前账号的成功流水（status=1）。金额单位为分，amount 保留原始正负号，负数为扣款、正数为入账。时间格式为 `yyyy-MM-dd HH:mm:ss`，时区为 Asia/Shanghai。开始、结束边界均包含，结束时间不能早于开始时间。不传 type 时包含收入和支出。结果按记录创建时间倒序，同一时间按记录 ID 倒序；翻页导出时请保持筛选条件一致。 businessType 是 tradeType 的兼容参数名，使用下表的账户交易类型；不再使用旧订单业务类型取值。两者同时传入时必须一致。接口路径保持不变，records 现为流水明细，原 orderPrice、payPrice、orderStatus、goodNum、goodName 和响应 businessType 已替换为下列账单字段。"
operationId: vcpcloud_api_padApi_selectPaidOrderList_post
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/PaidOrderQueryRequest"
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
$ref: "#/components/schemas/PaidOrderPage"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/padGroupList:
post:
tags:
- 云手机管理
summary: 获取设备分组列表
description: 获取当前账号可见的全部设备分组，包含空分组。每项仅返回 groupId 和 groupName。 默认查询个人设备分组；type=1 包含团队分配设备的分组。查询子账号时，须为调用方团队成员，且忽略 type；存在多个团队时须指定
teamId。使用相同账号范围，将返回的 groupId 传入 padGroupDevices 即可查询分组设备。
operationId: vcpcloud_api_padApi_padGroupList_post
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
type:
type: integer
enum:
- 0
- 1
default: 0
description: 账号范围：0 个人，1 含团队；默认 0
teamId:
type: integer
format: int64
description: 团队 ID；多团队查询子账号时必填
subAccountEmail:
type: string
description: 子账号登录标识
example: {}
responses:
'200':
description: 查询成功
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/StandardResponse'
- type: object
properties:
data:
type: array
items:
type: object
properties:
groupId:
type: integer
format: int64
description: 设备分组 ID
groupName:
type: string
description: 分组名称
example:
code: 200
msg: success
ts: 1700000000000
data:
- groupId: 100001
groupName: 示例分组
default:
$ref: '#/components/responses/ErrorResponse'
/vcpcloud/api/padApi/padGroupDevices:
post:
tags:
- 云手机管理
summary: 按分组获取设备列表
description: >-
按设备分组返回当前账号有权访问的有效设备。传入 `groupId` 查询指定分组；不传则返回全部分组，可从响应中获取分组 ID。 仅返回已分配实例的有效设备。个人范围包含自有、计时及被授权设备；`type=1` 还包含团队分配设备。查询子账号时，子账号须属于调用方团队，设备范围不受 `type` 影响；多团队场景须同时传入 `teamId`。
operationId: vcpcloud_api_padApi_padGroupDevices_post
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
groupId:
type: integer
format: int64
description: 设备分组 ID；不传返回全部分组
type:
type: integer
enum: [0, 1]
default: 0
description: "账号范围：0 个人，1 含团队；默认 0"
teamId:
type: integer
format: int64
description: 团队 ID；多团队查询子账号时必填
subAccountEmail:
type: string
description: 子账号登录标识
example:
groupId: 100001
type: 0
responses:
"200":
description: 查询成功
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: array
items:
type: object
properties:
groupId:
type: integer
format: int64
description: 设备分组 ID
groupName:
type: string
description: 分组名称
devices:
type: array
description: 分组内设备列表
items:
type: object
properties:
equipmentId:
type: integer
format: int64
description: 设备 ID
padCode:
type: string
description: 云机编号
padName:
type: string
description: 设备名称
proxy:
type: string
description: 代理连接串；无可用代理时为空串
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/userPadList:
post:
tags:
- 云手机管理
summary: 云手机列表
operationId: vcpcloud_api_padApi_userPadList_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCode
properties:
padCode:
type: string
description: 实例编号
equipmentIds:
type: integer
items:
type: string
description: 设备编号数组
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/padInfo:
post:
tags:
- 云手机管理
summary: 云手机信息查询
operationId: vcpcloud_api_padApi_padInfo_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCode
properties:
padCode:
type: string
description: 实例编号
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/getCloudGoodList:
get:
tags:
- 云手机管理
summary: sku套餐列表
operationId: vcpcloud_api_padApi_getCloudGoodList_get
parameters:
- name: androidVersion
in: query
required: false
description: 安卓版本号(不填写默认是安卓13)
schema:
type: integer
- name: goodIds
in: query
required: false
description: 按 SKU ID 过滤，逗号分隔，最多 50 个；不传则返回全部
schema:
type: string
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/createMoneyProOrder:
post:
tags:
- 云手机管理
summary: 设备预售购买
operationId: vcpcloud_api_padApi_createMoneyProOrder_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- androidVersionName
- goodId
- goodNum
- autoRenew
properties:
androidVersionName:
type: string
description: Android 版本：Android10、Android12～Android17
goodId:
type: integer
description: "商品Id（对应<a href=\"/vmoscloud/doc/zh/server/OpenAPI.html#sku套餐列表\" style=\"color:green;\"> sku套餐列表</a>的商品I"
goodNum:
type: integer
description: 商品数量
autoRenew:
type: boolean
description: 是否自动续费（默认关闭）true-开启、false-关闭
countryCode:
type: string
description: 国家代码，用于指定云手机所属区域
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/queryProOrderList:
post:
tags:
- 云手机管理
summary: 查询预售订单结果详情
operationId: vcpcloud_api_padApi_queryProOrderList_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- proBuyStatus
properties:
proBuyStatus:
type: integer
description: 1-待发货 2-已发货 为空默认全部
orderId:
type: integer
description: 预售订单号
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/imageVersionList:
post:
tags:
- 云手机管理
summary: 安卓镜像版本集合
operationId: vcpcloud_api_padApi_imageVersionList_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCode
properties:
padCode:
type: string
description: 设备编号
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/timingDeviceModels:
get:
tags:
- 云手机管理
summary: 查询计时设备可选机型
operationId: vcpcloud_api_padApi_timingDeviceModels_get
parameters:
- name: androidVersion
in: query
required: false
description: Android SDK版本，默认33
schema:
type: integer
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/createByTimingOrder:
post:
tags:
- 云手机管理
summary: 创建计时设备订单
operationId: vcpcloud_api_padApi_createByTimingOrder_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- goodTimeId
- goodNum
properties:
goodId:
type: integer
description: 商品系列ID，默认1
goodTimeId:
type: integer
description: 计时SKU ID
goodNum:
type: integer
description: 商品数量
androidVersion:
type: integer
description: Android SDK版本，默认33
deviceModelId:
type: integer
description: 机型ID，来自可选机型接口
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/timingPadOn:
post:
tags:
- 云手机管理
summary: 计时设备开机
operationId: vcpcloud_api_padApi_timingPadOn_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCodes
properties:
padCodes:
type: array
items:
type: string
description: 实例编号集合
defCode:
type: integer
description: 是否开机为新机 0-否 1-是 默认为0 优先级高
netStorageResUnitCode:
type: string
description: 指定开机的备份资源包ID 优先级低
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/timingPadOff:
post:
tags:
- 云手机管理
summary: 计时设备关机
operationId: vcpcloud_api_padApi_timingPadOff_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCodes
properties:
padCodes:
type: array
items:
type: string
description: 实例编号集合
isBackUp:
type: integer
description: 是否保留环境：0 否，1 是；默认 1
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/timingPadPowerLogList:
post:
tags:
- 云手机管理
summary: 查询计时设备开关机记录
operationId: vcpcloud_api_padApi_timingPadPowerLogList_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCode
properties:
padCode:
type: string
description: 计时设备编号，最长64字符
page:
type: integer
description: 页码，默认1
size:
type: integer
description: 每页数量，范围1至100
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/timingPadDel:
post:
tags:
- 云手机管理
summary: 计时设备销毁
operationId: vcpcloud_api_padApi_timingPadDel_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCodes
properties:
padCodes:
type: array
items:
type: string
description: 实例编号集合
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/vcTimingBackupList:
get:
tags:
- 云手机管理
summary: 存储资源包列表
operationId: vcpcloud_api_padApi_vcTimingBackupList_get
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/getRenewStorageInfo:
get:
tags:
- 云手机管理
summary: 云空间存储剩余容量
operationId: vcpcloud_api_padApi_getRenewStorageInfo_get
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/getVcStorageGoods:
get:
tags:
- 云手机管理
summary: 云空间商品列表
operationId: vcpcloud_api_padApi_getVcStorageGoods_get
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/buyStorageGoods:
post:
tags:
- 云手机管理
summary: 购买云空间扩容
operationId: vcpcloud_api_padApi_buyStorageGoods_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- storageId
- autoRenewOrder
properties:
storageId:
type: integer
description: 云空间扩容商品唯一ID
autoRenewOrder:
type: integer
description: 是否自动续费 0-否 1-是
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/selectAutoRenew:
get:
tags:
- 云手机管理
summary: 云空间续费详情查询
operationId: vcpcloud_api_padApi_selectAutoRenew_get
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/renewsStorageGoods:
post:
tags:
- 云手机管理
summary: 聚合续费云空间商品
operationId: vcpcloud_api_padApi_renewsStorageGoods_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- autoRenewOrder
properties:
autoRenewOrder:
type: integer
description: 是否自动续费 0-否 1-是
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/updateRenewStorageStatus:
get:
tags:
- 云手机管理
summary: 云空间自动续费开关
operationId: vcpcloud_api_padApi_updateRenewStorageStatus_get
parameters:
- name: renewStorageStatus
in: query
required: true
description: 是否自动续费 false-否 true-是
schema:
type: string
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/listPadBackupIds:
post:
tags:
- 云手机管理
summary: 查询可用云盘备份ID
operationId: vcpcloud_api_padApi_listPadBackupIds_post
requestBody:
content:
application/json:
schema:
type: object
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
$ref: "#/components/schemas/OpenApiPadBackupIdList"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/listPadBackups:
post:
tags:
- 云手机管理
summary: 查询云盘备份详情
operationId: vcpcloud_api_padApi_listPadBackups_post
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: 按备份名称精确筛选
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
$ref: "#/components/schemas/OpenApiPadBackupDetailList"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/backupCalculate:
post:
tags:
- 云手机管理
summary: 计算云盘备份大小
operationId: vcpcloud_api_padApi_backupCalculate_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCode
properties:
padCode:
type: string
description: 云机编号
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/queryBackupCalculateResult:
post:
tags:
- 云手机管理
summary: 查询云盘备份大小
operationId: vcpcloud_api_padApi_queryBackupCalculateResult_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCode
properties:
padCode:
type: string
description: 云机编号
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/addBackup:
post:
tags:
- 云手机管理
summary: 创建云盘备份
operationId: vcpcloud_api_padApi_addBackup_post
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/OpenApiAddBackupRequest"
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/queryBackupBatch:
post:
tags:
- 云手机管理
summary: 查询备份或克隆批次进度
description: 查询当前账号的批次。taskId 未生成时继续轮询；生成后可放入 taskIds 数组调用 padTaskDetail。失败任务可能没有 taskId，请查看 failMsg。
operationId: vcpcloud_api_padApi_queryBackupBatch_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required: [batchId]
properties:
batchId:
type: string
description: 备份或克隆接口返回的批次 ID
example: "100001_1762424603654"
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
batchId:
type: string
taskStatus:
type: integer
enum: [0, 1, 2, -1]
description: "0 待处理，1 执行中，2 完成，-1 全部失败"
deviceCount:
type: integer
successCount:
type: integer
failCount:
type: integer
items:
type: array
items:
type: object
required: [padCode, taskId, status]
properties:
padCode:
type: string
example: "AC32010601132"
taskId:
type: string
description: 实际任务 ID，未生成时为空字符串
examples: ["1234567890", ""]
status:
type: integer
enum: [0, 1, 2, 3, 4]
description: "0 待处理，1 执行中，2 成功，3 失败，4 已取消"
backupId:
type: [string, "null"]
description: 备份任务生成的备份 ID，可能为空
failMsg:
type: [string, "null"]
description: 失败原因
createTime:
type: string
description: 提交时间
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/clonePadBackup:
post:
tags:
- 云手机管理
summary: 从云盘备份克隆
description: 提交成功返回 batchId 和 padCount。使用 batchId 调用 queryBackupBatch 获取各云机的 taskId 和进度。
operationId: vcpcloud_api_padApi_clonePadBackup_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required: [vcPadBackupList, pads]
properties:
vcPadBackupList:
type: array
minItems: 1
maxItems: 50
description: 源备份列表
items:
type: object
required: [backupId]
properties:
backupId:
type: string
example: "bkp-AAA-1"
pads:
type: array
minItems: 1
maxItems: 50
description: 目标云机列表
items:
type: object
required: [padCode]
properties:
padCode:
type: string
example: "AC32010601132"
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
required: [batchId, padCount]
properties:
batchId:
type: string
description: 批次 ID，用于查询克隆进度
example: "100001_1762424603654"
padCount:
type: integer
description: 已接受的目标云机数量
example: 2
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/deleteUploadFiles:
post:
tags:
- 云手机管理
summary: 删除备份资源包数据
operationId: vcpcloud_api_padApi_deleteUploadFiles_post
requestBody:
content:
application/json:
schema:
type: object
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/toggleProcessHide:
post:
tags:
- 云手机管理
summary: 显示或隐藏应用进程
operationId: vcpcloud_api_padApi_toggleProcessHide_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCodes
- show
- packageName
properties:
padCodes:
type: array
items:
type: string
show:
type: boolean
description: 隐藏进程： true-隐藏 false-恢复
packageName:
type: string
description: 应用包名
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/getEmailServiceList:
get:
tags:
- 邮箱接码服务
summary: 获取邮箱服务列表
operationId: vcpcloud_api_padApi_getEmailServiceList_get
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
price:
type: string
description: 价格
stockNum:
type: integer
description: 剩余库存
serviceId:
type: string
description: 服务列表编号
serviceName:
type: string
description: 服务名称
items:
type: array
items:
type: object
description: 子服务列表
serviceItemId:
type: integer
description: 子服务唯一ID （购买时使用的ID）
serviceItemName:
type: string
description: 子服务名称
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/getEmailTypeList:
get:
tags:
- 邮箱接码服务
summary: 获取邮箱类型及剩余库存
operationId: vcpcloud_api_padApi_getEmailTypeList_get
parameters:
- name: serviceId
in: query
required: false
description: 对应 serviceItemId 字段
schema:
type: integer
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
price:
type: string
description: 价格
name:
type: string
description: 类型名称
stockNum:
type: integer
description: 剩余库存
id:
type: integer
description: 邮箱类型编号
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/createEmailOrder:
post:
tags:
- 邮箱接码服务
summary: 创建购买邮箱订单
operationId: vcpcloud_api_padApi_createEmailOrder_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- serviceId
properties:
serviceId:
type: integer
description: 对应 serviceItemId 字段
emailTypeId:
type: integer
description: 对应 /getEmailTypeList 返回的 ID 字段
goodNum:
type: integer
description: 购买数量
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/getEmailOrder:
get:
tags:
- 邮箱接码服务
summary: 查询购买的邮箱列表
operationId: vcpcloud_api_padApi_getEmailOrder_get
parameters:
- name: page
in: query
required: false
description: 必填，分页参数，当前页
schema:
type: integer
- name: size
in: query
required: false
description: 必填，分页参数，每页条数
schema:
type: integer
- name: serviceId
in: query
required: false
description: 非必填，对应 serviceItemId 字段
schema:
type: integer
- name: email
in: query
required: false
description: 非必填，邮箱模糊查询
schema:
type: string
- name: status
in: query
required: false
description: 非必填，邮箱状态 0-未使用 1-接收中 2-已使用 3-已失效
schema:
type: integer
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/getEmailCode:
get:
tags:
- 邮箱接码服务
summary: 刷新获取邮箱验证码
operationId: vcpcloud_api_padApi_getEmailCode_get
parameters:
- name: orderId
in: query
required: false
description: 必填，对应 outOrderId 字段
schema:
type: string
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/getDynamicGoodService:
get:
tags:
- 动态代理服务
summary: 查询动态代理商品列表
operationId: vcpcloud_api_padApi_getDynamicGoodService_get
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
goodName:
type: string
description: 商品名称
goodId:
type: integer
description: 商品唯一编号
goodPrice:
type: string
description: 商品价格
protocolDescription:
type: string
description: 支持的协议信息
totalTraffic:
type: array
items:
type: object
description: 流量包大小
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/getDynamicProxyRegion:
get:
tags:
- 动态代理服务
summary: 查询动态代理地区列表
operationId: vcpcloud_api_padApi_getDynamicProxyRegion_get
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
CountryName:
type: string
description: 国家名称
CountryCode:
type: string
description: 国家Code
State:
type: array
items:
type: object
description: 地区列表
city:
type: array
items:
type: object
description: 城市列表
name:
type: string
description: 地区名称
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/queryCurrentTrafficBalance:
get:
tags:
- 动态代理服务
summary: 获取动态代理当前余量
operationId: vcpcloud_api_padApi_queryCurrentTrafficBalance_get
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
accumulatedTraffic:
type: string
description: 总流量
remainingTraffic:
type: array
items:
type: object
description: 剩余流量
useTraffic:
type: array
items:
type: object
description: 已使用流量
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/getDynamicProxyHost:
get:
tags:
- 动态代理服务
summary: 查询支持的服务器地区
operationId: vcpcloud_api_padApi_getDynamicProxyHost_get
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
name:
type: string
description: 大洲名称
value:
type: string
description: 大洲服务器地址
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/buyDynamicProxy:
post:
tags:
- 动态代理服务
summary: 购买动态代理流量包
operationId: vcpcloud_api_padApi_buyDynamicProxy_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- goodId
properties:
goodId:
type: integer
description: 对应动态流量包的唯一ID
goodNum:
type: integer
description: 购买数量
autoRenewOrder:
type: integer
description: 开启自动续费 0-关闭 1-开启 剩余流量低于50MB时，触发自动续费
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/createProxy:
post:
tags:
- 动态代理服务
summary: 创建动态代理
operationId: vcpcloud_api_padApi_createProxy_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- city
properties:
city:
type: string
description: "城市 不选要传\"\""
countryCode:
type: string
description: 国家Code
goodNum:
type: integer
description: 购买数量
proxyHost:
type: string
description: 大洲网址
proxyType:
type: string
description: 代理类型 socks5 / http / https
proxyUseType:
type: string
description: 挂载方式 proxy / vpm
state:
type: string
description: "地区 不选要传\"\""
time:
type: string
description: 自动更换ip频率 (分钟) 可选 5、10、15、30、45、60、90
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
$ref: '#/components/schemas/CreateDynamicProxyData'
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/getProxys:
get:
tags:
- 动态代理服务
summary: 查询动态代理列表
operationId: vcpcloud_api_padApi_getProxys_get
parameters:
- name: page
in: query
required: false
description: 当前页
schema:
type: integer
- name: rows
in: query
required: false
description: 每页条数
schema:
type: integer
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
records:
type: array
items:
type: object
description: 动态代理信息
id:
type: string
description: 代理唯一编号
proxyHost:
type: string
description: 大洲服务器域名
proxyPort:
type: string
description: 大洲服务器端口
userName:
type: string
description: 动态代理用户名
password:
type: string
description: 动态代理密码
proxyType:
type: string
description: 动态代理协议类型
proxyUseType:
type: string
description: 动态代理挂载方式
countryCode:
type: string
description: 国家Code
state:
type: string
description: 地区
city:
type: string
description: 城市
time:
type: integer
description: 刷新频率
total:
type: integer
description: 代理条数
size:
type: integer
description: 每页展示数
pages:
type: integer
description: 总页数
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/getDynamicProxyOrders:
post:
tags:
- 动态代理服务
summary: 查询动态代理订单列表
operationId: vcpcloud_api_padApi_getDynamicProxyOrders_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- page
properties:
page:
type: integer
description: 当前页
rows:
type: integer
description: 每页条数
completeStartTime:
type: string
description: 支付开始时间
completeEndTime:
type: string
description: 支付结束时间
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
records:
type: array
items:
type: object
description: 动态代理信息
orderId:
type: string
description: 平台唯一ID
orderPrice:
type: integer
description: 订单金额分
payPrice:
type: integer
description: 支付金额分
createTime:
type: string
description: 创建时间
completeTime:
type: string
description: 支付时间
orderStatus:
type: integer
description: 订单状态 0-待支付 1-已支付
goodId:
type: integer
description: 商品唯一ID
goodNum:
type: integer
description: 购买数量
goodName:
type: string
description: 商品名称
goodPrice:
type: integer
description: 商品单价
goodSize:
type: integer
description: 商品流量包带下
sumSize:
type: integer
description: 订单总流量包大小
orderOtherInfo:
type: string
description: 订单说明
autoRenewOrder:
type: integer
description: 是否开启续费 1-开启 0-不开 （全局生效）
total:
type: integer
description: 代理条数
size:
type: integer
description: 每页展示数
pages:
type: integer
description: 总页数
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/batchPadConfigProxy:
post:
tags:
- 动态代理服务
summary: 云机配置动态代理
operationId: vcpcloud_api_padApi_batchPadConfigProxy_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCodes
properties:
padCodes:
type: array
items:
type: string
description: 云机集合
setProxyFlag:
type: boolean
description: 是否设备代理到云机
proxyIds:
type: array
items:
type: string
description: 动态代理唯一ID
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/selectBatchPadProxyTask:
post:
tags:
- 动态代理服务
summary: 查询批量云机设置代理任务
operationId: vcpcloud_api_padApi_selectBatchPadProxyTask_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- taskId
properties:
taskId:
type: integer
description: 批次ID，挂载代理是异步操作，因此需要等待5s或者循环查询
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
padCode:
type: string
description: 设备号
taskId:
type: integer
description: 任务ID，通过云机任务查询结果
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/getDynamicProxyAutomaticRenewal:
get:
tags:
- 动态代理服务
summary: 查询动态代理自动续费信息
operationId: vcpcloud_api_padApi_getDynamicProxyAutomaticRenewal_get
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
good_size:
type: integer
description: 续费的流量包大小
auto_renew_order:
type: integer
description: 是否开启自动续费 0-关闭 1-开启
order_price:
type: integer
description: 自动续费需扣除的金额
good_name:
type: string
description: 自动续费商品名称
good_number:
type: integer
description: 自动续费商品数量
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/setAutoRenewSwitch:
post:
tags:
- 动态代理服务
summary: 设置动态代理自动续费开关
operationId: vcpcloud_api_padApi_setAutoRenewSwitch_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- autoRenewOrder
properties:
autoRenewOrder:
type: integer
description: 自动续费开关 0-关 1-开
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/delProxyByIds:
post:
tags:
- 动态代理服务
summary: 删除动态代理
operationId: vcpcloud_api_padApi_delProxyByIds_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- ids
properties:
ids:
type: integer
items:
type: string
description: 要删除的动态代理ID集合
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/proxyGoodList:
get:
tags:
- 静态住宅代理服务
summary: 获取静态住宅商品列表
operationId: vcpcloud_api_padApi_proxyGoodList_get
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
proxyGoodName:
type: string
description: 商品名称
proxyGoodId:
type: integer
description: 商品唯一编号
proxyGoodPrice:
type: integer
description: 商品价格（美分）
proxyGoodType:
type: integer
description: 代理商品类型：0-通用 1-socket5 2-http 3-https
proxyGoodTime:
type: integer
description: 商品时长（分钟）
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/getProxyRegion:
get:
tags:
- 静态住宅代理服务
summary: 获取静态住宅支持的国家城市
operationId: vcpcloud_api_padApi_getProxyRegion_get
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
country:
type: string
description: 支持的国家code
countryZh:
type: string
description: 支持的国家说明
countryId:
type: integer
description: 国家唯一编号
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/createProxyOrder:
post:
tags:
- 静态住宅代理服务
summary: 静态住宅商品购买
operationId: vcpcloud_api_padApi_createProxyOrder_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- proxyGoodId
properties:
proxyGoodId:
type: integer
description: 对应静态住宅商品的唯一ID
region:
type: string
description: 静态住宅的地区-country
num:
type: integer
description: 购买数量
country:
type: string
description: 静态住宅的国家-country
proxyAddress:
type: string
description: 静态住宅的地址-countryZh
autoRenew:
type: boolean
description: 开启自动续费 false-关闭 true-开启
clientRequestId:
type: string
description: 重试复用；16～64位字母、数字、_或-
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
data.taskId:
type: string
description: 购买任务编号
data.status:
type: string
description: 当前状态
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/selectProxyOrderList:
post:
tags:
- 静态住宅代理服务
summary: 静态住宅代理订单明细
operationId: vcpcloud_api_padApi_selectProxyOrderList_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- page
properties:
page:
type: integer
description: 第几页
rows:
type: integer
description: 每页展示多少条
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
total:
type: integer
description: 条数
size:
type: integer
description: 每页展示数
pages:
type: integer
description: 总页数
records:
type: array
items:
type: object
description: 订单信息
buyNumber:
type: string
description: 购买数量
goodName:
type: string
description: 商品名称
createTime:
type: integer
description: 创建时间
orderId:
type: string
description: 订单ID
payPrice:
type: string
description: 支付金额
orderStatus:
type: string
description: 订单状态 0-待支付 1-已支付
orderPrice:
type: string
description: 订单金额
goodPrice:
type: string
description: 商品单价
goodNum:
type: string
description: 商品数量
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/createRenewProxyOrder:
post:
tags:
- 静态住宅代理服务
summary: 静态住宅代理续费
operationId: vcpcloud_api_padApi_createRenewProxyOrder_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- proxyGoodId
properties:
proxyGoodId:
type: integer
description: 对应静态住宅商品的唯一ID
proxyIps:
type: string
description: 续费的IP，多个以，分割
autoRenew:
type: boolean
description: 开启自动续费 false-关闭 true-开启
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/queryProxyList:
post:
tags:
- 静态住宅代理服务
summary: 查询静态住宅代理列表
operationId: vcpcloud_api_padApi_queryProxyList_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- current
properties:
current:
type: integer
description: 第几页
size:
type: integer
description: 每页展示多少条
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
total:
type: integer
description: 条数
size:
type: integer
description: 每页展示数
pages:
type: integer
description: 总页数
records:
type: array
items:
type: object
description: 订单信息
proxyStatus:
type: integer
description: 代理状态：0-检测中 1-正常 -1检测失败 2-待检测
proxyGoodId:
type: string
description: 商品ID
proxyName:
type: integer
description: 代理名称
proxyUseNumber:
type: string
description: 挂载云机数
proxyType:
type: string
description: "代理类型:1-Socks5 2-http 3-https"
proxyHost:
type: string
description: 订单状态 0-待支付 1-已支付
proxyPort:
type: string
description: 代理端口（奇数-socks5 偶数-http）63007 (63008)
password:
type: string
description: 代理密码
proxyCountry:
type: string
description: 代理所属国家
expectedExpireTime:
type: string
description: 到期时时间戳
expireTime:
type: string
description: 到期时时间戳 （同上，使用 expireTime 即可）
account:
type: string
description: 用户名
proxyId:
type: string
description: 代理唯一ID （挂载云机使用）
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/automation/runtime/ui-snapshot:
post:
tags:
- 流程自动化（RPA）
summary: 获取设备 UI 快照
operationId: vcpcloud_api_padApi_automation_runtime_ui_snapshot_post
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/RuntimeUiSnapshotRequest"
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
$ref: "#/components/schemas/RuntimeUiSnapshotData"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/automation/runtime/actions/execute:
post:
tags:
- 流程自动化（RPA）
summary: 执行单步设备操作
operationId: vcpcloud_api_padApi_automation_runtime_actions_execute_post
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/RuntimeActionExecuteRequest"
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
$ref: "#/components/schemas/RuntimeActionExecuteData"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/realMachineTrialAvailability:
get:
tags:
- 真机测试
summary: 查询真机测试可用机型
operationId: vcpcloud_api_padApi_realMachineTrialAvailability_get
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/createRealMachineTrial:
post:
tags:
- 真机测试
summary: 创建真机测试设备
operationId: vcpcloud_api_padApi_createRealMachineTrial_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- templateId
properties:
templateId:
type: integer
description: 机型模板ID
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/realMachineTrialGoods:
get:
tags:
- 真机测试
summary: 查询真机测试时长商品
operationId: vcpcloud_api_padApi_realMachineTrialGoods_get
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/buyRealMachineTrialTime:
post:
tags:
- 真机测试
summary: 购买真机测试时长
operationId: vcpcloud_api_padApi_buyRealMachineTrialTime_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- goodId
- quantity
- requestId
properties:
goodId:
type: integer
description: 商品ID
quantity:
type: integer
description: 购买数量，1至999
requestId:
type: string
description: 幂等请求号，最长64位
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/stsTokenByPadCode:
post:
tags:
- SDK Token
summary: 根据padCode获取SDK临时token
operationId: vcpcloud_api_padApi_stsTokenByPadCode_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- padCode
properties:
padCode:
type: string
description: 实例编号
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/getSessionToken:
get:
tags:
- SDK Token
summary: 获取群控token
operationId: vcpcloud_api_padApi_getSessionToken_get
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/clearStsToken:
post:
tags:
- SDK Token
summary: 清除SDK授权Token
operationId: vcpcloud_api_padApi_clearStsToken_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- token
properties:
token:
type: string
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/cloudNumber/skus:
post:
tags:
- 云号码服务
summary: 查询云号码套餐与库存
operationId: vcpcloud_api_padApi_cloudNumber_skus_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- areaCode
properties:
areaCode:
type: string
description: 美国区号过滤，仅支持 213/480/702/813，缺省 213；其他国家忽略此参数
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
├─:
type: string
description: Number 套餐 ID，购买时使用
└─:
type: string
description: Number 折算日价（美分）
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/cloudNumber/purchase:
post:
tags:
- 云号码服务
summary: 购买云号码
operationId: vcpcloud_api_padApi_cloudNumber_purchase_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- countryCode
- planId
- quantity
- clientToken
properties:
countryCode:
type: string
description: 国家码（US/GB/AU/AT/HK 等，见套餐查询）
areaCode:
type: string
description: 美国必填
planId:
type: integer
description: 套餐 ID（来自套餐查询）
quantity:
type: integer
description: 购买数量 1~10；名下进行中号码加本次数量不超过 10
autoRenew:
type: integer
description: 到期自动续费，0/1；**缺省为 1（默认开启）**
clientToken:
type: string
description: 幂等令牌，每次下单唯一（建议 uuid）；同令牌重试返回原单
expectedTotalCents:
type: integer
description: 期望总价（美分）；与最新价不一致时返回 PRICE_CHANGED 不下单
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
data.status:
type: string
description: 购买状态，见下方状态表
data.terminal:
type: boolean
description: 是否终态
data.orderNo:
type: string
description: 订单号
data.clientToken:
type: string
description: 幂等令牌回显
data.quantity:
type: string
description: data.deliveredQuantity Number 购买 / 已交付数量
data.totalCents:
type: integer
description: 总价（美分）
data.expectedTotalCents:
type: integer
description: 期望价（美分）
data.chargedCents:
type: integer
description: 实扣（美分）
data.refundDueCents:
type: string
description: data.refundedCents Number 应退 / 已退（美分）
data.netPaidCents:
type: integer
description: 净支付（美分）
data.numbers:
type: array
items:
type: object
description: 已交付号码（E.164 无 + 前缀）
data.skus:
type: array
items:
type: object
description: 仅 PRICE_CHANGED 时返回最新套餐与总价
data.rejectCode:
type: string
description: 拒绝机器码（一期仅 INSUFFICIENT_BALANCE）
data.message:
type: string
description: 文字说明
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/cloudNumber/purchase/status:
post:
tags:
- 云号码服务
summary: 查询云号码购买结果
operationId: vcpcloud_api_padApi_cloudNumber_purchase_status_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- clientToken
properties:
clientToken:
type: string
description: 购买时的幂等令牌
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/cloudNumber/list:
post:
tags:
- 云号码服务
summary: 查询云号码列表
operationId: vcpcloud_api_padApi_cloudNumber_list_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- countryCode
properties:
countryCode:
type: string
description: 国家过滤
status:
type: string
description: normal 正常 / soon 即将过期 / expired 已过期 / disabled 已停用（小写）
keyword:
type: string
description: 匹配号码或备注，最长 64 字符
page:
type: integer
description: 页码，默认 1
size:
type: integer
description: 每页条数，默认 20，上限 100
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
data.total:
type: string
description: data.size / data.current Number 分页信息
"data.records[].id":
type: integer
description: 号码记录 ID（修改自动续费、绑定时使用）
"data.records[].number":
type: string
description: 号码（E.164 无 + 前缀）
"data.records[].countryCode":
type: string
description: 国家码
"data.records[].status":
type: string
description: normal / soon / expired / disabled
"data.records[].autoRenew":
type: integer
description: 自动续费 0/1
"data.records[].remark":
type: string
description: 备注
"data.records[].expireTime":
type: string
description: 到期日
"data.records[].rowVersion":
type: string
description: 乐观锁版本，修改时回传
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/cloudNumber/autoRenew:
post:
tags:
- 云号码服务
summary: 修改云号码自动续费
operationId: vcpcloud_api_padApi_cloudNumber_autoRenew_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- id
- autoRenew
- rowVersion
properties:
id:
type: integer
description: 号码记录 ID（来自号码列表）
autoRenew:
type: integer
description: 0 关闭 / 1 开启
rowVersion:
type: string
description: 乐观锁版本（来自号码列表）；并发冲突时报错，重取新版本重试
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
data.status:
type: string
description: 保存结果
data.item.rowVersion:
type: string
description: 新版本号
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/cloudNumber/release:
post:
tags:
- 云号码服务
summary: 退订云号码
operationId: vcpcloud_api_padApi_cloudNumber_release_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- number
properties:
number:
type: string
description: E.164 无 + 前缀，6~15 位数字
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
data.status:
type: string
description: ACCEPTED 已完成 / PENDING 受理中（终态以号码列表为准）
data.message:
type: string
description: 说明
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/cloudNumber/sms/list:
post:
tags:
- 云号码服务
summary: 查询云号码短信
operationId: vcpcloud_api_padApi_cloudNumber_sms_list_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- number
properties:
number:
type: string
description: E.164 无 + 前缀（必须指定，防误查全部）
keyword:
type: string
description: 关键字过滤，最长 64 字符
page:
type: integer
description: 页码，默认 1
size:
type: integer
description: 每页条数，默认 20，上限 100
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
data.total:
type: integer
description: 总条数
"data.records[].id":
type: string
description: 短信 ID
"data.records[].sender":
type: string
description: 发送方
"data.records[].content":
type: string
description: 正文
"data.records[].mediaUrls":
type: array
items:
type: object
description: 媒体附件 URL
"data.records[].receivedTime":
type: string
description: 接收时间（GMT+8，倒序）
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/cloudNumber/bind:
post:
tags:
- 云号码服务
summary: 发起云机绑定
operationId: vcpcloud_api_padApi_cloudNumber_bind_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- numberId
- padCode
- requestId
- restartAcknowledged
properties:
numberId:
type: integer
description: 号码记录 ID（来自号码列表）
padCode:
type: string
description: 目标云机设备码
requestId:
type: string
description: 幂等 ID，16~64 位字母数字与 `_-`；同 ID 同参数重试返回原任务
restartAcknowledged:
type: boolean
description: 必须显式传 true，否则拒绝
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
错误码:
type: string
RESTART_REQUIRED:
type: string
description: restartAcknowledged=true 重试
INVALID_REQUEST:
type: string
REQUEST_CONFLICT:
type: string
description: requestId
DEVICE_BUSY:
type: string
description: NUMBER_BUSY 稍后重试
NOT_AVAILABLE:
type: string
description: numberId
UNAVAILABLE:
type: string
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/cloudNumber/bind/status:
post:
tags:
- 云号码服务
summary: 查询云机绑定状态
operationId: vcpcloud_api_padApi_cloudNumber_bind_status_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- numberId
properties:
numberId:
type: integer
description: 号码记录 ID
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
data.state:
type: string
description: 任务状态（NONE 无任务 / RUNNING 执行中 / SUCCESS 成功 / FAILED 失败等）
data.terminal:
type: boolean
description: 是否终态
data.rebindAvailable:
type: boolean
description: 是否可再次发起绑定
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/socialAccount/listings:
post:
tags:
- 社媒账号服务
summary: 查询社媒账号商品
operationId: vcpcloud_api_padApi_socialAccount_listings_post
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
categoryId:
type: integer
description: 分类 ID
subcategoryId:
type: integer
description: 子分类 ID
search:
type: string
description: 模糊搜索，最多 100 字符
sort:
type: string
description: 排序字段，默认 sort_key
direction:
type: string
description: asc 或 desc
page:
type: integer
description: 页码，1~500
perPage:
type: integer
description: 每页 1~100 条
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
data.data:
type: array
items:
type: object
description: 商品列表
id:
type: integer
description: 商品 ID
slug:
type: string
description: 商品标识
title:
type: string
description: 商品名称
price:
type: string
description: 最终销售单价（美元）
available_stock:
type: integer
description: 当前可用库存
sold:
type: integer
description: 已售数量
category:
type: object
description: 分类信息
subcategory:
type: object
description: 子分类信息
data.meta.current_page:
type: integer
description: 当前页
data.meta.last_page:
type: integer
description: 总页数
data.meta.per_page:
type: integer
description: 每页条数
data.meta.total:
type: integer
description: 商品总数
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/socialAccount/purchase:
post:
tags:
- 社媒账号服务
summary: 购买社媒账号
operationId: vcpcloud_api_padApi_socialAccount_purchase_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- requestNo
- listingId
- listingSlug
- quantity
- expectedUnitPrice
properties:
requestNo:
type: string
description: 幂等请求号，16~64 字符
listingId:
type: integer
description: 商品 ID
listingSlug:
type: string
description: 商品标识
listingTitle:
type: string
description: 商品原始名称
quantity:
type: integer
description: 购买数量，当前 1~50
expectedUnitPrice:
type: string
description: 列表返回的美元单价
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
data.statusCode:
type: string
description: 订单状态码
data.terminal:
type: boolean
description: 是否终态
data.orderNo:
type: string
description: 平台订单号
data.quantity:
type: integer
description: 购买数量
data.deliveredQuantity:
type: integer
description: 已交付数量
data.unitPrice:
type: string
description: 美元单价
data.amount:
type: string
description: 订单总额（美元）
data.refundedAmount:
type: string
description: 已退款金额（美元）
data.netAmount:
type: string
description: 净支付金额（美元）
data.message:
type: string
description: 拒绝或重试说明
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/socialAccount/purchase/status:
post:
tags:
- 社媒账号服务
summary: 查询社媒账号购买结果
operationId: vcpcloud_api_padApi_socialAccount_purchase_status_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- requestNo
properties:
requestNo:
type: string
description: 购买时的幂等请求号
responses:
"200":
$ref: "#/components/responses/SuccessResponse"
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/socialAccount/orders:
post:
tags:
- 社媒账号服务
summary: 查询社媒账号订单
operationId: vcpcloud_api_padApi_socialAccount_orders_post
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
page:
type: integer
description: 页码，默认 1，最大 10000
size:
type: integer
description: 每页条数，默认 10，最大 50
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
data.records:
type: array
items:
type: object
description: 订单数组，不含凭据
data.total:
type: integer
description: 总记录数
data.page:
type: integer
description: 当前页
data.size:
type: integer
description: 每页条数
data.pages:
type: integer
description: 总页数
default:
$ref: "#/components/responses/ErrorResponse"
/vcpcloud/api/padApi/socialAccount/order/detail:
post:
tags:
- 社媒账号服务
summary: 查询社媒账号订单详情
operationId: vcpcloud_api_padApi_socialAccount_order_detail_post
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- orderNo
properties:
orderNo:
type: string
description: 平台订单号，最多 64 字符
responses:
"200":
description: 成功响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
data:
type: object
properties:
data.accounts:
type: array
items:
type: object
description: 已交付账号凭据
default:
$ref: "#/components/responses/ErrorResponse"
components:
securitySchemes:
VMOSCloudHMAC:
type: http
scheme: custom
description: |
HMAC-SHA256 签名验证。请求头必须包含：
x-date（UTC 时间 ISO 8601）、x-host（api.vmoscloud.com）、
Content-Type（application/json）、authorization（HMAC-SHA256 签名）。
签名格式：HMAC-SHA256 Credential={AccessKey}, SignedHeaders=content-type;host;x-content-sha256;x-date, Signature={Signature}
计算步骤见使用指南 example.md。
schemas:
OpenApiPadBackupCreateItem:
type: object
required: [padCode]
properties:
padCode:
type: string
description: 云机编号
name:
type: string
description: 备份名称
OpenApiAddBackupRequest:
type: object
required: [vcPadBackupList]
properties:
vcPadBackupList:
type: array
minItems: 1
maxItems: 50
items:
$ref: "#/components/schemas/OpenApiPadBackupCreateItem"
OpenApiPadBackupIdList:
type: array
items:
type: string
OpenApiPadBackupDetail:
type: object
required: [backupId, name]
properties:
backupId:
type: string
name:
type: string
OpenApiPadBackupDetailList:
type: array
items:
$ref: "#/components/schemas/OpenApiPadBackupDetail"
RuntimeUiSnapshotRequest:
type: object
required: [padCode]
properties:
padCode:
type: string
description: 云机编号
includeImage:
type: boolean
default: false
description: 是否返回截图 Base64
RuntimeActionSelector:
type: object
required: [field, operator, value]
properties:
field:
type: string
enum: [id, class, text, desc, hint]
operator:
type: string
enum: [equal, contain, startWith, endsWith, notEqual, notContain]
value:
type: string
maxLength: 500
RuntimeAction:
type: object
required: [type]
properties:
type:
type: string
enum:
- clickCoordinate
- longPressCoordinate
- swipe
- clickElement
- longPressElement
- inputText
- keyEvent
- back
- openApp
- stopApp
- wait
coordinateMode:
type: string
enum: [absolute, relative]
default: absolute
x:
type: number
y:
type: number
direction:
type: string
enum: [up, down, left, right]
distance:
type: integer
minimum: 1
maximum: 4000
durationMs:
type: integer
minimum: 0
maximum: 10000
text:
type: string
maxLength: 4000
keyType:
type: string
enum: [enter, delete, search]
packageName:
type: string
maxLength: 255
clearBefore:
type: boolean
default: true
index:
type: integer
minimum: 1
maximum: 1000
default: 1
timeoutMs:
type: integer
minimum: 0
maximum: 30000
selectors:
type: array
maxItems: 8
description: 节点匹配条件，最多 8 条
items:
$ref: "#/components/schemas/RuntimeActionSelector"
RuntimeActionExecuteRequest:
type: object
required: [padCode, action]
properties:
padCode:
type: string
description: 云机编号
action:
$ref: "#/components/schemas/RuntimeAction"
RuntimeUiNode:
type: object
properties:
text:
type: string
desc:
type: string
resourceId:
type: string
className:
type: string
packageName:
type: string
bounds:
type: array
minItems: 4
maxItems: 4
items:
type: integer
clickable:
type: boolean
enabled:
type: boolean
focusable:
type: boolean
scrollable:
type: boolean
selected:
type: boolean
checked:
type: boolean
depth:
type: integer
indexPath:
type: string
RuntimeUiSnapshotData:
type: object
required: [requestId, capturedAt, nodes]
properties:
requestId:
type: string
imageBase64:
type: string
imageWidth:
type: integer
imageHeight:
type: integer
screenWidth:
type: integer
screenHeight:
type: integer
rotation:
type: integer
capturedAt:
type: string
nodes:
type: array
items:
$ref: "#/components/schemas/RuntimeUiNode"
RuntimeActionExecuteData:
type: object
required: [taskId, status, deviceId]
properties:
taskId:
type: integer
format: int64
status:
type: string
deviceId:
type: string
PaidOrderQueryRequest:
type: object
properties:
orderId:
type: string
description: 完整订单编号
recordId:
type: string
description: 完整交易流水号
type:
type: integer
description: 收支方向：1 收入，2 支出
enum:
- 1
- 2
tradeType:
type: integer
description: 交易类型，取值见下表
minimum: 1
businessType:
type: integer
description: tradeType 的兼容参数
minimum: 1
deprecated: true
completeStartTime:
type: string
description: 交易时间下限，包含该时间
example: '2026-09-01 00:00:00'
completeEndTime:
type: string
description: 交易时间上限，包含该时间
example: '2026-09-30 23:59:59'
page:
type: integer
description: 页码，默认 1，最小 1
minimum: 1
default: 1
rows:
type: integer
description: 每页条数，默认 10，范围 1–100
minimum: 1
default: 10
maximum: 100
PaidOrderRecord:
type: object
properties:
id:
type: integer
description: 流水记录 ID
format: int64
orderId:
type: string
description: 关联订单编号，可能为空
type:
type: integer
description: 收支方向：1 收入，2 支出
enum:
- 1
- 2
amount:
type: integer
description: 变更金额，单位分，保留正负号
format: int64
example: -25
status:
type: integer
description: 流水状态，1 为成功
enum:
- 1
completeTime:
type: string
description: 交易时间
createTime:
type: string
description: 记录创建时间
remarks:
type: string
description: 交易备注
PaidOrderPage:
type: object
required:
- current
- size
- total
- pages
- records
properties:
current:
type: integer
format: int64
size:
type: integer
format: int64
total:
type: integer
format: int64
pages:
type: integer
format: int64
records:
type: array
items:
$ref: '#/components/schemas/PaidOrderRecord'
UserTemplateQueryRequest:
type: object
properties:
page:
type: integer
minimum: 1
default: 1
rows:
type: integer
minimum: 1
default: 10
maximum: 100
id:
type: integer
minimum: 1
templateId:
type: string
maxLength: 64
UserTemplatePage:
type: object
properties:
page:
type: integer
rows:
type: integer
size:
type: integer
total:
type: integer
totalPage:
type: integer
pageData:
type: array
items:
$ref: "#/components/schemas/UserUploadedTemplate"
UserUploadedTemplate:
type: object
properties:
id:
type: [integer, "null"]
templateId:
type: [string, "null"]
deviceName:
type: [string, "null"]
modelCode:
type: [string, "null"]
brand:
type: [string, "null"]
model:
type: [string, "null"]
aospVersion:
type: [string, "null"]
androidImageVersion:
type: [string, "null"]
adiTemplateVersion:
type: [string, "null"]
screenWidth:
type: [integer, "null"]
screenHigh:
type: [integer, "null"]
processStatus:
type: [integer, "null"]
enum: [0, 1, 2, 3, 4, 5, 10, 20, -1, null]
processStatusDesc:
type: [string, "null"]
status:
type: [integer, "null"]
enum: [0, 1, null]
adiTemplateDownloadUrl:
type: [string, "null"]
createTime:
type: [string, "null"]
updateTime:
type: [string, "null"]
CreateDynamicProxyData:
type: array
items:
type: object
required:
- id
- proxyHost
- proxyPort
- userName
- password
- proxyType
properties:
id:
type: integer
description: 代理 ID
example: 100001
proxyHost:
type: string
description: 代理服务器地址
example: proxy.example.com
proxyPort:
type: integer
description: 代理端口
example: 1000
userName:
type: string
description: 代理认证账号
example: proxy-user-example
password:
type: string
description: 代理认证密码
example: proxy-password-example
proxyType:
type: string
description: 代理协议
example: socks5
StandardResponse:
type: object
required: [code, msg, ts]
properties:
code:
type: integer
description: 业务码，200 表示成功
example: 200
msg:
type: string
description: 提示信息
example: "success"
ts:
type: integer
description: 时间戳
example: 1704067200000
data:
description: 业务数据，结构见 OpenAPI.md 各接口响应参数
responses:
SuccessResponse:
description: 操作成功
content:
application/json:
schema:
$ref: "#/components/schemas/StandardResponse"
ErrorResponse:
description: 错误响应
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/StandardResponse"
- type: object
properties:
code:
type: integer
description: 错误码
example: 500
msg:
type: string
description: 错误信息
example: "内部服务器错误"