VSPhone OpenAPI 3.1 规范
本文档提供 VSPhone OpenAPI 3.1 规范文件的获取方式,供 AI 助手、大模型、代码生成工具及自动化脚本消费。规范内容与本站《接口文档》OpenAPI.md 完全一致,仅格式为机器可读的 OpenAPI 描述。
📥 下载 OpenAPI 规范文件 — 适合 Postman、Swagger Editor、AI 工具等直接导入
获取方式:
- 浏览器下载:点击此处下载 openapi.yaml,或访问:
https://api.vsphone.com/vsphone/doc/zh/server/openapi.yaml
若浏览器直接打开而非下载,可右键链接选择「另存为」。 - 命令行获取:
curl https://api.vsphone.com/vsphone/doc/zh/server/openapi.yaml -o vsphone-openapi.yaml - 直接引用:在 Postman、Swagger Editor、AI 等工具中使用上述 URL 直接导入
规范全文
以下为 OpenAPI 3.1 规范全文,可直接在本页复制使用,或通过上方链接下载文件。
openapi: 3.1.0
info:
title: VSPhone OpenAPI
description: |
VSPhone 服务端 OpenAPI 规范,供 AI/大模型/代码助手及自动化工具消费。
接口描述、请求/响应参数与业务语义以本站《接口文档》OpenAPI.md 为准;
认证与签名详见使用指南 example.md。
version: "1.0.0"
servers:
- url: https://api.vsphone.com
description: VSPhone API 服务器
security:
- VSPhoneHMAC: []
tags:
- name: 实例管理
- name: 资源管理
- name: 应用管理
- name: 任务管理
- name: 云手机管理
- name: TK自动化
- name: SDK Token
paths:
/vsphone/api/padApi/setWifiList:
post:
tags:
- 实例管理
summary: 修改实例WIFI属性
operationId: vsphone_api_padApi_setWifiList_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):"padCodes[],wifiJsonList[],SSID,BSSID,MAC,IP,gateway,DNS1,DNS2,hessid,anqpDomainId,capabilities,level,linkSpeed,txLinkSpeed,rxLinkSpeed,frequency,distance,distanceSd,channelWidth"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/restart:
post:
tags:
- 实例管理
summary: 实例重启
operationId: vsphone_api_padApi_restart_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):"padCodes[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/reset:
post:
tags:
- 实例管理
summary: 实例重置
operationId: vsphone_api_padApi_reset_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):"padCodes[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/padProperties:
post:
tags:
- 实例管理
summary: 查询实例属性
operationId: vsphone_api_padApi_padProperties_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):padCode
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/batchPadProperties:
post:
tags:
- 实例管理
summary: 批量查询实例属性
operationId: vsphone_api_padApi_batchPadProperties_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):"padCodes[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/updatePadProperties:
post:
tags:
- 实例管理
summary: 修改实例属性(动态生效)
operationId: vsphone_api_padApi_updatePadProperties_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):"padCodes[],modemPersistPropertiesList[],propertiesName,propertiesValue,modemPropertiesList[],systemPersistPropertiesList[],systemPropertiesList[],settingPropertiesList[],oaidPropertiesList[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/updatePadAndroidProp:
post:
tags:
- 实例管理
summary: 修改实例安卓改机属性(需重启)
operationId: vsphone_api_padApi_updatePadAndroidProp_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):padCode,restart,props,ro.product.vendor.name
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/updateSIM:
post:
tags:
- 实例管理
summary: 根据国家Code修改SIM卡信息
operationId: vsphone_api_padApi_updateSIM_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):padCode,countryCode,props,ro.product.vendor.name
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/dissolveRoom:
post:
tags:
- 实例管理
summary: 停止推流
operationId: vsphone_api_padApi_dissolveRoom_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):"padCodes[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/smartIp:
post:
tags:
- 实例管理
summary: 设置智能IP
operationId: vsphone_api_padApi_smartIp_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):"padCodes[],host,port,account,password,type,mode,bypassPackageList[],bypassIpList[],bypassDomainList[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/notSmartIp:
post:
tags:
- 实例管理
summary: 取消智能IP
operationId: vsphone_api_padApi_notSmartIp_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):"padCodes[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/updateTimeZone:
post:
tags:
- 实例管理
summary: 修改实例时区
operationId: vsphone_api_padApi_updateTimeZone_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):"timeZone,padCodes[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/updateLanguage:
post:
tags:
- 实例管理
summary: 修改实例语言
operationId: vsphone_api_padApi_updateLanguage_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):"language,country,padCodes[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/gpsInjectInfo:
post:
tags:
- 实例管理
summary: 设置实例经纬度
operationId: vsphone_api_padApi_gpsInjectInfo_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):"longitude,latitude,altitude,speed,bearing,horizontalAccuracyMeters,padCodes[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/replacePad:
post:
tags:
- 实例管理
summary: 一键新机
operationId: vsphone_api_padApi_replacePad_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):"padCodes[],countryCode,realPhoneTemplateId,androidProp,replacementRealAdiFlag,excludeRealPhoneTemplateIds[],certificate,wipeData,wipeSpecificData[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/country:
get:
tags:
- 实例管理
summary: 查询一键新机支持国家列表
operationId: vsphone_api_padApi_country_get
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):无
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/setProxy:
post:
tags:
- 实例管理
summary: 实例设置代理
operationId: vsphone_api_padApi_setProxy_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):"account,password,ip,port,enable,padCodes[],proxyType,proxyName,bypassPackageList[],bypassIpList[],bypassDomainList[],sUoT"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/listInstalledApp:
post:
tags:
- 实例管理
summary: 实时查询已安装的应用列表
operationId: vsphone_api_padApi_listInstalledApp_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):"padCodes[],appName"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/setKeepAliveApp:
post:
tags:
- 实例管理
summary: 设置应用自启动
operationId: vsphone_api_padApi_setKeepAliveApp_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):"padCodes[],applyAllInstances,appInfos[],serverName"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/asyncCmd:
post:
tags:
- 实例管理
summary: 异步执行ADB命令
operationId: vsphone_api_padApi_asyncCmd_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):"padCodes[],scriptContent"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/switchRoot:
post:
tags:
- 实例管理
summary: 开关Root权限
operationId: vsphone_api_padApi_switchRoot_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):"padCodes[],globalRoot,packageName,rootStatus"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/screenshot:
post:
tags:
- 实例管理
summary: 本地截图
operationId: vsphone_api_padApi_screenshot_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):"padCodes[],rotation,broadcast,definition,resolutionHeight,resolutionWidth"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/getLongGenerateUrl:
post:
tags:
- 实例管理
summary: 获取实例实时预览图片
operationId: vsphone_api_padApi_getLongGenerateUrl_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):"padCodes[],format,height,width,quality"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/upgradeImage:
post:
tags:
- 实例管理
summary: 升级镜像
operationId: vsphone_api_padApi_upgradeImage_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):"padCodes[],imageId,wipeData,enableCpuCoreConfig"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/virtualRealSwitch:
post:
tags:
- 实例管理
summary: 升级真机镜像
operationId: vsphone_api_padApi_virtualRealSwitch_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):"padCodes[],imageId,wipeData,realPhoneTemplateId,upgradeImageConvertType,screenLayoutId,certificate,deviceAndroidProps,enableCpuCoreConfig"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/templateList:
post:
tags:
- 实例管理
summary: 分页获取真机模板
operationId: vsphone_api_padApi_templateList_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):page,rows
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/openOnlineAdb:
post:
tags:
- 实例管理
summary: 开启关闭ADB
operationId: vsphone_api_padApi_openOnlineAdb_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):"padCodes[],openStatus"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/adb:
post:
tags:
- 实例管理
summary: 获取ADB连接信息
operationId: vsphone_api_padApi_adb_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):padCode,enable
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/simulateTouch:
post:
tags:
- 实例管理
summary: 模拟触控
operationId: vsphone_api_padApi_simulateTouch_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):"padCodes[],width,height,pointCount,positions[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/padTaskDetail:
post:
tags:
- 实例管理
summary: 实例操作任务详情
operationId: vsphone_api_padApi_padTaskDetail_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):"taskIds[],taskId"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/infos:
post:
tags:
- 实例管理
summary: 实例分组列表/实例列表信息
operationId: vsphone_api_padApi_infos_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):"page,rows,padType,padCodes[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/addPhoneRecord:
post:
tags:
- 实例管理
summary: 导入通话记录
operationId: vsphone_api_padApi_addPhoneRecord_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):"padCodes[],callRecords[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/inputText:
post:
tags:
- 实例管理
summary: 云机文本信息输入
operationId: vsphone_api_padApi_inputText_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):"padCodes[],text,code,msg,ts,data[],padCode,taskId,vmStatus,taskStatus"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/simulateSendSms:
post:
tags:
- 实例管理
summary: 模拟发送短信
operationId: vsphone_api_padApi_simulateSendSms_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):"padCodes[],senderNumber,smsContent"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/resetGAID:
post:
tags:
- 实例管理
summary: 重置GAID
operationId: vsphone_api_padApi_resetGAID_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):"padCodes[],resetGmsType,oprBy,taskSource"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/injectAudioToMic:
post:
tags:
- 实例管理
summary: 注入音频到实例麦克风
operationId: vsphone_api_padApi_injectAudioToMic_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):"padCodes[],url,fileUniqueId,enable"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/addUserRom:
post:
tags:
- 实例管理
summary: 上传用户镜像
operationId: vsphone_api_padApi_addUserRom_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):name,updateLog,androidVersion,version,downloadUrl,packageSize
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/replacement:
post:
tags:
- 实例管理
summary: 换机
operationId: vsphone_api_padApi_replacement_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):padCode
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/confirmTransfer:
post:
tags:
- 实例管理
summary: 云机转移
operationId: vsphone_api_padApi_confirmTransfer_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):"padCodes[],makeOverMobilePhone"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/uninstallApp:
post:
tags:
- 应用管理
summary: 应用卸载
operationId: vsphone_api_padApi_uninstallApp_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):"apkPackageList[],padCodeList[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/startApp:
post:
tags:
- 应用管理
summary: 应用启动
operationId: vsphone_api_padApi_startApp_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):"pkgName,padCodes[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/stopApp:
post:
tags:
- 应用管理
summary: 应用停止
operationId: vsphone_api_padApi_stopApp_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):"pkgName,padCodes[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/restartApp:
post:
tags:
- 应用管理
summary: 应用重启
operationId: vsphone_api_padApi_restartApp_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):"pkgName,padCodes[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/uploadFileV3:
post:
tags:
- 应用管理
summary: 文件通过链接直接上传
operationId: vsphone_api_padApi_uploadFileV3_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):"padCodes[],padCode,autoInstall,fileUniqueId,customizeFilePath,fileName,packageName,url,md5,isAuthorization,iconPath"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/uploadFile:
post:
tags:
- 应用管理
summary: 上传文件到云空间
operationId: vsphone_api_padApi_uploadFile_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):file
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/selectFiles:
post:
tags:
- 应用管理
summary: 查询用户的文件列表
operationId: vsphone_api_padApi_selectFiles_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):无
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/fileTaskDetail:
post:
tags:
- 任务管理
summary: 文件任务详情
operationId: vsphone_api_padApi_fileTaskDetail_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):"taskIds[],taskId"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/createMoneyOrder:
post:
tags:
- 云手机管理
summary: 新建续费云手机
operationId: vsphone_api_padApi_createMoneyOrder_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):androidVersionName,goodId,goodNum,autoRenew,equipmentId
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/userPadList:
post:
tags:
- 云手机管理
summary: 云手机列表
operationId: vsphone_api_padApi_userPadList_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):"padCode,equipmentIds[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/padInfo:
post:
tags:
- 云手机管理
summary: 云手机信息查询
operationId: vsphone_api_padApi_padInfo_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):padCode
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/getCloudGoodList:
get:
tags:
- 云手机管理
summary: sku套餐列表
operationId: vsphone_api_padApi_getCloudGoodList_get
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):androidVersion
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/createMoneyProOrder:
post:
tags:
- 云手机管理
summary: 设备预售购买
operationId: vsphone_api_padApi_createMoneyProOrder_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):androidVersionName,goodId,goodNum,autoRenew
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/queryProOrderList:
post:
tags:
- 云手机管理
summary: 查询预售订单结果详情
operationId: vsphone_api_padApi_queryProOrderList_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):proBuyStatus,orderId
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/imageVersionList:
post:
tags:
- 云手机管理
summary: 安卓镜像版本集合
operationId: vsphone_api_padApi_imageVersionList_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):padCode
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/autoTaskList:
post:
tags:
- TK自动化
summary: 自动化任务列表查询
operationId: vsphone_api_padApi_autoTaskList_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):"taskIds[],taskType,page,rows"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/addAutoTask:
post:
tags:
- TK自动化
summary: 创建自动化任务
operationId: vsphone_api_padApi_addAutoTask_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):"taskName,remarks,taskType,list[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/reExecutionAutoTask:
post:
tags:
- TK自动化
summary: 自动化任务重试
operationId: vsphone_api_padApi_reExecutionAutoTask_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):"taskIds[],plannedExecutionTime"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/cancelAutoTask:
post:
tags:
- TK自动化
summary: 自动化任务取消
operationId: vsphone_api_padApi_cancelAutoTask_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):"taskIds[]"
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/stsToken:
get:
tags:
- SDK Token
summary: 获取SDK临时Token
operationId: vsphone_api_padApi_stsToken_get
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):无
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/stsTokenByPadCode:
post:
tags:
- SDK Token
summary: 根据padCode获取SDK临时token
operationId: vsphone_api_padApi_stsTokenByPadCode_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):padCode
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
/vsphone/api/padApi/clearStsToken:
post:
tags:
- SDK Token
summary: 清除SDK授权Token
operationId: vsphone_api_padApi_clearStsToken_post
description: |
请求参数(名称/类型以 OpenAPI.md 对应接口为准):token
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 见 OpenAPI.md 该接口请求Body/参数表
responses:
"200":
description: 成功时返回 JSON,结构为 { code, msg, ts, data },code=200 表示成功
content:
application/json:
schema:
$ref: "#/components/schemas/ApiResponse"
components:
securitySchemes:
VSPhoneHMAC:
type: http
scheme: custom
description: |
HMAC-SHA256 签名验证。请求头必须包含:
x-date(UTC 时间 ISO 8601)、x-host(api.vsphone.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:
ApiResponse:
type: object
properties:
code:
type: integer
description: 业务码,200 表示成功
msg:
type: string
description: 提示信息
ts:
type: integer
description: 时间戳
data:
description: 业务数据,结构见 OpenAPI.md 各接口响应参数
规范内容说明
- 接口范围:与 OpenAPI.md 中接口概览一致,包含实例管理、资源管理、应用管理、任务管理、云手机管理、TK 自动化、SDK Token 等全部接口。
- 请求/响应语义:路径、方法、摘要及参数名称与 OpenAPI.md 对应接口一致;详细参数类型、是否必填、示例等以 OpenAPI.md 为准。
- 认证方式:全局使用 HMAC-SHA256 签名(请求头
x-date、x-host、Content-Type、authorization),计算方式见本站 使用指南(example.md)。
使用建议
- AI / 大模型:将上述
openapi.yaml的 URL 或内容提供给 AI,便于生成调用示例、参数说明或 SDK 代码。 - 代码生成:使用 OpenAPI 代码生成器(如 OpenAPI Generator)时,以该 YAML 为输入,并配合本站文档理解业务语义与错误码。
- 调试与测试:可导入 Postman、Insomnia 等工具;认证需自行实现 HMAC-SHA256,参考 example.md。
相关文档
- 接口文档(OpenAPI.md) — 完整接口说明、请求/响应参数与示例
- 使用指南(example.md) — 认证与签名计算
- 开发者速查手册(llms.md) — 文本速查与 AI 参考