接口文档 | ARMCLOUD 文档中心

SDK Token签发

签发临时 STS Token，用于对接入云手机服务的用户进行鉴权。

获取SDK临时Token

接口地址

/openapi/open/token/stsToken

请求方式

GET

请求数据类型

application/json

请求示例

package com.xiaosuan.api.utils;

import com.alibaba.fastjson.TypeReference;
import com.xiaosuan.armcloud.sdk.configure.ArmCloudConfig;
import com.xiaosuan.armcloud.sdk.constant.ArmCloudApiEnum;
import com.xiaosuan.armcloud.sdk.http.DefaultHttpExecutor;
import com.xiaosuan.armcloud.sdk.model.Result;
import com.xiaosuan.armcloud.sdk.service.ArmCloudApiService;
import com.xiaosuan.armcloud.sdk.service.impl.ArmCloudApiServiceImpl;

import java.util.HashMap;

public class test {
    /**
     * 获取sts_token
     * @param args
     * @throws Exception
     */
    public static void main(String[] args) throws Exception {

        ArmCloudConfig armCloudConfig = new ArmCloudConfig();
        armCloudConfig.setOpenUrl("https://xxx");
        armCloudConfig.setService("armcloud-paas");
        armCloudConfig.setHost("xxx");
        armCloudConfig.setAk("xxxxxx");
        armCloudConfig.setSk("xxxxxx");
        ArmCloudApiService armcloudApiService = new ArmCloudApiServiceImpl(armCloudConfig, new DefaultHttpExecutor());
        Result<Object> result = armcloudApiService.execute(ArmCloudApiEnum.STS_TOKEN,new HashMap<>(), new TypeReference<Result<Object>>() {});
        System.out.println(result);

    }
}

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object
├─token	18df5803-48ce-4b53-9457-6a15feb1daca	String	sdk通信token

响应示例

{
 "code": 200,
 "msg": "success",
 "ts":1713773577581,
 "data": {
  "token": "18df5803-48ce-4b53-9457-6a15feb1daca"
 }
}

获取SDK临时Token(根据padCode)

签发临时 STS Token，用于对接入云手机服务的用户进行鉴权(该token只能用于请求的padCode)。

接口地址

/openapi/open/token/stsTokenByPadCode

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
padCode	AC32010230001	String	是	实例code

请求示例

{"padCode":"AC32010230001"}

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object
├─token	18df5803-48ce-4b53-9457-6a15feb1daca	String	sdk通信token

响应示例

{"code":200,"msg":"success","ts":1735209109185,"data":{"token":"8c443217-6950-4e69-92ba-0e21a2b9a71d,MoreLogin"}}

清除SDK授权Token

接口地址

/openapi/open/token/clearStsToken

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
token	123	String	是

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object

响应示例

{
 "code": 200,
 "msg": "success",
 "ts":1713773577581,
 "data": null
}

错误码

错误码	错误说明	操作建议
120008	token不属于当前用户	参考接口说明，检查请求参数和传值

服务器管理

ARM服务器列表

根据查询条件分页获取ARM列表。

接口地址

/openapi/open/armServer/list

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
page	1	Integer	是	页码
rows	10	Integer	是	条数
clusterCode	001	String	否	集群编号
armServerCode	ACS32010260000	String	否	服务器编号
armSn	XS-MARS3500SA-0019	String	否	armSn
armIp	192.168.230.100	String	否	armIp
idc	1	String	否	机房id
online	1	String	否	在线状态

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer
msg	success	String
ts	1713773577581	Long
data		Object
├─page	1	Integer	当前页
├─rows	10	Integer	每页的数量
├─size	1	Integer	当前页的数量
├─total	1	Integer	总记录数
├─totalPage	1	Integer	总页数
├─pageData		object[]	列表
├─├─clusterCode	001	String	集群代码
├─├─armServerCode	ACS32010260000	String	ARM服务器代码
├─├─armSn	XS-MARS3500SA-0019	String	ARM服务器序列号
├─├─armIp	192.168.230.100	String	ARM服务器IP地址
├─├─deviceSubnet	172.31.3.0/24	Integer	设备子网
├─├─status	1	Integer	状态 0-停用 1-启用
├─├─online	1	Integer	在线状态 0-离线 1-在线 2-添加中 3-添加失败
├─├─macVlan	eth0.100	String	MAC地址和VLAN信息
├─├─chassisLabel	XS-MARS3500SA-0019	String	机箱标签
├─├─chassisCabinetU	KG33/29-30	String	机箱中的机柜U位
├─├─gatewayPadId	8	Integer	网关板卡ID
├─├─gatewayDeviceId	18	String	网关设备ID
├─├─idc	1	String	机房id

请求示例

{
    "clusterCode": "001",
        "armServerCode": "ACS32010260000",
        "armSn": "XS-MARS3500SA-0019",
        "armIp": "192.168.230.100",
        "online": "1"
}

响应示例

{
    "code": 200,
        "msg": "success",
        "ts": 1737625066716,
        "data": {
        "page": 1,
            "rows": 10,
            "size": 1,
            "total": 1,
            "totalPage": 1,
            "pageData": [
            {
                "page": 1,
                "rows": 10,
                "clusterCode": "001",
                "armServerCode": "ACS32010260000",
                "armServerName": null,
                "armSn": "XS-MARS3500SA-0019",
                "armIp": "192.168.230.100",
                "deviceSubnet": "172.31.3.0/24",
                "status": "1",
                "online": true,
                "macVlan": "eth0.100",
                "chassisLabel": "XS-MARS3500SA-0019",
                "chassisCabinetU": "KG33/29-30",
                "gatewayPadId": "8",
                "gatewayDeviceId": "18"
            }
        ]
    }
}

板卡管理

板卡列表

根据查询条件分页获取ARM列表。

接口地址

/openapi/open/device/list

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
page	1	Integer	是	页码
rows	10	Integer	是	条数
padAllocationStatus	2	Integer	否	实例分配状态：-2删除失败 -1分配失败 0-未分配；1-分配中 2-已分配 3-删除中
deviceStatus	1	Integer	否	物理机状态 0-离线；1-在线
armServerCode	XS-MARS3500SA-0019	String	否	服务器code
deviceCode	192.168.230.100	String	否	板卡code
deviceIp	172.31.3.3	String	否	deviceIp
armServerStatus	1	Integer	否	服务器状态 0-离线；1-在线
idc	1	String	否	机房Id
deviceIpList		String[]	否
├─	172.31.3.3	String	否	板卡IP

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer
msg	success	String
ts	1713773577581	Long
data		Object
├─page	1	Integer	当前页
├─rows	10	Integer	每页的数量
├─size	1	Integer	当前页的数量
├─total	1	Integer	总记录数
├─totalPage	1	Integer	总页数
├─pageData		object[]	列表
├─├─id	11236	Integer	板卡id
├─├─deviceLevel	m2-3	String	云机实例级别
├─├─deviceCode	AC32010250020	String	物理机编号
├─├─deviceOutCode	03-58614134b4357321	String	外部物理机编码
├─├─deviceStatus	172.31.3.0/24	Integer	物理机状态 0-离线；1-在线
├─├─deviceIp	172.31.3.3	Integer	物理机IP
├─├─idc	1	Integer	外部机房编码
├─├─armServerCode	ACS32010260000	String	ARM服务器编码
├─├─createBy	admin	String	创建者
├─├─createTime	2025-01-02 10:56:13	String	创建时间
├─├─padAllocationStatus	2	Integer	实例分配状态：-2删除失败 -1分配失败 0-未分配；1-分配中 2-已分配 3-删除中
├─├─clusterCode	001	String	集群code
├─├─macAddress	52:74:01:b8:58:40	String	MAC地址
├─├─initStatus	1	String	初始化状态 0-初始化失败 1-初始化成功 2-初始化中
├─├─cbsInfo	2.0.8	String	板卡CBS信息
├─├─nodeId	1	String	刀片ID
├─├─position	3	String	卡槽位置
├─├─gateway	192.168.3.1	String	板卡网关

请求示例

{
    "padAllocationStatus": 2,
        "deviceStatus": 1,
        "armServerCode": "ACS32010260000",
        "deviceCode": "AC32010250020",
        "deviceIpList": [
        "172.31.3.3"
    ],
        "deviceIp": "172.31.3.3",
        "armServerStatus": 1
}

响应示例

{
    "code": 200,
        "msg": "success",
        "ts": 1737626655161,
        "data": {
        "page": 1,
            "rows": 10,
            "size": 1,
            "total": 1,
            "totalPage": 1,
            "pageData": [
            {
                "page": 1,
                "rows": 10,
                "id": 11236,
                "deviceLevel": "m2-3",
                "deviceCode": "AC32010250020",
                "deviceOutCode": "03-58614134b4357321",
                "deviceStatus": true,
                "deviceIp": "172.31.3.3",
                "idc": "1",
                "armServerCode": "ACS32010260000",
                "createBy": "admin",
                "createTime": "2025-01-02 10:56:13",
                "padAllocationStatus": 2,
                "deleteFlag": false,
                "clusterCode": "001",
                "macAddress": "52:74:01:b8:58:40",
                "initStatus": 1,
                "cbsInfo": "2.0.8",
                "nodeId": "1",
                "position": "3",
                "gateway": null
            }
        ]
    }
}

板卡重启

断电重启板卡, 将影响板卡上创建的所有实例

该接口一般用在重启实例也无法恢复的情况

接口地址

/openapi/open/device/powerReset

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
deviceIps		String[]	是
├─	172.31.4.124	String	是	物理设备IP
type	2	String[]	是	重启类型 2：断电重启

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object[]
├─taskId	1	Integer	任务ID
├─deviceIp	172.31.4.124	String	物理设备IP
├─errorMsg	“”	String	失败的原因
├─deviceOutCode	AC22030010000	String	云机编号

请求示例

{
 "deviceIps": [
  "172.31.4.124"
 ],
 "type":2
}

响应示例

{
    "code": 200,
    "msg": "success",
    "ts": 1713773577581,
    "data": [
        {
            "taskId": 1,
            "deviceIp": "172.31.4.124",
            "errorMsg": null,
            "deviceOutCode": "AC22030010000"
        }
    ]
}

错误码

错误码	错误说明	操作建议
110030	执行断电重启命令失败,参数请求不合规	参数请求不合规
110032	物理IP不存在	请检查物理设备IP是否正确
110033	执行断电重启命令失败	联系相关人员

重置板卡

根据查询条件分页获取ARM列表。

接口地址

/openapi/open/device/resetDevice

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
remark	确认删除	String	是	重置备注信息
deviceIps		String[]	是	物理机Ip列表(最少1个，最大128个)
├─	172.31.3.3	String	是	板卡IP

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	响应码
msg	success	String
ts	1713773577581	Long
data	1个板卡删除实例！	String	消息内容

请求示例

{
    "deviceIps": [
        "172.31.3.3"
    ],
        "remark": "1"
}

响应示例

{
    "msg": "success",
        "code": 200,
        "data": "1个板卡删除实例！",
        "ts": 1739954448827
}

错误码

错误码	错误说明	操作建议
110060	板卡不存在	确认下板卡IP是否正确

实例管理

修改实例WIFI属性

修改指定实例的WIFI列表属性（此接口与一建新机设置WIFI二选一，否则会出现覆盖问题）

接口地址

/openapi/open/pad/setWifiList

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
padCodes		String[]	是	实例编号
wifiJsonList		String[]	是	wifi属性列表
├─SSID	110101	String	是	wifi名称 (不支持中文)
├─BSSID	02:31:00:00:00:01	String	是	接入点mac地址
├─MAC	02:00:10:00:00:00	String	是	wifi网卡mac地址
├─IP	02:00:10:00:00:00	String	是	wifi网络IP
├─MAC	02:00:10:00:00:00	String	是	wifi网卡mac地址
├─gateway	192.168.120.1	String	是	wifi网关
├─DNS1	1.1.1.1	String	是	DNS1
├─DNS2	8.8.8.8	String	是	DNS2
├─hessid	0	Integer	否	网络标识符
├─anqpDomainId	0	Integer	否	ANQP（Access Network Query Protocol）域ID
├─capabilities	""	String	否	WPA/WPA2等信息
├─level	0	Integer	否	信号强度（RSSI）
├─linkSpeed	500	Integer	否	当前Wi-Fi连接速率
├─txLinkSpeed	600	Integer	否	上传链路速度
├─rxLinkSpeed	700	Integer	否	下载链路速度
├─frequency	2134	Integer	否	Wi-Fi信道频率
├─distance	-1	Integer	否	估算的AP距离
├─distanceSd	-1	Integer	否	估算距离的标准差
├─channelWidth	0	Integer	否	信道带宽
├─centerFreq0	0	Integer	否	中心频率0
├─centerFreq1	-1	Integer	否	中心频率1
├─is80211McRTTResponder	false	Boolean	否	是否支持 802.11mc（Wi-Fi RTT，测距技术

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object
├─ taskId	1	Integer	任务ID
├─ padCode	AC2025030770R	String	实例编号
├─ vmStatus	1	Integer	实例在线状态：0-离线，1-在线

请求示例

{
    "padCodes":["AC2025030770R92X"],
        "wifiJsonList":[
        {
            "SSID": "110101",
            "BSSID": "02:31:00:00:00:01",
            "MAC": "02:00:10:00:00:00",
            "IP": "192.168.120.15",
            "gateway": "192.168.120.1",
            "DNS1": "1.1.1.1",
            "DNS2": "8.8.8.8",
            "hessid": 0,
            "anqpDomainId": 0,
            "capabilities": "",
            "level": 0,
            "linkSpeed": 500,
            "txLinkSpeed": 600,
            "rxLinkSpeed": 700,
            "frequency": 2413,
            "distance": -1,
            "distanceSd": -1,
            "channelWidth": 0,
            "centerFreq0": -1,
            "centerFreq1": -1,
            "is80211McRTTResponder": true
        }
    ]
}

响应示例

{
    "code": 200,
        "msg": "success",
        "ts": 1741676855566,
        "data": [
        {
            "taskId": 14904,
            "padCode": "AC2025030770R92X",
            "vmStatus": 0
        }
    ]
}

实例详情

查询指定实例的属性信息，包括系统属性信息和设置信息。

接口地址

/openapi/open/pad/padDetails

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
page	1	Integer	否	页码
rows	10	Integer	否	每页记录数
padCodes		String[]	否
├─	AC21020010391	String	否	实例编号
padIps		String[]	否
├─	192.168.1.1	String	否	实例ip
vmStatus	1	String	否	实例在线状态：0-离线，1-在线
controlStatus	1	String	否	受控状态（推流状态）：1-非受控，2-受控
faultStatus	14	String	否	实例运行状态 14-异常其他-正常
deviceStatus	0	String	否	物理机在线状态：0-离线，1-在线
groupId	2	Integer	否	分组ID
idcCode	HNCS-C-01	String	否	机房编号

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object
├─ page	1	Integer	当前页
├─ rows	10	Integer	每页的数量
├─ size	1	Integer	当前页的数量
├─ total	1	Integer	总记录数
├─ totalPage	1	Integer	总页数
├─ pageData		object[]	列表
├─ ├─ padCode	VP21020010391	String	实例编号
├─ ├─ imageId	andorid:v10	String	镜像ID
├─ ├─ deviceLevel	q2-6	String	实例规格（q2-6六开，q2-4四开）
├─ ├─ padStatus	12	Integer	实例状态（10-运行中 11-重启中 12-重置中 13-升级中 14-异常 15-未就绪）
├─ ├─ deviceStatus	1	Integer	物理机状态（0-离线，1-在线）
├─ ├─ online	1	Integer	实例在线状态（0-离线，1-在线）
├─ ├─ streamStatus	0	Integer	实例推流状态（ 0-空闲 1-推流中）
├─ ├─ dataSize	234493726720	Long	存储总容量(字节)
├─ ├─ dataSizeUsed	179189956608	Long	存储已使用容量(字节)
├─ ├─ dcInfo		Object	机房信息
├─ ├─ ├─ dcCode	dc01	String	机房编码
├─ ├─ ├─ dcName	长沙-01	String	机房名称
├─ ├─ ├─ area	长沙	String	地区
├─ ├─ ├─ ossEndpoint	https://xxx.armcloud.net	String	OSS公网接口地址
├─ ├─ ├─ ossEndpointInternal	https://xxx.armcloud.net	String	OSS内网接口地址
├─ ├─ ├─ ossFileEndpoint	https://xxx.armcloud.net	String	访问文件地址
├─ ├─ ├─ ossScreenshotEndpoint	https://xxx.armcloud.net	String	访问截图地址

请求示例

{
 "page": 1,
 "rows": 10,
 "padCodes": ["AC21020010391"],
 "padIps":["192.168.1.1"],
 "vmStatus":"1",
 "controlStatus":"1",
 "faultStatus":"14",
 "deviceStatus":"0"
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts":1713773577581,
 "data": {
  "page": 1,
  "rows": 10,
  "size": 1,
  "total": 1,
  "totalPage": 1,
  "pageData": [
   "padCode": "AC21020010391",
   "imageId": "andorid:v10",
   "deviceLevel": "q2-6",
   "dcInfo": {
    "dcCode": "dc01",
    "dcName": "长沙-01",
    "area": "长沙",
    "ossEndpoint": "https://xxx.armcloud.net",
    "ossEndpointInternal": "https://xxx.armcloud.net",
    "ossFileEndpoint": "https://xxx.armcloud.net",
    "ossScreenshotEndpoint": "https://xxx.armcloud.net",
   },
   "padStatus": 12,
   "deviceStatus": 1,
   "online": 1,
   "streamStatus": 0,
   "dataSize": 234493726720,
   "dataSizeUsed": 179189956608
  ]
 }
}

代码示例

// java 调用示例
PadDetailsRequest requestParam = new PadDetailsRequest();
List<String> padCodes = new ArrayList<>();
padCodes.add("AC22010041147");
requestParam.setPadCodes(padCodes);
Result<Page<PadDetailsResponse>> result = armCloudApiService.execute(ArmCloudApiEnum.PAD_DETAILS, requestParam,new TypeReference<Result<Page<PadDetailsResponse>>>() {});

实例重启

对指定实例执行重启操作，用以解决系统无响应、卡死等问题。

接口地址

/openapi/open/pad/restart

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
padCodes		String[]	是
├─	AC21020010001	String	是	实例编号
groupIds		Integer[]	否
├─	1	Integer	否	实例组ID

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object[]
├─taskId	1	Integer	任务ID
├─padCode	AC21020010001	String	实例编号
├─vmStatus	1	Integer	实例在线状态（0：离线；1：在线）

请求示例

{
 "padCodes": [
  "AC22030022693"
 ],
 "groupIds": [1]
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts":1713773577581,
 "data":[
    {
    "taskId": 1,
    "padCode": "AC21020010001",
    "vmStatus": 1
    }
   ]
}

错误码

错误码	错误说明	操作建议
10001	重启失败	联系管理员
110004	执行重启命令失败	稍后再次重启
110028	实例不存在	请检查实例是否存在

代码示例

// java 调用示例
public class SDKExample {
    private final ArmCloudApiService armCloudApiService;

    public SDKExample() {
        ArmCloudConfig armCloudConfig = new ArmCloudConfig();
        armCloudConfig.setOpenUrl("https://openapi-hk.armcloud.net");
        armCloudConfig.setService("armcloud-paas");
        armCloudConfig.setHost("openapi.armcloud.net");
        armCloudConfig.setAk("your access_key_id");
        armCloudConfig.setSk("your secret_access_key");
        armCloudApiService = new ArmCloudApiServiceImpl(armCloudConfig, new DefaultHttpExecutor());
    }

    @Test
    public void test() throws Exception {
        RestartRequest requestParam = new RestartRequest();
        List<String> padCodes = new ArrayList<>();
        padCodes.add("AC22010041147");
        requestParam.setPadCodes(padCodes);
        Result<PadTaskResponse> result = armCloudApiService.execute(ArmCloudApiEnum.PAD_RESTART, requestParam, new TypeReference<Result<PadTaskResponse>>() {});
    }
}

实例重置

注意：实例重置清除系统所有数据。请谨慎使用,每次重置之后会将公网IP恢复到默认值

对实例执行重置操作，将会清理云机所有数据

接口地址

/openapi/open/pad/reset

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
padCodes		String[]	是
├─	AC21020010001	String	是	实例编号
groupIds		Integer[]	否
├─	1	Integer	否	实例组ID

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object[]
├─taskId	1	Integer	任务ID
├─padCode	AC21020010001	String	实例编号
├─vmStatus	1	Integer	实例在线状态（0：离线；1：在线）

请求示例

{
 "padCodes": [
  "AC21020010001"
 ],
 "groupIds": [1]
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts": 1717559681604,
 "data": [
  {
   "taskId": 88,
   "padCode": "AC22030010001",
   "vmStatus": 1
  },
  {
   "taskId": 89,
   "padCode": "AC22030010002",
   "vmStatus": 0
  }
 ]
}

错误码

错误码	错误说明	操作建议
10002	重置失败	联系管理员
110005	执行重置命令失败	稍后再次重置

代码示例

// java 调用示例
 ResetRequest requestParam = new ResetRequest();
List<String> padCodes = new ArrayList<>();
padCodes.add("AC22010041147");
requestParam.setPadCodes(padCodes);
Result<PadTaskResponse> result = armCloudApiService.execute(ArmCloudApiEnum.PAD_RESET, requestParam, new TypeReference<Result<PadTaskResponse>>() {});

查询实例属性

查询指定实例的属性信息，包括系统属性信息和设置信息。

接口地址

/openapi/open/pad/padProperties

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
padCode	AC21020010001	String	是	实例编号

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object
├─padCode	AC21020010001	String	实例编号
├─modemPropertiesList		Object[]	Modem-属性列表
├─├─propertiesName	IMEI	String	属性名称
├─├─propertiesValue	412327621057784	String	属性值
├─systemPropertiesList		Object[]	系统-属性列表
├─├─propertiesName	ro.build.id	String	属性名称
├─├─propertiesValue	QQ3A.200805.001	String	属性值
├─settingPropertiesList		Object[]	setting-属性列表
├─├─propertiesName	ro.build.tags	String	属性名称
├─├─propertiesValue	release-keys	String	属性值
├─oaidPropertiesList		Object[]	oaid-属性列表
├─├─propertiesName	oaid	String	属性名称
├─├─propertiesValue	001	String	属性值

请求示例

{
 "padCode": "AC21020010001"
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts":1713773577581,
 "data": {
  "padCode": "AC21020010001",
  "modemPropertiesList": [
   {
    "propertiesName": "IMEI",
    "propertiesValue": "412327621057784"
   }
  ],
  "systemPropertiesList": [
   {
    "propertiesName": "ro.build.id",
    "propertiesValue": "QQ3A.200805.001"
   }
  ],
  "settingPropertiesList": [
   {
    "propertiesName": "ro.build.tags",
    "propertiesValue": "release-keys"
   }
  ],
  "oaidPropertiesList": [
   {
    "propertiesName": "oaid",
    "propertiesValue": "001"
   }
  ]
 }
}

错误码

错误码	错误说明	操作建议
110028	实例不存在	请检查实例是否正确

代码示例

// java 调用示例
PadPropertiesRequest requestParam = new PadPropertiesRequest();
requestParam.setPadCode("AC22010041147");
Result<PadPropertiesResponse> result = armCloudApiService.execute(ArmCloudApiEnum.PAD_GET_PROPERTIES, requestParam,new TypeReference<Result<PadPropertiesResponse>>() {});

批量查询实例属性

批量查询指定实例的属性信息，包括系统属性信息和设置信息。

接口地址

/openapi/open/pad/batchPadProperties

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
padCodes		String[]	是
├─	AC21020010001	String	是	实例编号
├─	AC21020010002	String	是	实例编号

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object[]
├─padCode	AC21020010001	String	实例编号
├─modemPropertiesList		Object[]	Modem-属性列表
├─├─propertiesName	IMEI	String	属性名称
├─├─propertiesValue	412327621057784	String	属性值
├─systemPropertiesList		Object[]	系统-属性列表
├─├─propertiesName	ro.build.id	String	属性名称
├─├─propertiesValue	QQ3A.200805.001	String	属性值
├─settingPropertiesList		Object[]	setting-属性列表
├─├─propertiesName	ro.build.tags	String	属性名称
├─├─propertiesValue	release-keys	String	属性值
├─oaidPropertiesList		Object[]	oaid-属性列表
├─├─propertiesName	oaid	String	属性名称
├─├─propertiesValue	001	String	属性值

请求示例

{
    "padCodes": [
        "AC21020010001",
        "AC21020010002"
    ]
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts":1713773577581,
 "data": [
        {
            "padCode": "AC21020010001",
            "modemPropertiesList": [
                {
                    "propertiesName": "IMEI",
                    "propertiesValue": "412327621057784"
                }
            ],
            "systemPropertiesList": [
                {
                    "propertiesName": "ro.build.id",
                    "propertiesValue": "QQ3A.200805.001"
                }
            ],
            "settingPropertiesList": [
                {
                    "propertiesName": "ro.build.tags",
                    "propertiesValue": "release-keys"
                }
            ],
            "oaidPropertiesList": [
                {
                    "propertiesName": "oaid",
                    "propertiesValue": "001"
                }
            ]
        },
        {
            "padCode": "AC21020010002",
            "modemPropertiesList": [
                {
                    "propertiesName": "IMEI",
                    "propertiesValue": "412327621057784"
                }
            ],
            "systemPropertiesList": [
                {
                    "propertiesName": "ro.build.id",
                    "propertiesValue": "QQ3A.200805.001"
                }
            ],
            "settingPropertiesList": [
                {
                    "propertiesName": "ro.build.tags",
                    "propertiesValue": "release-keys"
                }
            ],
            "oaidPropertiesList": [
                {
                    "propertiesName": "oaid",
                    "propertiesValue": "001"
                }
            ]
        }
    ]
}

错误码

错误码	错误说明	操作建议
110028	实例不存在	请检查实例是否正确

代码示例

// java 调用示例
PadPropertiesRequest requestParam = new PadPropertiesRequest();
List<String> padCodes = new ArrayList<>();
padCodes.add("AC21020010001");
padCodes.add("AC21020010002");
requestParam.setPadCodes(padCodes);
Result<List<PadPropertiesResponse>> result = armCloudApiService.execute(ArmCloudApiEnum.PAD_POST_PROPERTIES, requestParam,new TypeReference<Result<PadPropertiesResponse>>() {});

修改实例属性

动态修改实例的属性信息，包括系统属性和设置

实例需要处于开机状态，该接口为即时生效

参考实例属性列表

接口地址

/openapi/open/pad/updatePadProperties

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
padCodes		String[]	是
├─	AC21020010001	String	是	实例编号
modemPersistPropertiesList		Object[]	否	Modem-持久化-属性列表
├─propertiesName	IMEI	String	否	属性名称
├─propertiesValue	412327621057784	String	否	属性值
modemPropertiesList		Object[]	否	Modem-非持久化-属性列表
├─propertiesName	IMEI	String	否	属性名称
├─propertiesValue	412327621057784	String	否	属性值
systemPersistPropertiesList		Object[]	否	系统-持久化-属性列表
├─propertiesName	ro.build.id	String	否	属性名称
├─propertiesValue	QQ3A.200805.001	String	否	属性值
systemPropertiesList		Object[]	否	系统-非持久化-属性列表
├─propertiesName	ro.build.id	String	否	属性名称
├─propertiesValue	QQ3A.200805.001	String	否	属性值
settingPropertiesList		Object[]	否	setting-属性列表
├─propertiesName	ro.build.tags	String	否	属性名称
├─propertiesValue	release-keys	String	否	属性值
oaidPropertiesList		Object[]	否	oaid-属性列表
├─propertiesName	oaid	String	否	属性名称
├─propertiesValue	001	String	否	属性值

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object[]
├─taskId	1	Integer	任务ID
├─padCode	AC21020010001	String	实例编号
├─vmStatus	1	Integer	实例在线状态（0：离线；1：在线）

请求示例

{
 "padCodes": [
  "AC21020010001"
 ],
 "modemPersistPropertiesList": [
   {
    "propertiesName": "IMEI",
    "propertiesValue": "412327621057784"
   }
  ],
 "modemPropertiesList": [
   {
    "propertiesName": "IMEI",
    "propertiesValue": "412327621057784"
   }
  ],
  "systemPersistPropertiesList": [
   {
    "propertiesName": "ro.build.id",
    "propertiesValue": "QQ3A.200805.001"
   }
  ],
  "systemPropertiesList": [
   {
    "propertiesName": "ro.build.id",
    "propertiesValue": "QQ3A.200805.001"
   }
  ],
  "settingPropertiesList": [
   {
    "propertiesName": "ro.build.tags",
    "propertiesValue": "release-keys"
   }
  ],
  "oaidPropertiesList": [
   {
    "propertiesName": "oaid",
    "propertiesValue": "001"
   }
  ]
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts": 1717570916196,
 "data": [
  {
   "taskId": 36,
   "padCode": "AC22030010001",
   "vmStatus": 1
  }
 ]
}

错误码

错误码	错误说明	操作建议
110011	执行修改属性命令失败	请稍后重试
110028	实例不存在	请检查实例是否正确
110027	实例编号集合存在重复项	请检查实例是否存在重复的

代码示例

// java 调用示例
UpdatePadPropertiesRequest requestParam = new UpdatePadPropertiesRequest();
List<String> padCodes = new ArrayList<>();
padCodes.add("AC22010041147");
requestParam.setPadCodes(padCodes);

List<PadPropertiesSub> subs = new ArrayList<>();
PadPropertiesSub sub = new PadPropertiesSub();
sub.setPropertiesName("oaid");
sub.setPropertiesValue("123456789");
subs.add(sub);
requestParam.setSystemPropertiesList(subs);
Result<List<GeneratePadResponse>> result = armCloudApiService.execute(ArmCloudApiEnum.PAD_UPDATE_PROPERTIES, requestParam,new TypeReference<Result<List<GeneratePadResponse>>>() {});

修改实例安卓改机属性

静态设置安卓改机属性，需要重启实例才能够生效，一般用于修改设备信息

该接口与修改实例属性接口的区别在于生效时机，该接口生效时间为每次开机初始化

设置实例属性后，属性数据会持久化存储，重启或重置实例无需再调用该接口

参考安卓改机属性列表

使用该接口需要对安卓系统有一定的理解，部分属性可能会影响实例正常启动，如果改机后，导致实例异常，可以通过调用实例重置接口恢复正常

接口地址

/openapi/open/pad/updatePadAndroidProp

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
padCode	AC32010210001	String	否	实例id
restart	false	Boolean	否	设置完成后自动重启（默认false）
props	{}	Object	是	系统属性（此字段为key-value定义）
├─ro.product.vendor.name	OP52D1L1	String	是	属性设置

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object
├─taskId	24	Long	任务id
├─padCode	AC32010210001	String	实例id

请求示例

{
 "padCode": "AC32010210001",
 "props": {
  "ro.product.vendor.name": "OP52D1L1"
 },
 "restart": false
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts": 1730192434383,
 "data": {
  "taskId": 11,
  "padCode": "AC32010210001"
 }
}

根据国家Code修改SIM卡信息

静态设置安卓改机属性，需要重启实例才能够生效，一般用于修改设备信息

该接口与修改实例安卓改机属性接口具有相同功能.区别在于该接口会随机生成SIM卡信息,并且每次都会重启

设置实例属性后，属性数据会持久化存储，重启或重置实例无需再调用该接口

接口地址

/openapi/open/pad/replacePadAndroidPropByCountry

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
padCode	AC32010210001	String	是	实例id
countryCode	US	String	否	国家code
props	{}	Object	否	系统属性（此字段为key-value定义）
├─ro.product.vendor.name	OP52D1L1	String	否	属性设置

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object
├─taskId	24	Long	任务id
├─padCode	AC32010210001	String	实例id

请求示例

{
    "padCode": "AC32010250001",
        "props": {
        "persist.sys.cloud.phonenum": "1234578998"
    },
    "countryCode": "US"
}

响应示例

{
    "code": 200,
        "msg": "success",
        "ts": 1738910485368,
        "data": {
        "taskId": 14017,
            "padCode": "AC32010250001",
            "vmStatus": 0
    }
}

错误码

错误码	错误说明	操作建议
110065	参数请求不合规,请参考接口文档	检查参数,参考接口文档
120005	实例不存在	请检查实例编号是否正确

停止推流

停止指定实例推流，断开实例连接。

接口地址

/rtc/open/room/dissolveRoom

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
padCodes		String[]	是
├─	AC11010000031	String	是	实例编号
├─	AC22020020700	String	是	实例编号

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object[]
├─successList		Object[]	成功集合
├─├─padCode	AC11010000031	String	实例编号
├─failList		Object[]	失败集合
├─├─padCode	AC22020020700	String	实例编号
├─├─errorCode	120005	Integer	错误码
├─├─errorMsg	实例不存在	String	失败的原因

请求示例

{
    "padCodes": ["AC11010000031","AC22020020700"]
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts":1713773577581,
     "data": {
     "successList": [
              {
                  "padCode": "AC11010000031"
              }
          ],
          "failList": [
      {
                  "padCode": "AC22020020700",
      "errorCode": 120005,
      "errorMsg": "实例不存在"
              }
    ]
     }
}

错误码

错误码	错误说明	操作建议
120005	实例不存在	请检查实例编号是否正确
120004	中止推流错误，指令服务异常	请稍后重试

批量申请RTC连接Token

批量申请当前账号下多个实例的RTC Token连接信息，连接信息根据Pad进行分组返回。

当Pad无法连接时不会返回RTC Toekn信息，msg字段会显示无法连接原因。
目前此接口仅支持生产 ArmcloudRTC Token。如出现此接口暂不支持此功能等异常消息时请联系相关人员重新配置推流信息
生成的token暂不支持刷新延长有效期。当过期后需重新申请新token
加密数据需使用AES GCM模式解密，密钥为padCode

接口地址

/rtc/open/room/batchApplyToken

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
userId	202	String	是	业务方自定义用户ID，此字段用来生成房间信息。实现一个用户跟GameServer处于一个房间。调用方需做用户级唯一性，如使用同一个userId生成不同的Toekn连接同一个GamerServer会导致上一个已建立的连接断开
expire	3600	Integer	否	token有效期（单位：秒。默认86400）
pads		Object[]	是	实例列表
├─padCode	AC11010000031	String	是	实例编号
├─videoStream		Object	否	推流配置
├─├─resolution	07	String	否	分辨率
├─├─frameRate	30	String	否	帧率
├─├─bitrate	2000	String	否	码率

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object[]
├─roomToken	001j7Tb2jAyAzR6UtLv3cgclCFhw6Q==	String	token
├─roomCode	AC22030010181202	String	房间号
├─appId	j7Tb2GcE9rN5oF6xP3A4qwer	String	应用ID
├─padCode	AC22030010181	String	实例ID
├─signalServer	LnBbVX44uyoN1kXp:P8H01PaGZDHEFD	String	信令地址(需使用AES GCM模式解密)
├─stuns	pL25iYgaRNmdCYR/:SUJBz4S6HE88GzVN	String	stuns地址(需使用AES GCM模式解密)
├─turns	do2k7Z6OiVP1br29:rR4d6Vyk9e	String	turns地址(需使用AES GCM模式解密)
├─msg	connect pad fail	String	错误信息

请求示例

{
 "userId": "202",
 "expire": 3600,
 "pads": [
  {
   "padCode": "AC22010010842",
   "videoStream ": {
    "resolution": "1",
    "frameRate": "30",
    "bitrate": "2000"
   }
  },
  {
   "padCode": "AC22030010181",
   "videoStream ": {
    "resolution": "1",
    "frameRate": "30",
    "bitrate": "2000"
   }
  }
 ]
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts": 1721305008916,
 "data": [
  {
   "roomToken": null,
   "roomCode": "AC22010010842202",
   "appId": "j7Tb2GcE9rN5oF6xP3A4qwer",
   "streamType": 2,
   "videoCodec": "",
   "reportSdkLog": false,
   "padCode": "AC22010010842",
   "msg": "connect pad fail",
   "signalServer": null,
   "stuns": null,
   "turns": null
  },
  {
   "roomToken": "001j7Tb2GcE9rN5oF6xP3A4qwerNwDyCHIRtQrGxZABAAC1ZuzKkAEAABAAQUMyMjAzMDAxMDE4MTIwMgMAMjAyAQAEALVm7MqQAQAAIABpLvj5zX3dnyN/8UvRsLJnHWA4zR6UtLv3cgclCFhw6Q==",
   "roomCode": "AC22030010181202",
   "appId": "j7Tb2GcE9rN5oF6xP3A4qwer",
   "streamType": 2,
   "videoCodec": "",
   "reportSdkLog": false,
   "padCode": "AC22030010181",
   "msg": null,
   "signalServer": "LnBbVX44uyoN1kXp:P8H01PaGZDHEFDsnU6nRCbOFzvL2smbG9HxKh+XP5WHC",
   "stuns": "pL25iYgaRNmdCYR/:SUJBz4S6HE88GzVN8rANlfL9925iaHW+ilJAaWldPpoBKqwoEq0Ggon0HhDc4a6v0pg=",
   "turns": "do2k7Z6OiVP1br29:rR4d6Vyk9efIFX6qPPMyKs7OhmxFA7xBr65P8NA/Rxb31Js6VOaO3Zrtd3h9uM/mNYUy5mJOQ4j8TJ8DjfBFaEHVNOAcF5tzgbg8iksGhNONfv8hHw=="
  }
 ]
}

错误码

错误码	错误说明	操作建议
120005	实例不存在	请检查实例编号是否正确
120007	此接口暂不支持此功能	联系相关人员更改推流配置

申请RTC共享房间Token

用于实现多个实例在一个房间中，实例接收房间广播消息进行处理与实现获取公共流

房间号生成规则：terimer + userId + paas用户标识例如：terimer = pc，userId=123，paas用户标识=qwer
房间号为：pc123qwer

接口地址

/rtc/open/room/share/applyToken

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
userId	202	String	是	调用方业务用户ID
terminal	pc	String	是	终端
expire	3600	Integer	否	token有效期单位秒。默认1小时
pushPublicStream	true	Boolean	否	是否推送公共流（默认false）
pads		Array	是	需要加入共享房间的实例列表
├─padCode	AC22010010842	String	是	实例id
├─├─videoStream		Object	否	推流配置
├─├─├─videoStream	1	String	否
├─├─├─frameRate	30	String	否
├─├─├─bitrate	2000	String	否

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object
├─roomToken	00165b749e52467a4016f050b8cQQBjDJKuTAb	String	房间Token
├─roomCode	android_12345	String	房间号
├─appId	65b749e52467a4016f050b8c	String	应用id

请求示例

{
 "userId": "202",
 "terminal": "pc",
 "expire": 3600,
 "pushPublicStream": true,
 "pads": [
  {
   "padCode": "AC22010010842",
   "videoStream": {
    "resolution": "1",
    "frameRate": "30",
    "bitrate": "2000"
   }
  },
  {
   "padCode": "AC22030010181",
   "videoStream": {
    "resolution": "1",
    "frameRate": "30",
    "bitrate": "2000"
   }
  }
 ]
}

响应示例

{
 "code": 200,
 "msg": null,
 "data": {
  "roomToken": "00165b749e52467a4016f050b8cQQBjDJKuTAbnZVwU52UOAENSTTExMDEwMDAwMDExAwAxMjMFAAAAXBTnZQEAXBTnZQIAXBTnZQMAXBTnZQQAAAAAACAADCbuyT9crLX9MNUCWyFhsFXwb4nuFPxfgE7MqHjv4yQ=",
  "roomCode": "android_12345",
  "appId": "65b749e52467a4016f050b8c"
 }
}

修改实例时区

接口地址

/openapi/open/pad/updateTimeZone

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
timeZone	Asia/Shanghai	String	是	UTC标准时间
padCodes		Array	是	实例列表

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object
├─taskId	24	Long	任务ID
├─padCode	AC22030010001	String	房间号
├─vmStatus	实例状态	Integer	实例在线状态（0：离线；1：在线）

请求示例

{
 "padCodes": [
  "AC32010140003"
 ],
 "timeZone": "Asia/Shanghai"
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts": 1717570663080,
 "data": [
  {
   "taskId": 24,
   "padCode": "AC32010140003",
   "vmStatus": 1
  }
 ]
}

修改实例语言

接口地址

/openapi/open/pad/updateLanguage

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
language	zh	String	是	语言
country	CN	String	否	国家
padCodes		Array	是	实例列表

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object
├─taskId	24	Long	任务ID
├─padCode	AC22030010001	String	房间号
├─vmStatus	实例状态	Integer	实例在线状态（0：离线；1：在线）

请求示例

{
 "padCodes": [
  "AC32010140026"
 ],
 "language": "zh",
 "country": ""
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts": 1717570663080,
 "data": [
  {
   "taskId": 24,
   "padCode": "AC32010140026",
   "vmStatus": 1
  }
 ]
}

修改实例SIM卡信息

接口地址

/openapi/open/pad/updateSIM

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
imei	868034031518269	String	否	IMEI号
operatorShortnam	CMSS	String	否	运营商简称
imsi	460074008004488	String	否	前缀为sim卡运营商号：MCC(3位)+MNC(2位或3位)
phonenum	18511112222	String	否	电话号码
mcc	502	String	否	网络所属国家
mnc	146	String	否	移动设备网络代码
padCodes		Array	是	实例列表
type	1	String	是	网络类型
tac	871420	String	是	追踪区域码
cellid	870091003	String	是	基站 ID
narfcn	99240	String	是	用于 5G 网络中标识信道的频点编号
physicalcellid	6C	String	是	用来标识 5G 或 LTE 网络中的特定小区

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object
├─taskId	24	Long	任务ID
├─padCode	AC22030010001	String	房间号
├─vmStatus	实例状态	Integer	实例在线状态（0：离线；1：在线）

请求示例

{
    "padCodes": ["AC32010230011"],
        "imei": "868034031518269",
        "imeisv": "00",
        "meid": "A0000082C65F6C",
        "operatorLongname": "CHINA MOBILE",
        "operatorShortnam": "CMSS",
        "operatorNumeric": "455555",
        "spn": "China",
        "iccid": "89860002191807255576",
        "imsi": "460074008004488",
        "phonenum": "861234566",
        "netCountry": "US",
        "simCountry": "US",
        "type": "9",
        "mcc": "502",
        "mnc": "146",
        "tac": "871420",
        "cellid": "870091003",
        "narfcn": "99240",
        "physicalcellid": "6C"
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts": 1717570663080,
 "data": [
  {
   "taskId": 24,
   "padCode": "AC32010140033",
   "vmStatus": 1
  }
 ]
}

设置实例经纬度

接口地址

/openapi/open/pad/gpsInjectInfo

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
longitude	116.397455	Float	是	纬度
latitude	39.909187	Float	是	经度
altitude	8	Float	否	海拔 (需要更新到最新镜像)
padCodes		Array	是	实例列表

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Boolean

请求示例

{
 "padCodes": [
  "AC32010030001"
 ],
 "longitude": 116.397455,
 "latitude": 39.909187,
 "altitude": 8
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts": 1717570663080,
 "data": true
}

查询实例代理信息

接口地址

/openapi/open/network/proxy/info

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
padCodes		Array	是	实例列表

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object
├─taskId	24	Long	任务ID
├─padCode	AC22030010001	String	房间号
├─vmStatus	实例状态	Integer	实例在线状态（0：离线；1：在线）

请求示例

{
  "padCodes": [
    "AC32010140012"
  ]
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts": 1726742932284,
 "data": [
  {
   "taskId": 3612,
   "padCode": "AC32010140012",
   "vmStatus": 1
  }
 ]
}

一键新机 ⭐

注意：一键新机会清除系统所有数据。请谨慎使用！

一键新机功能，将当前实例数据全部清空,并重新设置安卓属性

虚拟机直接设置安卓属性,然后清空所有数据
云真机直接清空所有数据(等同于重置),并且添加SIM信息,如果有传入模板id,会替换adi模板.如果没有传入模板,并且replacementRealAdiFlag为true.会随机挑选一个模板Id
注意:如果不传国家信息,或者传入的国家信息服务找不到,会默认设置上新加坡的SIM信息

接口地址

/openapi/open/pad/replacePad

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
padCodes	[]	Array	是	实例id列表
countryCode	SG	String	否	国家编码(具体查看:https://chahuo.com/country-code-lookup.html)
realPhoneTemplateId	65	Long	否	模板id(从/openapi/open/realPhone/template/list接口获取)
androidProp	{"persist.sys.cloud.wifi.mac": "D2:48:83:70:66:0B"}	Object	否	参考安卓改机属性列表
replacementRealAdiFlag	false	Boolean	否	真机是否随机adi模板(false 不随机 true 随机)

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1721739857317	Long	时间戳
data		Object
├─taskId	12818	Long	任务ID
├─padCode	AC22030010124	String	实例编号
├─vmStatus	2	Intger	实例状态

请求示例

{
 "padCodes": ["AC32010250031"],
 "countryCode": "SG",
 "realPhoneTemplateId": 210,
 "androidProp": {
  "persist.sys.cloud.battery.level": "67",
  "persist.sys.cloud.gps.lat": "1.3657",
  "persist.sys.cloud.gps.lon": "103.6464",
  "persist.sys.cloud.imsinum": "525050095718767"
 }
}

响应示例

{
  "code": 200,
  "msg": "success",
  "ts": 1732270378320,
  "data": {
    "taskId": 8405,
    "padCode": "AC32010250031",
    "vmStatus": 2
  }
}

查询一键新机支持国家列表

接口地址

/openapi/open/info/country

请求方式

GET

请求数据类型

application/json

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1721739857317	Long	时间戳
data		Object[]
├─code	AD	String	国家编码
├─name	Andorra	String	国家名称(英文)

响应示例

{
  "code": 200,
  "msg": "success",
  "ts": 1730192434383,
  "data": [{
    "code": "AD",
    "name": "Andorra"
  }]
}

修改通讯录

fileUniqueId和info必填一个

接口地址

/openapi/open/pad/updateContacts

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
padCodes	[]	Array	是	实例id列表
fileUniqueId	cfca25a2c62b00e065b417491b0cf07ffc	String	否	通讯录文件ID
info		Object[]	否	通讯录信息
├─firstName	tom	String	否	姓名
├─phone	13111111111	String	否	手机号
├─email	tom@gmail.com	String	否	邮箱

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1721739857317	Long	时间戳
data		Object
├─taskId	12818	Long	任务ID
├─padCode	AC22030010124	String	实例编号

请求示例

{
  "fileUniqueId": "cfca25a2c62b00e065b417491b0cf07ffc",
  "info": [{
    "firstName": "tom",
    "phone": "13111111111",
    "email": "tom@gmail.com"
  }],
  "padCodes": [
    "AC32010180326"
  ]
}

响应示例

{
  "code": 200,
  "msg": "success",
  "ts": 1730192434383,
  "data": {
    "taskId": 11,
    "padCode": "AC32010210001",
    "vmStatus": 0
  }
}

实例设置代理

接口地址

/openapi/open/network/proxy/set

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
account	2222	String	否	账号
password	2222	String	否	密码
ip	47.76.241.5	String	否	IP
port	2222	Integer	否	端口
enable	true	Boolean	是	启用
padCodes		Array	是	实例列表
proxyType	vpn	String	否	支持参数：proxy、vpn
proxyName	socks5	String	否	支持参数：socks5、http-relay(包含http、https)
bypassPackageList		Array	否	包名设置该包名不走代理
bypassIpList		Array	否	ip 设置该ip不走代理
bypassDomainList		Array	否	域名设置该域名不走代理
sUoT	true	Boolean	否	是否开启udp连接默认为false

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object
├─taskId	24	Long	任务ID
├─padCode	AC22030010001	String	房间号
├─vmStatus	实例状态	Integer	实例在线状态（0：离线；1：在线）

请求示例

{
 "padCodes": [
  "AC32010140023"
 ],
 "account": "2222",
 "password": "2222",
 "ip": "47.76.241.5",
 "port": 2222,
 "enable": true,
    "bypassPackageList":[],
    "bypassIpList":[],
    "bypassDomainList":[],
    "sUoT":true
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts": 1717570663080,
 "data": [
  {
   "taskId": 24,
   "padCode": "AC32010140023",
   "vmStatus": 1
  }
 ]
}

批量实例断网和恢复

接口地址

/openapi/open/network/proxy/interrupt

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
enable	true	Boolean	是	是否断网 true断网 false恢复网络
padCodes		Array	是	实例列表数量范围1-200

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object
├─taskId	24	Long	任务ID
├─padCode	AC22030010001	String	房间号
├─vmStatus	实例状态	Integer	实例在线状态（0：离线；1：在线）

请求示例

{
 "padCodes": [
  "AC32010140023"
 ],
 "enable": true
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts": 1717570663080,
 "data": [
  {
   "taskId": 24,
   "padCode": "AC32010140023",
   "vmStatus": 1
  }
 ]
}

代理检测

接口地址

/openapi/open/network/proxy/detection

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	参数类型	是否必填	参数描述
padCode	String	否	实例编号
proxyHost	String	是	代理ip
proxyPort	Integer	是	代理端口
proxyAccount	String	否	账号
proxyPwd	String	否	密码
proxyType	Integer	否	代理类型 1socks5 2http 默认1

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object
├─connStatus	true	Boolean	连接状态 true连接成功 false连接失败
├─exportIp	62.112.133.68	String	出口ip

请求示例

{
    "padCode":"AC32010150141",
    "proxyHost":"62.112.133.68",
    "proxyPort":26910,
    "proxyAccount":"xxx",
    "proxyPwd":"xxx",
    "proxyType": 1
}

响应示例

{
    "code": 200,
        "msg": "success",
        "ts": 1736765800807,
        "data": {
        "connStatus": true,
        "exportIp": "62.112.133.68"
    }
}

实时查询已安装的应用列表

接口地址

/openapi/open/pad/listInstalledApp

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
padCodes	AC32010250001	String[]	是	实例编号
appName		String	否	应用名称

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object
├─padCode	AC32010250001	String	实例编号
├─apps		Object[]	应用集合
├─├─appName	测试app	String	应用名称
├─├─packageName	com.xxx.xxx	String	包名
├─├─versionCode	150600	String	版本号
├─├─versionName	15.6.0	String	版本名称
├─├─appState	0	Integer	0 已完成 1安装中 2下载中

请求示例

{
 "padCodes": ["AC32010250001"],
 "appName": ""
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts": 1740022125515,
 "data": [{
  "padCode": "AC32010250001",
  "apps": [{
   "appName": "测试app",
   "packageName": "com.xxx.xxx",
   "versionCode": "150600",
   "versionName": "15.6.0"
  }]
 }]
}

设置保活应用

目前只支持安卓14

接口地址

openapi/open/pad/setKeepAliveApp

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
padCodes	AC32010250001	String[]	否	实例编号
applyAllInstances	false	Boolean	是	是否应用所有实例模式
appInfos		Object[]	否
├─serverName	com.zixun.cmp/com.zixun.cmp.service.TaskService	String	是	com.xxx.xxx（包名）/com.xxx.xxx.service.DomeService (需要启动的服务完整路径)

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		null

请求示例

{
 "padCodes": [
  "AC002",
  "AC001"
 ],
 "appInfos": [{
   "serverName": "com.zixun.cmp/com.zixun.cmp.service.TaskService"
  }
 ],
 "applyAllInstances": false
}

响应示例

{
    "code": 200,
        "msg": "success",
        "ts": 1736326542985,
        "data": [{
        "taskId": 10074,
        "padCode": "AC32010250011",
        "errorMsg": null
    }]
}

修改真机ADI模板

修改实例云真机ADI模版, 传入云真机模版ID

必要条件：

实例创建时，需要创建为云真机类型
实例创建时的规格，需要和目标的ADI模版规格一致
实例创建时的安卓版本，需要和目标的ADI安卓版本一致

接口地址

/openapi/open/pad/replaceRealAdiTemplate

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
padCodes		String[]	是
├─	AC21020010001	String	是	实例编号
wipeData	false	Boolean	是	是否清除数据
realPhoneTemplateId	186	Long	是	云真机模板id

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object[]
├─taskId	1	Integer	任务ID
├─padCode	AC21020010001	String	实例编号
├─vmStatus	1	Integer	实例在线状态（0：离线；1：在线）

请求示例

{
 "padCodes": ["AC32010250011"],
 "wipeData": true,
 "realPhoneTemplateId": 186
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts": 1736326542985,
 "data": [{
  "taskId": 10074,
  "padCode": "AC32010250011",
  "errorMsg": null
 }]
}

错误码

错误码	错误说明	操作建议
110028	实例不存在	联系管理员
110064	当前实例中有不满足升级真机条件,请检查实例	检查实例是否是真机
110099	ADI模板不存在,请检查参数	检查ADI模板信息

异步执行ADB命令

在一个或多个云手机实例中异步执行命令

接口地址

/openapi/open/pad/asyncCmd

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
padCodes		String[]	是
├─	AC22020020793	String	是	实例编号
scriptContent	cd /root;ls	String	是	ADB命令，多条命令使用分号隔开

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object[]
├─taskId	1	Integer	任务ID
├─padCode	AC22020020793	String	实例编号
├─vmStatus	1	Integer	实例在线状态（0：离线；1：在线）

请求示例

{
    "padCodes": [
        "AC22020020793"
    ],
    "scriptContent": "cd /root;ls"
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts": 1717570297639,
 "data": [
  {
   "taskId": 14,
   "padCode": "AC22030010001",
   "vmStatus": 1
  },
  {
   "taskId": 15,
   "padCode": "AC22030010002",
   "vmStatus": 0
  }
 ]
}

错误码

错误码	错误说明	操作建议
110003	执行ADB命令失败	联系管理员
110012	命令执行超时	请稍后重试

同步执行ADB命令

在一个或多个云手机实例中同步执行命令

超过5秒未响应则返回超时异常

接口地址

/openapi/open/pad/syncCmd

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
padCode	AC22020020793	String	是	实例ID
scriptContent	cd /root;ls	String	是	ADB命令，多条命令使用分号隔开

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object[]
├─taskId	1	Integer	任务ID
├─padCode	AC22020020793	String	实例编号
├─taskStatus	3	Integer	任务状态（-1：全失败；-2：部分失败；-3：取消；-4：超时；1：待执行；2：执行中；3：完成）
├─taskResult	Success	String	任务结果
├─ errorMsg	调用Adb命令成功	String	错误信息

请求示例

{
    "padCode": "VP21020010231",
    "scriptContent": "cd /root/nbin;ls"
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts":1713773577581,
 "data":[
  {
  "taskId": 1,
  "padCode": "AC22020020793",
  "taskStatus":3,
  "taskResult":"Success",
        "errorMsg":"调用Adb命令成功"
  }
 ]
}

错误码

错误码	错误说明	操作建议
110003	执行ADB命令失败	请稍后重试
110012	命令执行超时	请稍后重试

开关Root权限

在一个或多个云手机实例中开关root权限。开个单个应用root,需要指定包名,否则会抛出异常.(云真机产品，在调用此接口时，不建议设置全局root权限，会有被风控检测到的可能。)

接口地址

/openapi/open/pad/switchRoot

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
padCodes		String[]	是
├─	AC22020020793	String	是	实例编号
globalRoot	false	Boolean	否	是否开启全局root权限，默认不开启
packageName	com.zixun.cmp	String	否	应用包名(非全局root必传)多个包名通过,连接
rootStatus	root开启状态	Integer	是	root状态，0：关闭 1：开启

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object[]
├─taskId	1	Integer	任务ID
├─padCode	AC22020020793	String	实例编号
├─vmStatus	1	Integer	实例在线状态（0：离线；1：在线）

请求示例

{
  "padCodes": [
    "AC32010250002"
  ],
  "globalRoot": false,
  "packageName": "com.android.ftpeasys",
  "rootStatus": 0
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts": 1717570297639,
 "data": [
  {
   "taskId": 14,
   "padCode": "AC32010250002",
   "vmStatus": 1
  }
 ]
}

错误码

错误码	错误说明	操作建议
110003	执行ADB命令失败	联系管理员
110089	开启单个root包名不能为空	开启单个应用root时，包名不能为空

本地截图

实例截图。

接口URL

openapi/open/pad/screenshot

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
padCodes		String[]	是
├─	AC21020010231	String	是	实例编号
rotation	0	Integer	是	截图画面横竖屏旋：0：截图方向不做处理，默认；1：截图画面旋转为竖屏时：a：手机竖屏的截图，不做处理。b：手机横屏的截图，截图顺时针旋转90度。
broadcast	false	Boolean	否	事件是否广播(默认false)
definition	false	Integer	否	清晰度取值范围0-100
resolutionHeight	false	Integer	否	分辨率 - 高大于1
resolutionWidth	false	Integer	否	分辨率 - 宽大于1

响应参数

参数名	示例值	参数类型	是否必填	参数描述
code	200	Integer	是	状态码
msg	success	String	是	响应消息
ts	1756021167163	Long	是	时间戳
data		Object[]
├─taskId	1	Integer	否	任务ID
├─padCode	AC21020010231	String	否	实例编号
├─vmStatus	1	Integer	是	实例在线状态（0：离线；1：在线）

请求示例

{
 "padCodes": [
  "AC21020010231"
 ],
 "rotation": 0,
 "broadcast": false,
    "definition": 50,
    "resolutionHeight": 1920,
    "resolutionWidth": 1080
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts": 1717570337023,
 "data": [
  {
   "taskId": 16,
   "padCode": "AC22030010001",
   "vmStatus": 1
  },
  {
   "taskId": 17,
   "padCode": "AC22030010002",
   "vmStatus": 0
  }
 ]
}

错误码

错误码	错误说明	操作建议
110001	截图失败	请重试
110004	执行重启命令失败	稍后再次重启
110028	实例不存在	请检查实例是否存在

生成预览图

指定的实例获取预览图。

接口地址

/openapi/open/pad/generatePreview

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
padCodes		String[]	是
├─	AC11010000031	String	是	实例编号
rotation	0	Integer	是	截图画面横竖屏旋：0：截图方向不做处理，默认；1：截图画面旋转为竖屏时：a：手机竖屏的截图，不做处理。b：手机横屏的截图，截图顺时针旋转90度。
broadcast	false	Boolean	否	事件是否广播(默认false)
definition	false	Integer	否	清晰度取值范围0-100
resolutionHeight	false	Integer	否	分辨率 - 高大于1
resolutionWidth	false	Integer	否	分辨率 - 宽大于1

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object[]
├─padCode	AC11010000031	String	实例编号
├─accessUrl	http://xxx.armcloud.png	String	访问地址

请求示例

{
    "padCodes": [
        "AC11010000031"
    ],
    "rotation": 0,
    "broadcast": false,
    "definition": 50,
    "resolutionHeight": 1920,
    "resolutionWidth": 1080
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts":1713773577581,
 "data": [
  {
   "padCode": "AC11010000031",
   "accessUrl": "http://xxx.armcloud.png"
  }
 ]
}

升级镜像

批量实例镜像升级

接口地址

/openapi/open/pad/upgradeImage

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
padCodes		String[]	是
├─	AC22030010182	String	是	实例编号
imageId	mg-24061124017	String	是	镜像ID
wipeData	false	Boolean	是	是否清除实例数据(data分区), true清除，false不清除

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object[]
├─padCode	AC22030010182	String	实例编号
├─taskId	1	Integer	任务ID
├─errorMsg	“”	String	错误信息

请求示例

{
    "padCodes": [
        "AC22030010182"
    ],
    "wipeData": false,
    "imageId": "mg-24061124017"
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts": 1718594881432,
 "data": [
  {
   "taskId": 63,
   "padCode": "AC22030010182",
   "errorMsg": null
  }
 ]
}

错误码

错误码	错误说明	操作建议
110041	镜像不存在	镜像id传参有误
110037	执行升级镜像指令失败	实例状态有误，联系管理员
110038	执行升级镜像命令失败	实例状态有误，联系管理员

升级真机镜像

批量实例真机镜像升级

接口地址

/openapi/open/pad/virtualRealSwitch

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
padCodes		String[]	是
├─	AC22030010182	String	是	实例编号
imageId	mg-24061124017	String	是	镜像ID
wipeData	false	Boolean	是	是否清除实例数据(data分区), true清除，false不清除
realPhoneTemplateId	178	Integer	否	真机模板ID upgradeImageConvertType=real时必填
upgradeImageConvertType	virtual	String	是	转换镜像类型 virtual：虚拟机 real：云真机
screenLayoutId	14	Integer	否	屏幕布局ID upgradeImageConvertType=virtual时必填

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object[]
├─padCode	AC22030010182	String	实例编号
├─taskId	1	Integer	任务ID
├─errorMsg	“”	String	错误信息

请求示例

{
    "padCodes": [
        "AC32010210023"
    ],
        "imageId": "img-24112653977",
        "wipeData": true,
        "realPhoneTemplateId": 178,
        "upgradeImageConvertType": "virtual",
        "screenLayoutId": 14
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts": 1718594881432,
 "data": [
  {
   "taskId": 63,
   "padCode": "AC22030010182",
   "errorMsg": null
  }
 ]
}

错误码

错误码	错误说明	操作建议
110041	镜像不存在	镜像id传参有误
110037	执行升级镜像指令失败	实例状态有误，联系管理员
110038	执行升级镜像命令失败	实例状态有误，联系管理员
110064	当前实例中有不满足升级真机条件,请检查实例	当前实例中有不满足升级真机条件,请检查实例

分页获取真机模板

接口地址

/openapi/open/realPhone/template/list

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
pageIndex	1	Integer	否	页码默认1
pageSize	10	Integer	否	每页显示数量默认10 取值范围为1-100
resourceSpecificationCode	m2-4	String	否	规格编号
androidImageVersion	14	String	否	安卓镜像版本

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object[]
├─id	178	Long	id
├─brand	google	String	品牌
├─model	Pixel 7 Pro(12G)	String	型号
├─fingerprintMd5	f5da7b97678ac19309f0cf0203e072d7	String	安卓md5(ro.build.fingerprint)
├─fingerprint	google/cheetah/cheetah:13/TQ3A.230901.001/10750268:user/release-keys	String	安卓ro.build.fingerprint
├─resourceSpecificationCode	m2-3	String	规格编号
├─screenLayoutCode	realdevice_1440x3120x560	String	屏幕布局编码
├─androidImageVersion	13	Integer	安卓镜像版本
├─propertyJson	{"test": "testa"}	String	实例属性

请求示例

{
    "pageIndex": 1,
    "pageSize": 10
}

响应示例

{
    "code": 200,
        "msg": "success",
        "ts": 1733748550410,
        "data": [
        {
            "id": 178,
            "brand": "google",
            "model": "Pixel 7 Pro(12G)",
            "fingerprintMd5": "f5da7b97678ac19309f0cf0203e072d7",
            "fingerprint": "google/cheetah/cheetah:13/TQ3A.230901.001/10750268:user/release-keys",
            "resourceSpecificationCode": "m2-3",
            "screenLayoutCode": "realdevice_1440x3120x560",
            "androidImageVersion": 13,
            "propertyJson": "{\"test\": \"testa\"}"
        }
    ]
}

获取公共屏幕布局列表

接口地址

/openapi/open/screenLayout/publicList

请求方式

POST

请求数据类型

application/json

请求Body参数

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object[]
├─id	12	Long	id
├─code	single-portrait-basic	String	屏幕布局编码
├─screenWidth	1920	String	屏幕宽度
├─screenHigh	1080	String	屏幕高度
├─pixelDensity	320	String	像素密度
├─screenRefreshRate	60	String	屏幕刷新率

请求示例

响应示例

{
    "code": 200,
        "msg": "success",
        "ts": 1733748912002,
        "data": [
        {
            "id": 12,
            "code": "single-portrait-basic",
            "screenWidth": "1080",
            "screenHigh": "1920",
            "pixelDensity": "320",
            "screenRefreshRate": "60"
        }
    ]
}

批量获取实例机型信息

根据实例编号批量获取对应的实例的机型信息。

接口地址

/openapi/open/pad/modelInfo

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
padCodes		String[]	是
├─	AC22030010182	String	是	实例编号

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object[]
├─padCode	AC22030010182	String	实例编号
├─imei	524803173613682	String	IMEI
├─serialno	01NM5ON34M4O	String	序列号
├─wifimac	04:3a:6c:e5:e9:8d:62:d6:4a	String	Wi-Fi的mac地址
├─androidid	aa6bcedf1426546c	String	Android实例唯一标识
├─model	Mi 10 Pro	String	型号
├─brand	Xiaomi	String	品牌
├─manufacturer	Xiaomi	String	厂商
├─isRoot	1	String	是否是ROOT权限
├─width	720	Integer	云手机的宽最大不超过1080
├─height	1280	Integer	云手机的高最大不超过1920
├─memoryLimit	1024	Integer	内存限额
├─bluetoothaddr	3A:1F:4B:9C:2D:8E	String	蓝牙地址
├─phonenum	1112341234	String	手机号码
├─romVersion	android13	String	安卓版本
├─dataSize	2367381504	Integer	内存大小(b)
├─dataSizeAvailable	365830144	Integer	剩余可用(b)
├─dataSizeUsed	1024	2001551360	已使用(b)

请求示例

{
    "padCodes": [
        "AC22030010182"
    ]
}

响应示例

{
  "code": 200,
  "msg": "success",
  "ts": 1756021167163,
  "data": [
    {
      "padCode": "AC22030010182",
      "imei": "524803173613682",
      "serialno": "01NM5ON34M4O",
      "wifimac": "04:3a:6c:e5:e9:8d:62:d6:4a",
      "androidid": "aa6bcedf1426546c",
      "model": "Mi 10 Pro",
      "brand": "Xiaomi",
      "manufacturer": "Xiaomi",
      "isRoot": "1",
      "width": 720,
      "height": 1280,
      "memoryLimit": 1024
    }
  ]
}

添加应用黑名单列表

根据实例规格添加应用黑名单。

接口地址

/openapi/open/appBlack/setUpBlackList

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
padGrade	q2-1	String	是	实例规格
blackApps		Object[]	是	黑名单列表
├─appPkg	cn.v8box.app	String	是	应用包名
├─appName	x8沙箱	String	是	应用名称

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1721647657112	Long	时间戳
data	“”	String

请求示例

{
 "padGrade": "q2-1",
 "blackApps": [
  {
   "appPkg": "cn.v8box.app",
   "appName": "x8沙箱"
  }
 ]
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts": 1721647657112,
 "data": null
}

设置实例黑名单

根据实例规格设置实例黑名单。

接口地址

/openapi/open/pad/triggeringBlacklist

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
padGrade	q2-1	String	是	实例规格
padCodes		String[]	否
├─	AC22030010124	String	否	实例编号

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1721739857317	Long	时间戳
data		Object[]
├─taskId	12818	Integer	任务ID
├─padCode	AC22030010124	String	实例编号
├─vmStatus	1	Integer	实例在线状态（0：离线；1：在线）

请求示例

{
 "padGrade": "q2-4",
 "padCodes": [
  "AC22030010124"
 ]
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts": 1721739857317,
 "data": [
  {
   "taskId": 12818,
   "padCode": "AC22030010124",
   "vmStatus": 1
  }
 ]
}

错误码

错误码	错误说明	操作建议
110051	该规格不存在应用黑名单配置	需添加规格应用黑名单列表
110028	实例不存在	传参有误
110052	执行设置应用黑名单指令失败	请重试

设置实例带宽

根据实例编号设置实例带宽。

接口地址

/openapi/open/pad/setSpeed

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
padCodes		String[]	是
├─	AC22030010124	String	是	实例编号
upBandwidth	10.00	float	是	上行带宽 Mbps (0：不限制；-1：限制上网)
downBandwidth	10.00	float	是	下行带宽 Mbps (0：不限制；-1：限制上网)

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1721739857317	Long	时间戳
data		Object[]
├─taskId	679	Integer	任务ID
├─padCode	AC32010140011	String	实例编号
├─vmStatus	1	Integer	实例在线状态（0：离线；1：在线）

请求示例

{
 "padCodes": [
  "AC32010140011"
 ],
 "upBandwidth": 10.00,
 "downBandwidth": 10.00
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts": 1721640654237,
 "data": [
  {
   "taskId": 679,
   "padCode": "AC32010140011",
   "vmStatus": 1
  }
 ]
}

开启关闭ADB

根据实例编号打开或关闭实例adb

接口地址

/openapi/open/pad/openOnlineAdb

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
padCodes		String[]	是	实例列表(传入实例数量1-200个)
├─	AC32010250032	String	是	实例编号
openStatus	1	Integer	是	开启关闭ADB状态(1开启 0或者不传默认关闭)

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1721739857317	Long	时间戳
data		Object[]
├─taskId	16147	Integer	任务id
├─padCode	AC32010250032	String	实例编号
├─taskStatus	3	Integer	任务状态（-1全失败，-2部分失败，-3取消，-4超时，-5异常，1，等待执行，2执行中，3完成）
├─taskResult	success	String	任务结果

请求示例

{   
    "padCodes":[
        "AC32010250032"
    ],
    "status": 1
}

响应示例

{
    "code": 200,
    "msg": "success",
    "ts": 1736920929306,
    "data": [
        {
        "taskId": 16147,
        "padCode": "AC32010250032",
        "taskStatus": 3,
        "taskResult": "success"
        }
    ]
}

获取ADB连接信息

根据实例编号获取adb连接信息响应数据(key,adb)不全情况时，请调用开启关闭ADB开启adb。

接口地址

/openapi/open/pad/adb

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
padCode	AC32010250032	String	是	实例编号
enable	true	Boolean	是	ADB 状态 true:开启 false:关闭

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1736922808949	Long	时间戳
data		Object[]
├─padCode	AC32010250032	String	实例编号
├─command	ssh -oHostKeyAlgorithms=+ssh-rsa 10.255.3.2_001_1736922765389@156.59.80.166 -p 1824 -L 8572:adb-proxy:53728 -Nf	String	SSH 连接指令
├─expireTime	2025-01-16 14:32:00	String	adb 链接有效期
├─enable	true	Boolean	ADB 状态 true:开启 false:关闭
├─key	3CXr3FJZ6gbnGuJctDOpP9M6X6Rl786xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx==	String	连接密钥
├─adb	adb connect localhost:8577	String	adb连接信息

请求示例

{   
    "padCode": "AC32010250032",
    "enable": true
}

响应示例

{
    "code": 200,
    "msg": "success",
    "ts": 1736922808949,
    "data": {
        "padCode": "AC32010250032",
        "command": "ssh -oHostKeyAlgorithms=+ssh-rsa 10.255.3.2_001_1736922765389@156.59.80.166 -p 1824 -L 8572:adb-proxy:53728 -Nf",
        "expireTime": "2025-01-16 14:32:00",
        "enable": true,
        "key": "3CXr3FJZ6gbnGuJctDOpP9M6X6Rl786xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx==",
        "adb": "adb connect localhost:8577"
    }
}

模拟触控

通过传入xy坐标，模拟在实例中的触控事件（按下、抬起、触摸中）。

接口地址

/openapi/open/pad/simulateTouch

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	参数描述
padCodes	2200	String[]	需要触发点击的实例编码
width	120	Integer	容器宽度
height	120	Integer	容器高度
positions	[{"actionType":0,"x":100,"y":100,"nextPositionWaitTime":20}]	Object[]	点击坐标组
├─ actionType	1	Integer	操作类型（0：按下；1：抬起；2：触摸中）
├─ x	100	float	点击的x坐标
├─ y	100	float	点击的y坐标
├─ nextPositionWaitTime	100	Integer	多组坐标时，触发下一组点击坐标的等待间隔时间ms毫秒值

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1736922808949	Long	时间戳
data		Object[]
├─padCode	AC32032	String	实例编号
├─taskId	10004759	Long	任务id
├─vmStatus	0	String	实例在线状态

请求示例

{
  "padCodes": [
    "实例编号"
  ],
  "width": 1080,
  "height": 1920,
  "positions": [
    {
      "actionType": 0,
      "x": 100,
      "y": 100,
      "nextPositionWaitTime": 20
    },
    {
      "actionType": 2,
      "x": 110,
      "y": 110,
      "nextPositionWaitTime": 22
    },
    {
      "actionType": 2,
      "x": 120,
      "y": 120,
      "nextPositionWaitTime": 23
    },
    {
      "actionType": 1,
      "x": 120,
      "y": 120
    }
  ]
}

响应示例

{
  "code": 200,
  "msg": "success",
  "ts": 1743676563784,
  "data": [
    {
      "taskId": 100059,
      "padCode": "ACP00001",
      "vmStatus": 0
    },
    {
      "taskId": 100060,
      "padCode": "ACP00001",
      "vmStatus": 0
    }
  ]
}

实例操作任务详情

查询指定实例操作任务的执行结果详细信息。

接口地址

/task-center/open/task/padTaskDetail

请求方式

POST

请求数据类型

application/json

请求Query参数

参数名	示例值	参数类型	是否必填	参数描述
taskIds		Integer[]	是
├─taskId	1	Integer	是	任务ID

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object []	子任务列表详情
├─ taskId	1	Integer	子任务ID
├─ padCode	VP22020020793	String	实例标识
├─ taskStatus	2	String TODO类型使用错误	任务状态（-1：全失败；-2：部分失败；-3：取消；-4：超时；1：待执行；2：执行中；3：完成）
├─ endTime	1713429401000	Long	子任务结束时间戳
├─ taskContent	“”	String	任务内容
├─ taskResult	“”	String	任务结果
├─ errorMsg	“”	String	错误信息

请求示例

{
 "taskIds":[1,2]
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts": 1716283460673,
 "data": [
  {
   "taskId": 1,
   "padCode": "AC22030022441",
   "taskStatus": 2,
   "endTime": 1713429401000,
   "taskContent": null,
   "taskResult": null,
            "errorMsg":"Alarms  Android  Audiobooks  DCIM  Documents  Download  Movies  Music  Notifications  Pictures  Podcasts  Recordings  Ringtones  "
  },
  {
   "taskId": 2,
   "padCode": "AC22030022442",
   "taskStatus": 2,
   "endTime": 1713429401001,
   "taskContent": null,
   "taskResult": null,
            "errorMsg":"Alarms  Android  Audiobooks  DCIM  Documents  Download  Movies  Music  Notifications  Pictures  Podcasts  Recordings  Ringtones  "
  }
 ]
}

获取实例执行脚本结果

通过执行脚本任务ID来获取实例执行脚本结果。

接口地址

/task-center/open/task/executeScriptInfo

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
taskIds		Integer []	是
├─	1	Integer	否	任务ID

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object[]
├─taskId	1	Integer	任务ID
├─padCode	AC22020020793	String	实例编号
├─taskStatus	3	Integer	任务状态（-1：全失败；-2：部分失败；-3：取消；-4：超时；1：待执行；2：执行中；3：完成）
├─endTime	1756021166163	Long	任务执行结束时间
├─taskContent	Success	String	任务内容
├─taskResult	Success	String	任务结果

请求示例

{
 "taskIds": [1]
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts":1756021167163,
 "data":[
    {
    "taskId": 1,
    "padCode": "AC22020020793",
    "taskStatus":3,
    "taskResult":"Success",
    "endTime":"1756021166163",
    "taskContent":"Success"
    }
   ]
}

获取实例截图结果

通过截图任务 ID 来获取实例的截图结果。

接口URL

/task-center/open/task/screenshotInfo

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
taskIds		Integer []	是
├─	1	Integer	否	任务ID

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data	-	Object[]	任务列表详情
├─ taskId	1	Integer	任务ID
├─ taskStatus	3	Integer	任务状态（-1：全失败；-2：部分失败；-3：取消；-4：超时；1：待执行；2：执行中；3：完成）
├─ padCode	AC22020020793	String	实例编号
├─ taskContent	Success	String	任务内容
├─ taskResult	Success	String	任务结果
├─ endTime	1756121167163	String	任务执行结束时间

请求示例

{
 "taskIds": [1]
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts":1713773577581,
 "data":[
    {
    "taskId": 1,
    "taskStatus": 3,
    "padCode": "AC22020020793",
    "taskContent": "Success",
    "taskResult": "Success",
    "endTime": 1756121167163
    }
   ]
}

实例重启重置执行结果

通过任务ID来获取实例重启重置执行结果。

接口地址

/task-center/open/task/padExecuteTaskInfo

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
taskIds		Integer []	是
├─	1	Integer	是	任务ID

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object[]
├─taskId	1	Integer	任务ID
├─padCode	AC21020010001	String	实例编号
├─taskStatus	3	Integer	任务状态：（-1：全失败；-2：部分失败；-3：取消；-4：超时；1：待执行；2：执行中；3：完成）
├─ endTime	1756021166163	Long	任务执行结束时间
├─ taskContent	“”	String	任务内容
├─ taskResult	Success	String	任务结果

请求示例

{
    "taskIds": [1]
}

响应示例

{
    "code": 200,
        "msg": "success",
        "ts": 1756021167163
    "data":[
        {
            "taskId": 1,
            "padCode": "AC22030022911",
            "taskStatus": 3,
            "endTime": 1756021166163,
            "taskContent": null,
            "taskResult": "Success"
        }
    ]
}

实例列表信息

根据查询条件分页获取实例列表信息。

接口地址

/openapi/open/pad/infos

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
page	1	Integer	是	页码
rows	10	Integer	是	条数
armServerCode	ACS32010260000	Integer	否	服务器编号
deviceCode	AC32010250020	Integer	否	板卡编号
padType	real	String	否	实例类型（virtual：虚拟机；real：真机）
idc	1	String	否	机房Id
padCodes		String[]	否
├─	AC22010020062	String	否	实例编号
groupIds		Integer[]	否
├─	1	Integer	否	实例分组ID

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer
msg	success	String
ts	1713773577581	Long
data		Object
├─page	1	Integer	当前页
├─rows	10	Integer	每页的数量
├─size	1	Integer	当前页的数量
├─total	1	Integer	总记录数
├─totalPage	1	Integer	总页数
├─pageData		object[]	列表
├─├─padCode	VP21020010391	String	实例编号
├─├─padGrade	q1-2	String	实例开数（q1-6六开，q1-2二开）
├─├─padStatus	10	String	实例状态（10-运行中 11-重启中 12-重置中 13-升级中 14-异常 15-未就绪）
├─├─groupId	0	Integer	分组ID
├─├─idcCode	d3c1f580c41525e514330a85dfdecda8	String	机房编码
├─├─idc	1	String	机房id
├─├─deviceIp	192.168.0.0	String	云机ip
├─├─padIp	192.168.0.0	String	实例ip
├─├─armServerCode	ACS32010260000	String	服务器编号
├─├─deviceCode	AC32010250020	String	实例编号
├─├─armServerCode	ACS32010160000	String	服务器编号
├─├─padType	real	String	实例类型（virtual：虚拟机；real：真机）
├─├─deviceCode	AC32010150070	String	板卡编号
├─├─apps		String[]	安装的应用列表
├─├─├─	armcloud001	String	安装的应用

请求示例

{
    "page": 1,
        "rows": 10,
        "padCodes": [
        "AC21020010391"
    ],
        "armServerCode": "ACS32010260000",
        "deviceCode": "AC32010250020",
        "groupIds": [
        1
    ]
}

响应示例

{
    "code": 200,
        "msg": "success",
        "ts": 1737625119669,
        "data": {
        "page": 1,
            "rows": 10,
            "size": 3,
            "total": 3,
            "totalPage": 1,
            "pageData": [
            {
                "padCode": "AC32010250021",
                "padGrade": "m2-3",
                "padStatus": 12,
                "groupId": 3,
                "idcCode": "1",
                "deviceIp": "172.31.3.3",
                "padIp": "10.255.3.5",
                "padType": "real",
                "adbOpenStatus": "0",
                "armServerCode": "ACS32010260000",
                "deviceCode": "AC32010250020",
                "apps": null,
                "imageId": "img-25012330968"
            },
            {
                "padCode": "AC32010250022",
                "padGrade": "m2-3",
                "padStatus": 10,
                "groupId": 3,
                "idcCode": "1",
                "deviceIp": "172.31.3.3",
                "padIp": "10.255.3.6",
                "padType": "real",
                "adbOpenStatus": "1",
                "armServerCode": "ACS32010260000",
                "deviceCode": "AC32010250020",
                "apps": null,
                "imageId": "img-25012330968"
            },
            {
                "padCode": "AC32010250023",
                "padGrade": "m2-3",
                "padStatus": 10,
                "groupId": 3,
                "idcCode": "1",
                "deviceIp": "172.31.3.3",
                "padIp": "10.255.3.7",
                "padType": "real",
                "adbOpenStatus": "0",
                "armServerCode": "ACS32010260000",
                "deviceCode": "AC32010250020",
                "apps": null,
                "imageId": "img-25012330968"
            }
        ]
    }
}

实例分组列表

获取用户当前所有实例分组列表信息（包括：分组 ID,分组名称，分组下实例数量）。 接口地址

/openapi/open/group/infos

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
padCode	AC21020010391	String	否	实例编号
groupIds		Integer[]	否
├─	1	Integer	否	分组ID

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object[]
├─groupId	1	Integer	分组ID
├─groupName	分组一	String	分组名称
├─padCount	1	Integer	分组下的实例数

请求示例

{
 "padCode": "AC21020010391",
 "groupIds": [1]
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts":1713773577581,
 "data": [
   {
    "groupId": 1,
    "groupName": "分组一",
    "padCount": 1
   }
 ]
}

回调管理

配置说明:需要客户在客户开放平台配置回调地址，配置地址成功则默认开启接收回调信息

查询支持的回调类型

接口地址

/openapi/open/config/selectList

请求方式

GET

请求数据类型

无参数

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer
msg	success	String
ts	1713773577581	Long
data		Object
├─callbackName	"文件上传任务"	String	回调类型名称
├─callbackType	"4"	String	回调类型
├─id	14	Long	回调类型的ID(后续新增修改需要传入该参数)

请求示例

/openapi/open/config/selectList

响应示例

{
    "code": 200,
        "data": [
        {
            "callbackName": "文件上传任务",
            "callbackType": "4",
            "id": 14
        },
        {
            "callbackName": "文件上传实例任务",
            "callbackType": "5",
            "id": 15
        },
        {
            "callbackName": "应用同步任务",
            "callbackType": "6",
            "id": 16
        }
    ],
    "msg": "success",
    "ts": 1734500966127
}

查询配置的回调地址

接口地址

/openapi/open/config/selectCallback

请求方式

GET

请求数据类型

无参数

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer
msg	success	String
ts	1713773577581	Long
data	http://www.baidu.com	String	配置的回调地址

请求示例

/openapi/open/config/selectCallback

响应示例

{
 "code" : 200,
 "data" : "http://www.baidu.com",
 "msg" : "success",
 "ts" : 1734501602763
}

新增回调地址配置

接口地址

/openapi/open/config/insertCallback

请求方式

POST

请求数据类型

application/json

请求Query参数

参数名	示例值	参数类型	是否必填	参数描述
callbackIdList	[1,2,3]	Integer[]	是	回调类型ID集合(从查询支持的回调类型接口获取)
├─callbackUrl	192.168.1.1/test	String	是	接收任务回调配置URL

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer
msg	success	String
ts	1713773577581	Long
data	2	String	配置成功type数量

请求示例

{"callbackIdList":[21,14],"callbackUrl":"localhost:8080/callback"}

响应示例

{"code":200,"data":2,"msg":"success","ts":1734502541732}

修改回调地址配置

接口地址

/openapi/open/config/updateCallback

请求方式

POST

请求数据类型

application/json

请求Query参数

参数名	示例值	参数类型	是否必填	参数描述
callbackIdList	[1,2,3]	Integer[]	是	回调类型ID集合(从查询支持的回调类型接口获取)
├─callbackUrl	192.168.1.1/test	String	是	接收任务回调配置URL

响应参数

参数名	示例值	参数类型
code	200	Integer
msg	success	String
ts	1713773577581	Long
data	2	String

请求示例

{
 "callbackIdList" : [21,14],
 "callbackUrl" : "localhost:8080/callback"
}

响应示例

{
 "code" : 200,
 "data" : 2,
 "msg" : "success",
 "ts" : 1734502541732
}

删除配置的回调地址

接口地址

/openapi/open/config/deleteCallback

请求方式

POST

请求数据类型

无参数

响应参数

参数名	示例值	参数类型
code	200	Integer
msg	success	String
ts	1713773577581	Long
data	4	Long

请求示例

/openapi/open/config/deleteCallback

响应示例

{
 "code" : 200,
 "data" : 22,
 "msg" : "success",
 "ts" : 1734503029282
}

实例状态回调

使用场景

实例状态变更的情况会通过该回调接口通知给客户。

字段	类型	示例	说明
taskBusinessType	Integer	999	任务业务类型
padCode	String	212254	实例标识
padStatus	Integer	1	实例状态： 10-运行中 11-重启中 12-重置中 13-升级中 14-异常 15-未就绪

云机状态回调

使用场景

云机状态变更的情况会通过该回调接口通知给客户。

字段	类型	示例	说明
taskBusinessType	Integer	1000	任务业务类型
deviceStatus	Integer	1	物理机状态 0-离线；1-在线
deviceCode	String	212254	云机编号

实例重启任务回调

使用场景

实例重启任务的情况会通过该回调接口通知给客户。

字段	类型	示例	说明
taskBusinessType	Integer	1000	任务业务类型
padCode	String	212254	实例编号
taskStatus	Integer	3	任务状态（-1：全失败；-3：取消；-4：超时；1：待执行；2：执行中；3：完成）
taskId	Integer	1	任务ID
taskContent	String		任务内容
endTime	Long	1756021166163	结束时间
taskResult	String	Success	任务结果

实例重置任务回调

使用场景

实例重置任务的情况会通过该回调接口通知给客户。

字段	类型	示例	说明
taskBusinessType	Integer	1001	任务业务类型
padCode	String	212254	实例编号
taskStatus	Integer	3	任务状态（-1：全失败；-3：取消；-4：超时；1：待执行；2：执行中；3：完成）
taskId	Integer	1	任务ID
taskContent	String		任务内容
endTime	Long	1756021166163	结束时间
taskResult	String	Success	任务结果

异步执行ADB任务回调

使用场景

客户调用异步执行ADB命令，会通过该回调接口通知给客户。

字段	类型	示例	说明
taskBusinessType	Integer	1002	任务业务类型
padCode	String	AC22030022001	实例标识
taskId	Integer	1	任务id
taskStatus	Integer	3	任务状态（-1：全失败；-2：部分失败；-3：取消；-4：超时；1：待执行；2：执行中；3：完成）
endTime	Long	1756021166163	任务执行结束时间
taskResult	String	Success	任务结果
taskContent	String		任务内容
cmd	String	cd /root;ls	执行的命令
cmdResult	String	/ws	执行的命令返回

应用安装任务回调

使用场景

客户调用应用安装，应用的安装情况会通过该回调接口通知给客户。

字段	类型	示例	说明
taskBusinessType	Integer	1003	任务业务类型
taskId	Integer	1	任务ID
apps	Object[]		应用信息
├─ appId	Integer	10001	应用ID
├─ appName	String	demo	应用名称
├─ pkgName	String	com.xxx.demo	包名
├─ padCode	String	AC22030022001	实例编号
├─ result	boolean	true	安装结果的标识。true：成功，false：失败
├─ failMsg	String	此应用已加入黑名单，禁止安装	失败信息

应用卸载任务回调

使用场景

客户调用应用卸载，应用卸载的情况会通过该回调接口通知给客户。

字段	类型	示例	说明
taskBusinessType	Integer	1004	任务业务类型
taskId	Integer	1	任务ID
apps	Object		应用信息
├─ appId	Integer	10001	应用ID
├─ appName	String	demo	应用名称
├─ pkgName	String	com.xxx.demo	包名
├─ padCode	String	AC22030022001	实例编号
├─ result	boolean	true	安装结果的标识。true：成功，false：失败

应用停止任务回调

使用场景

客户调用应用停止，应用停止的情况会通过该回调接口通知给客户。

字段	类型	示例	说明
taskBusinessType	Integer	1005	任务业务类型
padCode	String	AC22030022001	实例标识
taskId	Integer	1	任务ID
taskStatus	Integer	3	任务状态（-1：全失败；-3：取消；-4：超时；1：待执行；2：执行中；3：完成）
pkgName	String	xxx.test.com	包名

应用启动任务回调

使用场景

客户调用应用启动，应用启动的情况会通过该回调接口通知给客户。

字段	类型	示例	说明
taskBusinessType	Integer	1007	任务业务类型
padCode	String	AC22030022001	实例标识
taskId	Integer	1	任务ID
taskStatus	Integer	3	任务状态（-1：全失败；-3：取消；-4：超时；1：待执行；2：执行中；3：完成）
pkgName	String	xxx.test.com	包名

文件上传实例任务回调

使用场景

客户调用实例文件上传api，会通过该回调接口通知客户。

字段	类型	示例	说明
taskBusinessType	Integer	1009	任务业务类型
padCode	String	AC22030022001	实例编号
taskId	Integer	1	任务ID
result	boolean	true	执行结果：true-成功，false-失败
errorCode	String		错误码
fileId	String	cf08f7b685ab3a7b6a793b30de1b33ae34	文件id

查询实例应用列表回调

使用场景

客户调用实例已安装应用列表，实例已安装应用列表的情况会通过该回调接口通知给客户。

字段	类型	示例	说明
taskBusinessType	Integer	1011	任务业务类型
padCode	String	AC22030022001	pod标识
taskId	Integer	1	任务ID
taskStatus	Integer	1	任务状态（-1：全失败；-3：取消；-4：超时；1：待执行；2：执行中；3：完成）
apps	Object[]
├─appName	String	test	应用名称
├─pkgName	String	text.xx.com	包名

实例升级镜像任务回调

使用场景

实例升级镜像任务状态变更的情况会通过该回调接口通知给客户。

字段	类型	示例	说明
taskBusinessType	Integer	1012	任务业务类型
padCode	String	212254	实例编号
taskStatus	Integer	3	任务状态（-1：全失败；-3：取消；-4：超时；1：待执行；2：执行中；3：完成）
taskId	Integer	1	任务ID
taskContent	String		任务内容
endTime	Long	1756021166163	结束时间
taskResult	String	Success	任务结果

实例黑名单任务回调

使用场景

实例设置应用黑名单任务状态变更的情况会通过该回调接口通知给客户。

字段	类型	示例	说明
taskBusinessType	Integer	1015	任务业务类型
padCode	String	212254	实例编号
taskId	Integer	1	任务ID
taskStatus	Integer	3	任务状态（-1：全失败；-3：取消；-4：超时；1：待执行；2：执行中；3：完成）

备份实例回调

使用场景

实例备份实例的情况会通过该回调接口通知给客户。

字段	类型	示例	说明
taskBusinessType	Integer	1024	任务业务类型
padCode	String	212254	实例编号
taskStatus	Integer	3	任务状态（-1：全失败；-3：取消；-4：超时；1：待执行；2：执行中；3：完成）
taskId	Integer	1	任务ID
taskContent	String		任务内容
endTime	Long	1756021166163	结束时间
taskResult	String	Success	任务结果

还原备份数据回调

使用场景

还原备份数据的情况会通过该回调接口通知给客户。

字段	类型	示例	说明
taskBusinessType	Integer	1025	任务业务类型
padCode	String	212254	实例编号
taskStatus	Integer	3	任务状态（-1：全失败；-3：取消；-4：超时；1：待执行；2：执行中；3：完成）
taskId	Integer	1	任务ID
taskContent	String		任务内容
endTime	Long	1756021166163	结束时间
taskResult	String	Success	任务结果

一键新机回调

使用场景

一键新机的情况会通过该回调接口通知给客户。

字段	类型	示例	说明
taskBusinessType	Integer	1124	任务业务类型
padCode	String	212254	实例编号
taskStatus	Integer	3	任务状态（-1：全失败；-3：取消；-4：超时；1：待执行；2：执行中；3：完成）
taskId	Integer	1	任务ID
taskContent	String		任务内容
endTime	Long	1756021166163	结束时间
taskResult	String	Success	任务结果

文件上传任务回调

使用场景

客户调用上传文件，上传文件的情况会通过该回调接口通知给客户。

字段	类型	示例	说明
taskBusinessType	Integer	2000	任务业务类型
taskId	Integer	1	任务ID
taskStatus	Integer	3	任务状态（-1：全失败；-3：取消；-4：超时；1：待执行；2：执行中；3：完成）
originFileUrl	String	<www.xxx.com/xxx.apk>	原文件下载地址
fileUniqueId	String	test001	文件id

文件管理

文件上传到云盘

进行文件上传操作，上传到云盘

接口地址

/file-center/open/file/cache

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
fileUrl	http://xxx.armcloud.apk	String	是	文件下载地址
fileName	桃源深处有人家游戏官方版.apk	String	是	文件名称
fileMd5	32e1f345f209a7dc1cc704913ea436d3	String	是	⽂件预期md5，⽤作下载⽂件校验最⼤⻓度32

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object[]
├─taskId	1	Integer	任务ID
├─fileUniqueId	6865b417b7257d782afd5ac8bee4d311	String	文件唯一标识

请求示例


{
    "fileUrl": "http://down.s.qq.com/download/11120898722/apk/10043132_com.tencent.fiftyone.yc.apk",
    "fileName": "桃源深处有人家游戏官方版.apk",
    "fileMd5": "c52585e13a67e13128d9963b2f20f69678a86ee8b5551ca593327d329719a5"
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts": 1713773577581,
 "data": {
  "taskId":1,
  "fileUniqueId": "6865b417b7257d782afd5ac8bee4d311"
 }
}

实例文件删除

接口地址

/file-center/open/file/batch/del

请求方式

POST (支持批量删除，一次最多只能删除200个)

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
fileUniqueIds	cfc280111c435823c5409ddb9a4186420d	String[]	是	unique_id→文件id标识

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data	true	Boolean

请求示例


{
 "fileUniqueIds": [
  "cfc280111c435823c5409ddb9a4186420d",
  "cf77f930acbbe1707fffc661f2c4380a71"
 ]
}

响应示例(全部成功)

{
  "code": 200,
  "msg": "success",
  "ts": 1734677342300, 
  "data": true
}

响应示例(部分成功)

{
    "code": 200,
        "msg": "删除成功,存在无效文件id标识",
        "ts": 1734935677246,
        "data": [
        "cfc280111c435823c5409ddb9a4186420d"
    ]
}

文件上传实例V3版本

从文件管理中心推送文件到一个或多个云手机实例（异步任务）

接口地址

/openapi/open/pad/v3/uploadFile

如果能通过md5值或者文件ID找到对应的文件,会直接通过OSS的路径下发给实例下载
如果OSS没有对应的文件,会直接将URL下发给实例下载,并且将该URL内容上传到OSS
如果选择安装应用,会检验包名是否有值,如果没值,会抛出异常.(安装应用默认会授权所有权限,通过isAuthorization字段可以选择不授权) 请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
padCodes		String[]	是
├─	AC22030023061	String	是	实例编号
autoInstall	1	Integer	否	是否需要⾃动安装 1需要、0不需要。不填默认不需要。仅对apk类型的⽂件⽣效
fileUniqueId	1e5d3bf00576ee8f3d094908c0456722	String	否	文件id唯一标识。
customizeFilePath	/Documents/	String	否	⾃定义路径。非必传，需以/开头。
fileName	threads	String	否	文件名称
packageName	com.zhiliaoapp.musically	String	否	文件包名
url	https://file.vmoscloud.com/appMarket/2/apk/fe1f75df23e6fe3fd3b31c0f7f60c0af.apk	String	否	文件安装路径
md5	com.zhiliaoapp.musically	String	否	文件包名(使用url上传,选择需要安装时必填,否则会抛出异常)
isAuthorization	false	Boolean	否	是否授权(默认全授权)
iconPath	https://file.vmoscloud.com/appMarket/2/apk/fe1f75df23e6fe3fd3b31c0f7f60c0af.png	string	否	安装时的图标展示

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object[]
├─padCode	AC22010020062	String	实例编号
├─taskId	1	Integer	任务ID
├─vmStatus	1	Integer	实例在线状态（0：离线；1：在线）

请求示例

{
    "padCodes":["AC32010250022"],
        "customizeFilePath":"/DCIM/",
        "md5":"d97fb05b3a07d8werw2341f10212sdfs3sdfs24",
        "url":"https://file.vmoscloud.com/appMarket/2/apk/fe1f75df23e6fe3fd3b31c0f7f60c0af.apk ",
        "autoInstall":1,
        "packageName":"com.zhiliaoapp.musically",
        "fileName":"market",
        "isAuthorization":false
}

响应示例

{
    "code": 200,
        "msg": "success",
        "ts": 1737431505379,
        "data": [
        {
            "taskId": 13469,
            "padCode": "AC32010250022",
            "vmStatus": 0
        }
    ]
}

错误码

错误码	错误说明	操作建议
140006	文件存储路径不正确	⾃定义路径需以/开头
140005	文件不可用	文件路径为空
110006	下载失败	文件路径不能下载

文件上传到实例

从文件管理中心推送文件到一个或多个云手机实例（异步任务）

接口地址

/openapi/open/pad/v2/uploadFile

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
padCodes		String[]	是
├─	AC22030023061	String	是	实例编号
autoInstall	0	Integer	否	是否需要⾃动安装 1需要、0不需要。仅对apk类型的⽂件⽣效。不需要请不要填或填0
fileUniqueId	1e5d3bf00576ee8f3d094908c0456722	String	是	文件id唯一标识。
customizeFilePath	/Documents/	String	否	⾃定义路径。非必传，需以/开头。
isAuthorization	false	Boolean	否	是否授权应用(默认权授权)

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object[]
├─padCode	AC22010020062	String	实例编号
├─taskId	1	Integer	任务ID
├─vmStatus	1	Integer	实例在线状态（0：离线；1：在线）

请求示例

{
 "padCodes": [
  "AC22030023061"
 ],
 "autoInstall": 0,
 "fileUniqueId": "1e5d3bf00576ee8f3d094908c0456722",
 "customizeFilePath": "/Documents/"
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts": 1717571059834,
 "data": [
  {
   "taskId": 39,
   "padCode": "AC22030010001",
   "vmStatus": 1
  }
 ]
}

错误码

错误码	错误说明	操作建议
140006	文件存储路径不正确	⾃定义路径需以/开头
140005	文件不可用	文件路径为空
110006	下载失败	文件路径不能下载

文件列表

查询已上传的文件列表信息

接口地址

/file-center/open/file/list

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
page	1	Integer	是	起始页,默认1
rows	10	Integer	是	查询数量,默认10
fileName	"33"	String	否	根据文件名查询

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object
├─page	1	Integer	当前页
├─rows	10	Integer	每页的数量
├─size	2	Integer	当前页的数量
├─total	2	Integer	总记录数
├─totalPage	1	Integer	总页数
├─pageData		object[]	列表
├─├─fileUniqueId	c417cdf30cd13437a60a494f2fcee616	String	文件id标识
├─├─fileName	15b18072b01049dfa30da046aaf5b213.apk	String	文件名
├─├─fileMd5	49f526ec07f261ef6c22081fd61fb6b2836b84214ab6f4620e89d2f2d454253	String	文件内容值
├─├─fileSize	165936779	Integer	文件大小（单位：字节）
├─├─originUrl	https://xxx.armcloud.apk	String	文件原地址
├─├─createTime	1713884498000	Long	创建时间

请求示例


{
    "page": 1,
    "rows": 10,
    "fileName":"33"
}

响应示例

{
    "code": 200,
        "msg": "success",
        "ts": 1738810095624,
        "data": {
        "page": 1,
            "rows": 10,
            "size": 3,
            "total": 3,
            "totalPage": 1,
            "pageData": [
            {
                "fileUniqueId": "cf8761fb5f040e03dffde5a44238f2a97a",
                "fileName": "222333.txt",
                "fileId": "25123",
                "fileMd5": "f983eca4f19984b5d1733966b06a9827",
                "fileSize": 29,
                "originUrl": "",
                "createTime": 1738808289000
            },
            {
                "fileUniqueId": "cfa9252a7a8ed0e3045afe68a60760ff12",
                "fileName": "file_3388fb2de8977bce634e402ed7d52249.zip",
                "fileId": "25081",
                "fileMd5": "39661085ca57602ffd57d49a013a0eb5",
                "fileSize": 1310,
                "originUrl": "",
                "createTime": 1737109818000
            },
            {
                "fileUniqueId": "cf558127ed68c2f3a0a025f4b93131bf2e",
                "fileName": "b02b09f2f0833c092ead1dbf6831d452B02B09F2F0833C092EAD1DBF6831D452.apk",
                "fileId": "64",
                "fileMd5": "b02b09f2f0833c092ead1dbf6831d452",
                "fileSize": 1419011078,
                "originUrl": "",
                "createTime": 1726816761000
            }
        ]
    }
}

文件任务详情

查询指定文件任务的执行结果详细信息。

接口地址

/task-center/open/task/fileTaskDetail

请求方式

POST

请求数据类型

application/json

请求Query参数

参数名	示例值	参数类型	是否必填	参数描述
taskIds		Integer[]	是
├─taskId	1	Integer	是	任务ID

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object[]	任务列表详情
├─ taskId	1	Integer	子任务ID
├─ appId	134	Long	应用id
├─ fileUniqueId	e2c07491309858c5cade4bfc44c03724	String	⽂件唯⼀标识
├─ fileName	xx.apk	String	文件名称
├─ taskStatus	2	Integer	任务状态（-1：全失败；-2：部分失败；-3：取消；-4：超时；1：待执行；2：执行中；3：完成）
├─ endTime	1713429401000	Long	子任务结束时间戳

请求示例

{
 "taskIds":[
  1,2
 ]
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts": 1716283460673,
 "data": [
  {
   "taskId": 1,
   "appId": 134,
   "fileUniqueId": "e2c07491309858c5cade4bfc44c03724",
   "fileName": "xx.apk",
   "taskStatus": 2,
   "endTime": 1713429401000
  },
  {
   "taskId": 2,
   "appId": 135,
   "fileUniqueId": "e2c07491309858c5cade4bfc43c03725",
   "fileName": "xx.apk",
   "taskStatus": 2,
   "endTime": 1713429401001
  }
 ]
}

应用管理

应用上传

上传应用安装文件到指定业务的应用管理中心（异步任务）。

接口地址

/file-center/open/app/cache

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
parse	true	Boolean	是	是否缓存并解析（解析并缓存）如解析则无需填包信息
apps		Object[]	是	应用列表
├─ appId	1243	Integer	否	自定义应用ID
├─ url	https://xxx.armcloud.apk	String	是	源文件下载地址
├─ appName	kuaishou	String	否	应用名称
├─ pkgName	com.smile.gifmaker	String	否	包名
├─ signMd5	0F938C4F0995A83C9BF31F0C64322589	String	否	应用签名MD5
├─ versionNo	36000	Integer	否	版本号
├─ versionName	12.3.20.36000	String	否	版本名
├─ description	kuai	String	否	描述
├─ md5sum	e673a204b8f18a0f6482da9998	String	否	应用唯一标识

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object[]
├─ taskId	12	Integer	任务ID
├─ appId	1243	Integer	应用ID

请求示例

{
 "parse": true,
 "apps": [
  { 
   "appId": 1243,
   "appName": "kuaishou",
   "url": "https://xxx.armcloud.apk",
   "pkgName": "com.smile.gifmaker",
   "signMd5": "0F938C4F0995A83C9BF31F0C64322589",
   "versionNo": 36000,
   "versionName": "12.3.20.36000",
   "description": "kuai",
   "md5sum": "e673a204b8f18a0f6482da9998"
  }
 ]
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts":1713773577581,
 "data": [
   {
    "taskId": 12,
    "appId": 1243
   }
 ]
}

错误码

错误码	错误说明	操作建议
100001	没有访问权限	是否没有订购机房

应用列表

可根据应用ID查询应用信息列表。

接口地址

/file-center/open/app/list

请求方式

POST

请求数据类型

application/json

请求Query参数

参数名	示例值	参数类型	是否必填	参数描述
page	1	Integer	是	起始页,默认1
rows	10	Integer	是	查询数量,默认10
appIds	1,2	Integer[]	否	应用id
packageName	com.ss.android.ugc.aweme	String	否	应用包名

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
packageName	com.ss.android.ugc.aweme	String	包名
pageData		Object
├─page	1	Integer	当前页
├─rows	10	Integer	每页显示数量
├─size	10	Integer	当前页的数量
├─total	2	Integer	总数量
├─totalPage	1	Integer	总页数
├─pageData		Object[]
├─├─originUrl	downloadUrl_tr0bi	String	文件原下载地址
├─├─appId	dwadawdf	Integer	自定义应用ID
├─├─description	description_1cq3m	String	描述
├─├─packageName	packageName_e6lw8	String	包名
├─├─appName	appName_o4mhn	String	应用名称
├─├─versionName	versionName_s4o2i	String	版本名
├─├─versionNo	1	Integer	版本号
├─├─signMd5	0F938C4F0995A83C9BF31F0C64322589	String	MD5
├─├─available	true	Boolean	当前文件是否可用
├─├─createTime	1709895492000	Integer	创建时间
├─├─fileId	文件id	Integer	文件id
├─├─iconPath	http://192.168.230.80:18100/icon/110_6ca4d3e6e5111ec38e8eca6c1998ce89..png	String	应用图标
├─├─classifyNameList	黑白名单类别	Object[]	黑白名单类别
├─├─├─classifyName	类别1	String	黑白名单类别名称
├─├─├─classifyType	1	Integer	黑白名单类型(1白名单 2黑名单)
├─├─newAppClassifyList	应用分类	Object[]	应用分类
├─├─├─classifyName	test	String	应用分类名称
├─├─├─classifyId	1	Long	应用分类id

请求示例


{
    "rows": 10,
    "page": 1,
    "appIds": [
        1,2
    ],
    "packageName":"com.ss.android.ugc.aweme"
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts":1713773577581,
 "data": {
  "page": 1,
  "rows": 10,
  "size": 10,
  "total": 30,
  "totalPage": 3,
  "pageData": [
   {
    "originUrl": "downloadUrl_tr0bi",
    "appId": 1,
    "description": "description_1cq3m",
    "packageName": "packageName_e6lw8",
    "appName": "appName_o4mhn",
    "versionName": "versionName_s4o2i",
    "versionNo": 1,
    "signMd5": "0F938C4F0995A83C9BF31F0C64322589",
    "available": true,
    "createTime": 1709895492000,
                "iconPath": "http://192.168.230.80:18100/icon/110_6ca4d3e6e5111ec38e8eca6c1998ce89..png",
                "fileId": 1,
                "newAppClassifyList": [
                    {
                        "classifyName": "f1",
                        "classifyId": 3
                    }
                ]
   },
   {
    "originUrl": "downloadUrl_xh9ig",
    "appId": 2,
    "description": "description_9j663",
    "packageName": "packageName_o7t9j",
    "appName": "appName_szxpe",
    "versionName": "versionName_hwio7",
    "versionNo": 1,
    "signMd5": "0F938C4F0995A83C9BF31F0C64322587",
    "available": true,
    "createTime": 1710479133000,
                "fileId": 1,
                "iconPath": "http://192.168.230.80:18100/icon/110_6ca4d3e6e5111ec38e8eca6c1998ce89..png",
                "newAppClassifyList": [
                    {
                        "classifyName": "f1",
                        "classifyId": 3
                    }
                ]
   }
  ]
 }
}

应用详情

查询指定实例上的应用安装情况

接口地址

/file-center/open/app/detail

请求方式

POST

请求数据类型

application/json

请求Query参数

参数名	示例值	参数类型	是否必填	参数描述
appId	1	Integer	是	应用id

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object
├─appId	1	Integer	应用id
├─originUrl	http://www.xx.com/test.apk	String	原文件下载地址
├─description	test	String	自定义描述
├─packageName	xxx.xxx.com	String	包名
├─appName	test	String	应用名
├─versionName	1.0.1	String	版本名
├─versionNo	124511	Integer	版本号
├─signMd5	0F938C4F0995A83C9BF31F0C64322589	String	签名md5
├─createTime	1711595044000	Integer	文件创建时间

请求示例

{
 "appId":1
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts":1713773577581,
 "data": {
  "appId": 1,
  "originUrl": "http://www.xx.com/test.apk",
  "customizeFileId": "customizeId_v5o26",
  "description": "test",
  "packageName": "xxx.xxx.com",
  "appName": "test",
  "versionName": "1.0.1",
  "versionNo": 124511,
  "signMd5": "0F938C4F0995A83C9BF31F0C64322589",
  "createTime": 1711595044000
 }
}

查询实例应用列表

查询已上传的文件列表信息

接口地址

/openapi/open/pad/listApp

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
padCodes		String[]	否
├─	AC22010020062	String	是	实例编号

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object[]
├─taskId	1	Integer	任务ID
├─padCode	AC22010020062	String	实例编号
├─vmStatus	1	Integer	实例在线状态（0：离线；1：在线）

请求示例

{
    "padCodes": [
        "AC22010020062"
    ]
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts": 1717570838398,
 "data": [
  {
   "taskId": 31,
   "padCode": "AC22030010001",
   "vmStatus": 1
  },
  {
   "taskId": 32,
   "padCode": "AC22030010002",
   "vmStatus": 0
  }
 ]
}

错误码

错误码	错误说明	操作建议
100010	处理失败	请重新安装

应用安装

为单台或多台实例同时安装单个或多个APP。此接口为异步操作。增加黑白名单逻辑。

接口地址

/openapi/open/pad/installApp

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
apps		Object[]	是	应用列表
├─appId	124	Integer	是	应用ID
├─appName	葫芦侠	String	否	应用名称
├─pkgName	com.huluxia.gametools	String	否	应用包名
├─padCodes		String[]	是
├─├─	AC22010020062	String	是	实例编号

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object[]
├─taskId	1	Integer	任务ID
├─padCode	AC22010020062	String	实例编号
├─vmStatus	1	Integer	实例在线状态（0：离线；1：在线）

请求示例

{
 "apps":[
  {
   "appId":124,
   "appName":"葫芦侠",
   "pkgName":"com.huluxia.gametools",
   "padCodes":["AC22010020062"]
  }
 ]
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts": 1717570991004,
 "data": [
  {
   "taskId": 37,
   "padCode": "AC22030010001",
   "vmStatus": 1
  },
  {
   "taskId": 38,
   "padCode": "AC22030010002",
   "vmStatus": 1
  }
 ]
}

错误码

错误码	错误说明	操作建议
140005	文件不可用	查看文件是否存在

应用卸载

为单台或多台实例同时卸载单个或多个APP。此接口为异步操作。

接口地址

/openapi/open/pad/uninstallApp

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
apps		Object[]	是	应用列表
├─appId	124	Integer	否	应用ID
├─appName	葫芦侠	String	否	应用名称
├─pkgName	com.huluxia.gametools	String	是	应用包名
├─padCodes		String[]	是
├─├─	AC22010020062	String	是	实例编号

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object[]
├─taskId	2	Integer	任务ID
├─padCode	AC22010020062	String	实例编号
├─vmStatus	1	Integer	实例在线状态（0：离线；1：在线）

请求示例

{
 "apps":[
  {
   "appId":124,
   "appName":"demo",
   "pkgName":"com.demo",
   "padCodes":["AC22010020062"]
  }
 ]
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts": 1717570615524,
 "data": [
  {
   "taskId": 22,
   "padCode": "AC22030010001",
   "vmStatus": 1
  },
  {
   "taskId": 23,
   "padCode": "AC22030010002",
   "vmStatus": 0
  }
 ]
}

错误码

错误码	错误说明	操作建议
110007	卸载应用失败	稍后请重试

应用启动

根据实例编号和应用包名对实例进行应用启动的操作。

接口地址

/openapi/open/pad/startApp

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
padCodes		String[]	是
├─	AC22010020062	String	是	实例编号
pkgName	xxx.test.com	String	是	包名

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object[]
├─taskId	1	Integer	任务ID
├─padCode	AC22020020793	String	实例编号
├─vmStatus	1	Integer	实例在线状态（0：离线；1：在线）

请求示例

{
 "padCodes": [
  "AC22030022693"
 ],
 "pkgName": xxx.test.com
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts": 1717570663080,
 "data": [
  {
   "taskId": 24,
   "padCode": "AC22030010001",
   "vmStatus": 1
  },
  {
   "taskId": 25,
   "padCode": "AC22030010002",
   "vmStatus": 0
  }
 ]
}

错误码

错误码	错误说明	操作建议
110008	启动应用失败	重启云机后再启动应用

应用停止

根据实例编号和应用包名对实例进行应用停止的操作。

接口地址

/openapi/open/pad/stopApp

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
padCodes		String[]	是
├─	AC22010020062	String	是	实例编号
pkgName	xxx.test.com	String	是	包名

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object[]
├─taskId	1	Integer	任务ID
├─padCode	AC22010020062	String	实例编号
├─vmStatus	1	Integer	实例在线状态（0：离线；1：在线）

请求示例

{
 "padCodes": [
  "AC22010020062"
 ],
 "pkgName": xxx.test.com
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts": 1717570700415,
 "data": [
  {
   "taskId": 26,
   "padCode": "AC22030010001",
   "vmStatus": 1
  },
  {
   "taskId": 27,
   "padCode": "AC22030010002",
   "vmStatus": 0
  }
 ]
}

错误码

错误码	错误说明	操作建议
110010	停止应用失败	重启云机关闭应用

应用重启

根据实例编号和应用包名对实例进行应用重启的操作。

接口地址

/openapi/open/pad/restartApp

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
padCodes		String[]	是
├─	AC22010020062	String	是	实例编号
pkgName	xxx.test.com	String	是	包名

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object[]
├─taskId	1	Integer	任务ID
├─padCode	AC22010020062	String	实例编号
├─vmStatus	1	Integer	实例在线状态（0：离线；1：在线）

请求示例

{
 "padCodes": [
  "AC22030022693"
 ],
 "pkgName": xxx.test.com
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts": 1717570855874,
 "data": [
  {
   "taskId": 33,
   "padCode": "AC22030010001",
   "vmStatus": 1
  },
  {
   "taskId": 34,
   "padCode": "AC22030010002",
   "vmStatus": 0
  }
 ]
}

错误码

错误码	错误说明	操作建议
110009	重启应用失败	重启云机后再启动应用

黑白名单列表

分页查询黑白名单列表

接口地址

/openapi/open/appClassify/pageList

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
classifyName	test	String	否	黑白名单名称(模糊查询)
classifyType	1	Integer	否	黑白名单类型 1白名单 2黑名单
page	1	Integer	否	页码默认1
rows	10	Integer	否	每页数量默认10 最大值100

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object[]
├─id	8	Integer	黑白名单id
├─classifyName	白名单A组1	String	黑白名单名称
├─classifyType	1	Integer	黑白名单类型 1白名单 2黑名单
├─appNum	3	Integer	已关联的应用数量
├─remark	白名单A组测试1	String	描述
├─applyAllInstances	false	Boolean	是否应用所有实例模式

请求示例

{
    "classifyName": "",
    "classifyType": 1,
    "page": 1,
    "rows": 10
}

响应示例

{
     "code": 200,
     "msg": "success",
     "ts": 1735019791977,
     "data": [
          {
               "id": 8,
               "classifyName": "白名单A组1",
               "classifyType": 1,
               "appNum": 3,
               "remark": "白名单A组测试1",
               "applyAllInstances": false
          }
     ]
}

黑白名单保存

保存黑白名单和关联应用，参数id不为null，则表示更新，此操作会覆盖该分类下所有的关联应用

接口地址

/openapi/open/appClassify/save

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
id	test	Integer	否	黑白名单id(不为空则为修改)
classifyName	1	String	是	黑白名单名称
classifyType	1	Integer	是	黑白名单类型 1白名单 2黑名单
applyAllInstances	false	Boolean	否	是否应用所有实例默认false
remark	10	String	否	黑白名单描述
appInfos		Object[]	否	关联应用集合范围0-500个
├─fileId	1	Integer	否	文件id
├─appId	1	Integer	否	应用id
├─appName	测试app	String	否	应用名称
├─packageName	com.xxx.xxx	String	是	包名
├─appVersionNo	123	Integer	否	版本号
├─appVersionName	1.2.3	String	否	版本名称

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data	1	Long	黑白名单id

请求示例

{
 "id": null,
 "classifyName": "白名单A组1",
 "classifyType": 1,
    "applyAllInstances": false,    
 "remark": "白名单A组测试1",
 "appInfos": [
  {
   "fileId": 1,
   "appId": 1,
   "appName": "测试app",
   "packageName": "com.xxx.xxx",
   "appVersionNo": 123,
   "appVersionName": "1.2.3"
  }
 ]
}

响应示例

{
    "code": 200,
    "msg": "success",
    "ts": 1735019933306,
    "data": 1
}

错误码

错误码	错误说明	操作建议
110080	黑白名单不存在	黑白名单不存在
110085	黑白名单名称重复	黑白名单名称重复

黑白名单详情

查询黑白名单详情和关联应用

接口地址

/openapi/open/appClassify/detail

请求方式

POST

请求数据类型

application/json

请求Query参数

参数名	示例值	参数类型	是否必填	参数描述
id	1	Integer	是	黑白名单id

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object[]
├─id	8	Integer	黑白名单id
├─classifyName	白名单A组1	String	黑白名单名称
├─classifyType	1	Integer	黑白名单类型 1白名单 2黑名单
├─applyAllInstances	false	Boolean	是否应用所有实例模式
├─appNum	3	Integer	已关联的应用数量
├─remark	白名单A组测试1	String	描述
├─appInfos		Object[]	关联应用集合
├─├─fileId	1	Integer	文件id
├─├─appId	1	Integer	应用id
├─├─appName	测试app	String	应用名称
├─├─packageName	com.xxx.xxx	String	包名
├─├─appVersionNo	123	Integer	版本号
├─├─appVersionName	1.2.3	String	版本名称

请求示例

/openapi/open/appClassify/detail?id=1

响应示例

{
     "code": 200,
     "msg": "success",
     "ts": 1735020014142,
     "data": {
          "id": 8,
          "classifyName": "白名单A组1",
          "classifyType": 1,
          "applyAllInstances": false,  
          "appNum": 3,
          "remark": "白名单A组测试1",
          "appInfos": [
               {
                    "fileId": 1,
                    "appId": 1,
                    "appName": "测试app",
                    "packageName": "com.xxx.xxx",
                    "appVersionNo": 123,
                    "appVersionName": "1.2.3"
               }
          ]
     }
}

错误码

错误码	错误说明	操作建议
110080	黑白名单不存在	黑白名单不存在

黑白名单实例关联保存

保存关联实例，此操作会删除该分类下原所有的关联实例

接口地址

/openapi/open/appClassify/padSave

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
id	test	Integer	是	黑白名单id
appPadInfos		Object[]	否	关联实例集合范围0-500个
├─padCode	AC32010230001	String	是	实例编号
├─deviceLevel	m2-4	String	否	规格
├─padIp	10.255.3.1	String	否	实例ip

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data	null

请求示例

{
 "id": 1,
 "appPadInfos": [
  {
   "padCode": "AC32010230001",
   "deviceLevel": "m2-4",
   "padIp": "10.255.3.1"
  }
 ]
}

响应示例

{
    "code": 200,
    "msg": "success",
    "ts": 1735019933306,
    "data": null
}

错误码

错误码	错误说明	操作建议
110080	黑白名单不存在	黑白名单不存在

黑白名单实例关联详情

查询黑白名单详情和关联实例

接口地址

/openapi/open/appClassify/padDetail

请求方式

POST

请求数据类型

application/json

请求Query参数

参数名	示例值	参数类型	是否必填	参数描述
id	1	Integer	是	黑白名单id

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object[]
├─id	8	Integer	黑白名单id
├─classifyName	白名单A组1	String	黑白名单名称
├─classifyType	1	Integer	黑白名单类型 1白名单 2黑名单
├─appNum	3	Integer	已关联的应用数量
├─appPadInfos		Object[]	关联实例集合
├─├─padCode	AC111	String	实例编号
├─├─deviceLevel	m2-3	String	规格
├─├─padIp	127.0.0.1	String	实例ip

请求示例

/openapi/open/appClassify/padDetail?id=1

响应示例

{
     "code": 200,
     "msg": "success",
     "ts": 1735020251631,
     "data": {
          "id": 8,
          "classifyName": "白名单A组1",
          "classifyType": 1,
          "appNum": 3,
          "appPadInfos": [
               {
                    "padCode": "AC111",
                    "deviceLevel": "m2-3",
                    "padIp": "127.0.0.1"
               }
          ]
     }
}

错误码

错误码	错误说明	操作建议
110080	黑白名单不存在	黑白名单不存在

删除黑白名单

删除黑白名单所关联的应用和实例都会清除

接口地址

/openapi/open/appClassify/del

请求方式

POST

请求数据类型

application/json

请求Query参数

参数名	示例值	参数类型	是否必填	参数描述
id	1	Integer	是	黑白名单id

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data	null

请求示例

/openapi/open/appClassify/del?id=1

响应示例

{
    "code": 200,
    "msg": "success",
    "ts": 1735020371601,
    "data": null
}

错误码

错误码	错误说明	操作建议
110084	该黑白名单不存在或已删除	该黑白名单不存在或已删除

添加黑白名单App

添加关联应用，此操作不会覆盖该分类下所有的关联应用，直接添加到分类下

接口地址

/openapi/open/appClassify/addApp

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
id	test	Integer	是	黑白名单id
appInfos		Object[]	是	关联应用集合范围1-500个
├─fileId	1	Integer	否	文件id
├─appId	1	Integer	否	应用id
├─appName	测试app	String	否	应用名称
├─packageName	com.xxx.xxx	String	是	包名
├─appVersionNo	123	Integer	否	版本号
├─appVersionName	1.2.3	String	否	版本名称

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data	null

请求示例

{
 "id": 1,
 "appInfos": [
  {
   "fileId": 1,
   "appId": 1,
   "appName": "测试app",
   "packageName": "com.xxx.xxx",
   "appVersionNo": 123,
   "appVersionName": "1.2.3"
  }
 ]
}

响应示例

{
    "code": 200,
    "msg": "success",
    "ts": 1735019933306,
    "data": null
}

错误码

错误码	错误说明	操作建议
110080	黑白名单不存在	黑白名单不存在

添加黑白名单实例关联

添加关联实例，此操作不会覆盖该分类下所有的关联实例，直接添加到分类下

接口地址

/openapi/open/appClassify/addPad

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
id	test	Integer	是	黑白名单id
appPadInfos		Object[]	是	关联实例集合范围1-500个
├─padCode	AC32010230001	String	是	实例编号
├─deviceLevel	m2-4	String	否	规格
├─padIp	10.255.3.1	String	否	实例ip

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data	null

请求示例

{
 "id": 1,
 "appPadInfos": [
  {
   "padCode": "AC32010230001",
   "deviceLevel": "m2-4",
   "padIp": "10.255.3.1"
  }
 ]
}

响应示例

{
    "code": 200,
    "msg": "success",
    "ts": 1735019933306,
    "data": null
}

错误码

错误码	错误说明	操作建议
110080	黑白名单不存在	黑白名单不存在

删除黑白名单关联的实例

删除黑白名单关联的实例,即指定实例解绑黑白名单

接口地址

/openapi/open/appClassify/delPad

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
id	test	Integer	是	黑白名单id
padCodes		String[]	是	关联实例集合范围1-200个

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data	null

请求示例

{
 "id": 100,
 "padCodes": ["AC32010250003"]
}

响应示例

{
    "code": 200,
    "msg": "success",
    "ts": 1735019933306,
    "data": null
}

错误码

错误码	错误说明	操作建议
110080	黑白名单不存在	黑白名单不存在

应用分类列表

分页查询应用分类

接口地址

/openapi/open/newAppClassify/pageList

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
enable	true	Boolean	否	是否启用
page	1	Integer	否	页码默认1
rows	10	Integer	否	每页数量默认10 最大100

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object[]
├─id	3	Integer	应用分类id
├─classifyName	f1	String	应用分类名称
├─appNum	4	Integer	应用数量
├─enable	true	Boolean	是否启用
├─remark	test	String	描述
├─createBy	admin	String	创建人
├─createTime	2024-12-27 17:16:20	String	创建时间

请求示例

{
    "enable":true,
    "page":1,
    "rows":10
}

响应示例

{
    "code": 200,
        "msg": "success",
        "ts": 1735883927104,
        "data": [
        {
            "id": 3,
            "classifyName": "f1",
            "appNum": 4,
            "enable": true,
            "remark": "你好",
            "createBy": "admin",
            "createTime": "2024-12-27 17:16:20"
        }
    ]
}

应用启停执行结果

通过应用启停任务ID来获取实例的应用启停的结果

接口地址

/task-center/open/task/appOperateInfo

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
taskIds		Integer []	是
├─	1	Integer	是	任务ID

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1756021167163	Long	时间戳
data		Object[]
├─ taskId	1	Integer	任务ID
├─ padCode	AC22020020793	String	实例编号
├─ taskStatus	3	Integer	任务状态（-1：全失败；-2：部分失败；-3：取消；-4：超时；1：待执行；2：执行中；3：完成）
├─ endTime	1756021166163	Long	任务执行结束时间
├─ taskContent	Success	String	任务内容
├─ taskResult	Success	String	任务结果

请求示例

{
 "taskIds": [1]
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts":1713773577581,
 "data":[
    {
    "taskId": 1,
    "taskStatus": 3,
    "padCode": "AC22020020793",
    "taskContent": "Success",
    "taskResult": "Success",
    "endTime": 1756121167163
    }
   ]
}

镜像管理

获取镜像列表

获取镜像列表。（同步任务）

接口地址

/openapi/open/image/queryImageList

请求方式

POST

请求数据类型

application/json

请求Query参数

参数名	示例值	参数类型	是否必填	参数描述
imageType	1	Integer	否	镜像类型, 1:公共镜像,2:自定义镜像
releaseType	1	Integer	否	镜像版本 1测试版 2正式版
romVersion	android13	String	否	AOSP版本(android13，android14)
createTimeStart	2025-03-11 00:00:00	String	否	创建开始时间(格式为：yyyy-MM-dd HH:mm:ss)
createTimeEnd	2025-03-11 00:00:00	String	否	创建结束时间(格式为：yyyy-MM-dd HH:mm:ss)
page	1	Integer	否	页码,默认1
rows	10	Integer	否	每页条数,默认10,最大100

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1717643679112	Long	时间戳
data		Object
├─records		Object[]	记录列表
├─├─imageId	img-25030796215	String	镜像ID
├─├─imageName	20250307_4	String	镜像名称
├─├─imageTag	20250307_4	String	镜像Tag
├─├─serverType	Cruise10	String	SOC类型
├─├─romVersion	android13	String	Rom版本
├─├─imageDesc	WIFI自定义版	String	描述
├─├─releaseType	1	Integer	发版版本 1测试版 2正式版
├─total		Integer	总记录条数
├─size		Integer	每页大小
├─current		Integer	当前页码
├─pages		Integer	总页数

请求示例

{
    "imageType":1,
        "releaseType":1,
        "romVersion":"android13",
        "createTimeStart":"2025-02-11 00:00:00",
        "createTimeEnd":"2025-03-11 00:00:00",
        "page":1,
        "rows":10
}

响应示例

{
    "code": 200,
        "msg": "success",
        "ts": 1741688704152,
        "data": {
        "records": [
            {
                "imageId": "img-25030796215",
                "imageName": "20250307_4",
                "imageTag": "20250307_4",
                "serverType": "Cruise10",
                "romVersion": "android13",
                "imageDesc": "",
                "releaseType": 1
            }
        ],
            "total": 4,
            "size": 10,
            "current": 1,
            "pages": 1
    }
}

错误码

错误码	错误说明	操作建议
500	请求参数不对	请正常输出传参
110040	账号不存在	账号是否不正确

镜像上传任务结果查询

通过任务ID来获取镜像上传任务结果。

接口地址

/task-center/open/task/imageUploadResult

请求方式

POST

请求数据类型

application/json

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
taskIds		Integer []	是
├─	36	Integer	是	任务ID

响应参数

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码
msg	success	String	响应消息
ts	1718262521168	Long	时间戳
data		Object[]
├─taskId	36	Integer	任务ID
├─taskStatus	2	Integer	任务状态：（-1：制作失败；1：制作中；2：制作成功；）
├─ errorMsg	“”	String	错误信息

请求示例

{
    "taskIds": [1]
}

响应示例

{
 "code": 200,
 "msg": "success",
 "ts": 1718262521168,
 "data": [
  {
   "taskId": 36,
   "taskStatus": 2,
   "errorMsg": ""
  }
 ]
}