Open Services 文档中心
2025-04-24
目录

OpenAPI文档

版本号 修改内容
1.0 初版文档
1.0.1 创建同屏推流会话、 从控设备切换、 查看同屏推流会话详情、 查看同屏推流会话列表 接口返回字段修改
1.0.2 实例列表接口新增sslForwardServer 实例推流Token获取 新增wssAddr地址 实例推流Token获取(批量) 新增wssAddr地址
1.0.3 新增实例控制token获取v2版本
1.0.4 新增实例镜像安卓版本枚举指定 全局安卓版本统一枚举
2.0.3g 新增接口： 1. 实例开机 2. 实例关机
2.0.4a 新增接口： 1. 实例全局root开启（同步） 2. 实例全局root开启（异步） 3. 实例全局root关闭（同步） 4. 实例全局root关闭（异步） 5. 实例应用root开启（同步） 6. 实例应用root开启（异步） 7. 实例应用root关闭（同步） 8. 实例应用root关闭（异步） 9. 实例应用前台保活开启（同步） 10. 实例应用前台保活开启（异步） 11. 实例应用前台保活关闭（同步） 12. 实例应用前台保活关闭（异步） 13. 实例应用后台保活开启（同步） 14. 实例应用后台保活开启（异步） 15. 实例应用后台保活关闭（同步） 16. 实例应用后台保活关闭（异步） 17. 实例屏幕截图V2(异步) 修改接口： 1. 查询实例应用清单，返回内容增加：icon图标、应用root权限、应用前台保活状态，应用后台保活状态
2.0.4b 实例列表V2  返回值新增 lables 字段 实例列表  返回值新增 lables 字段
2.0.4b 1. 文件列表：请求参数新增MD5 2. 应用列表：请求参数新增MD5
2.0.4d 新增接口： 1. 实例执行命令（异步）V2 2. 推流属性设置（异步） 3. 系统属性设置（异步） 4. 实例换肤（异步）V2 5. 实例ADB服务启动（异步）V2 6. 实例ADB服务停止（异步）V2 7. 实例SSH服务启动（异步）V2 8. 实例SSH服务停止（异步）V2 9. 实例开启ADB鉴权（异步） 10. 实例关闭ADB鉴权（异步）
2.0.4b 新增接口： 1. 实例ADB服务启动（同步）V2 2. 实例ADB服务停止（同步）V2 3. 实例SSH服务启动（同步）V2 4. 实例SSH服务停止（同步）V2 5. 实例开启ADB鉴权（同步） 6. 实例关闭ADB鉴权（同步） 7. 实例屏幕截图V2（批量同步）
2.0.4b 新增接口： 1. 实例文件上传V2 2. 实例应用安装V2 任务回调： 1. 任务相关异步接口增加可选参数：回调地址 2. 任务回调功能相关说明
2.0.4d-1 实例webssh新增返回ssl地址
2.0.4d-2 1. 新增查询实例应用清单（批量同步）V2

# 注意事项说明

  • 以 删除线  标记的旧版本接口不再维护更新，麻烦接入以新版本接口接入及更新

# 鉴权管理

# AK/SK鉴权方案

为保护暴露公⽹的OpenAPI的安全，使⽤AK/SK⽅案处理接⼝调⽤的安全性问题，故编写本⽂档⽤于沟通和对接。

阅读对象

本⽂档适⽤于开发⼈员、测试⼈员等技术相关⼈员

名词解释

AK：Access Key Id,⽤于标⽰⽤⼾

SK：Secret Access Key,是⽤⼾⽤于加密认证字符串和⽤来验证认证字符串的秘钥，SK必须保密且不得在接⼝中传输

sign：通过AK+SK+参数value字符串进⾏多次加密后字符串

鉴权流程

  1. 客⼾端预置AK/SK

  2. 客⼾端发起请求前将参数排序，按照排序将参数值连接为字符串 (1) 第⼀步，设所有发送或者接收到的数据为集合M，将集合M内⾮空参数值的参数按照参数名ASCII 码从⼩到⼤排序（字典序），使⽤URL键值对的格式（即key1=value1&key2=value2...）拼接成字符串stringA。特别注意以下重要规则：

◆ 参数名ASCII码从⼩到⼤排序（字典序）；

◆ 如果参数的值为空不参与签名(空字符串参与sign计算，null值不参与)；

◆ 如果参数的值是对象，需要将对象转换为Json字符串⽤于签名；

◆ 参数名区分⼤⼩写； (2) 第⼆步，stringSignTemp= stringA+&ak=xxx&sk=xxx,并对stringSignTemp进⾏MD5运算， sign=MD5(stringSignTemp)。 注意：密钥的⻓度为32个字符

  1. 客⼾端在请求头中包含ak=ak，sign=sign，version=1

  2. 服务端收到请求后，按照客⼾端的加密⽅式计算serverSign

  3. 如果serverSign等于sign，表⽰鉴权通过

JAVA版签名算法

package org.springblade.gateway.filter;
import java.security.MessageDigest;
import java.util.*;
/**
* 签名效验
* @Description:
*/
public class SignFilter {
    public static final String FIELD_SIGN = "sign";
    /**
    * ⽣成签名. 注意，若含有sign_type字段，必须和signType参数保持⼀致。
    *
    * @param data 待签名数据
    * @param appId AK
    * @param appSecurity SK
    * @param signType 签名⽅式
    * @return 签名
    */
    public static String generateSignature(Map<String, String> data, String
    appId, String appSecurity, SignType signType) throws Exception {
        Set<String> keySet = data.keySet();
        String[] keyArray = keySet.toArray(new String[keySet.size()]);
        Arrays.sort(keyArray);
        StringBuilder sb = new StringBuilder();
        for (String k : keyArray) {
            if (k.equals(FIELD_SIGN)) {
                continue;
            }
            // 参数值为空，则不参与签名
            if (data.get(k).trim().length() > 0) {
                sb.append(k).append("=").append(data.get(k).trim()).append("&");
            }
        }
        sb.append("ak=").append(appId).append("&sk=").append(appSecurity);
        if (SignType.MD5.equals(signType)) {
            return MD5(sb.toString()).toUpperCase();
        }
        else {
            throw new Exception(String.format("Invalid sign_type: %s",signType));
        }
    }

    public enum SignType {
        MD5, HMACSHA256
    }
    /**
    * ⽣成 MD5
    *
    * @param data 待处理数据
    * @return MD5结果
    */
    public static String MD5(String data) throws Exception {
        java.security.MessageDigest md = MessageDigest.getInstance("MD5");
        byte[] array = md.digest(data.getBytes("UTF-8"));
        StringBuilder sb = new StringBuilder();
            for (byte item : array) {
                sb.append(Integer.toHexString((item & 0xFF) | 0x100).substring(1,
                3));
            }
        return sb.toString().toUpperCase();
    }
    public static void main(String[] args) throws Exception {
        String appId = "ABC";
        String appSecret = "DEF";
        Map<String,String> params = new HashMap<>(8);
        params.put("param1","1");
        params.put("bparam2","2");
        params.put("aparam3","2");
        params.put("cparam4","2");
        params.put("dparam5","2");
        params.put("param6","2");
        String signature = generateSignature(params, appId, appSecret,
        SignType.MD5);
        System.out.println(signature);
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76

# 机房管理

# 机房列表

接口说明

地址 请求方式 版本
http://{ip}/api/v1/idc/list POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
regionCode String 否 机房区域编码
vendor String 否 供应商编码

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
regionCode String 机房区域编码
idcs ArrayList<Object> 机房列表
返回参数 参数类型 参数说明
idcCode String 机房编码
vendor String 供应商编码
idcName String 机房名称

返回示例

{
    "status": 0,
    "message":"success",
    "data": [
        {
            "regionCode": "HUANAN",
            "idcs":[
                {
                "idcCode": "FSNH",
                "vendor": "RC",
                "idcName": "广东佛山"
                },
                {
                "idcCode": "GDSZ",
                "vendor": "RC",
                "idcName": "广东深圳"
                }
            ]
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 文件管理

# 新增文件

接口说明

地址 请求方式 版本
http://{ip}/api/v1/file/add POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
url String 是 文件下载地址，无鉴权可直接下载的地址
md5 String 否 文件md5
fileName String 否 文件名称

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Object 响应数据

响应数据

返回参数 参数类型 参数说明
fileId Integer 文件ID
fileStatus Integer 文件状态：1 上传中 2 成功 3 失败
fileMessage String 文件状态说明

返回示例

{
    "status": 0,
    "message":"success",
    "data": {
        "fileId": 123,
        "fileStatus": 1,
        "fileMessage": "success"
    }
}
1
2
3
4
5
6
7
8
9

code码说明

code msg
0 成功

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 删除文件

接口说明

地址 请求方式 版本
http://{ip}/api/v1/file/delete POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
fileIds ArrayList<Integer> 是 文件ID列表 最多1000个ID，最少1个ID

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
fileId Integer 删除失败的fileID
message String 删除失败的原因

返回示例

{
    "status": 0,
    "message":"success",
    "data": [
        {"fileId": 123,"message": "fileId不存在！"},
        {"fileId": 456,"message": "fileId不存在！"}
    ]
}
1
2
3
4
5
6
7
8

code码说明

code msg
0 成功
10001 部分删除失败

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 文件列表

接口说明

地址 请求方式 版本
http://{ip}/api/v1/file/list POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
fileId Integer 否 文件id
fileName String 否 文件名称，模糊匹配 abc.jpg
md5 String 否 文件MD5，精确匹配
page Integer 否 默认值1，表示查询第一页
pageSize Integer 否 默认值10，表示一页10条数据，最大值100，最小1

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Page 响应数据

响应数据

返回参数 参数类型 参数说明
page Integer 页数
pageSize Integer 分页大小
total Integer 总大小
records ArrayList<Object> 分页数据
返回参数 参数类型 参数说明
fileId Integer 文件id
fileName String 原文件名称
fileStatus Integer 文件状态：1 上传中 2 成功 3 失败
fileMessage String 状态说明字段
fileSize Integer 原文件大小：上传中0
md5 String 原文件md5
url String 原下载地址
remark String 备注
createTime Datetime 创建时间

返回示例

{
    "status": 0,
    "message":"success",
    "data": {
		"page": 1,
		"pageSize": 10,
		"total": 20,
		"records":[
			{
			"fileId": 256,
			"fileName": "xxx.apk",
			"fileStatus": 2,
			"fileMessage": "上传中",
			"size": 125686,
			"md5": "6ed86ad3f14db4db716c808cfc1ca392",
			"url": "http://versions.update.com/xxx.apk",
            "remark":"test",
			"createTime": "2024-8-30 14:09:20"
			},
			{
			"fileId": 257,
			"fileName": "aaa.apk",
			"fileStatus": 1,
			"fileMessage": "",
			"size": 125686,
			"md5": "6ed86ad3f14db4db716c808cfc1ca392",
			"url": "http://versions.update.com/aaa.apk",
            "remark":"test",
			"createTime": "2024-8-30 14:09:20"
			}
		]
	}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

code码说明

code msg
0 成功

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 应用管理

# 新增应用

接口说明

地址 请求方式 版本
http://{ip}/api/v1/app/add POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
url String 是 应用下载地址，无鉴权可直接下载的地址
md5 String 否 应用包md5
remark String 否 备注

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Object 响应数据

响应数据

返回参数 参数类型 参数说明
appId Integer 应用ID
appStatus Integer 应用状态:  1.上传中 2.成功 3.失败
appMessage String 应用状态说明

返回示例

{
    "status": 0,
    "message":"success",
    "data": {
        "appId": 123,
        "appStatus": 1,
        "appMessage": "success"
    }
}
1
2
3
4
5
6
7
8
9

code码说明

code msg
0 成功

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 删除应用

接口说明

地址 请求方式 版本
http://{ip}/api/v1/app/delete POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
appIds ArrayList<Integer> 是 应用ID列表 最多1000个ID，最少1个ID

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
appId Integer 应用ID
message String 删除失败说明

返回示例

{
    "status": 0,
    "message":"success",
    "data": [
        {"appId": 123,"message": "appID不存在！"},
        {"appId": 456,"message": "该应用被实例使用中"}
    ]
}
1
2
3
4
5
6
7
8

code码说明

code msg
0 success
11001 部分删除失败
11002 全部失败

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 应用列表

接口说明

地址 请求方式 版本
http://{ip}/api/v1/app/list POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
appId Integer 否 应用id*
appName String 否 应用名称 王者荣耀
remark String 否 应用备注
md5 String 否 应用MD5，精确匹配
page Integer 否 默认值1，表示查询第一页
pageSize Integer 否 默认值10，表示一页10条数据，最大值100，最小1

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Page 响应数据

响应数据

返回参数 参数类型 参数说明
page Integer 页数
pageSize Integer 分页大小
total Integer 总大小
records ArrayList<Object> 分页数据
返回参数 参数类型 参数说明
appId Integer 应用ID
status Integer 应用状态:  1.上传中 2.成功 3.失败
appMessage String 应用状态说明
appName String 应用名称
packageName String 包名
appVersion String 应用版本号
isEnabled Integer 启用状态：1.启用 2.禁用
md5 String 应用md5
url String 原下载地址
remark String 应用备注

返回示例

{
    "status": 0,
	"message":"success",
    "data": {
		"page": 1,
		"pageSize": 10,
		"total": 20,
		"records":[
			{
              "appId": 1,
              "status": 2,
              "appMessage": "上传成功",
              "appName": "MyApp",
              "packageName": "com.example.myapp",
              "appVersion": "1.0.0",
              "isEnabled": 1,
              "md5": "e10adc3949ba59abbe56e057f20f883e",
              "url": "http://example.com/myapp.apk",
              "remark": "这是一个示例应用"
            }
		]
	}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例管理

# 实例余量查询

  1. 板卡下的实例限制只能分配给同一个租户

接口说明

地址 请求方式 版本
http://{ip}/api/v1/instance/capacity POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
vendor String 否 供应商编码
cardType String 否 板卡类型，支持以下内容： QS865、QS8550、RK3588_128_A、RK3588_256_A、RK3588_256_B RK3588_128_A
instanceType String 否 实例类型，支持以下内容： C1、C2、C3、C4、C5、C6 C1
idc String 否 机房编码

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
vendor String 供应商编码
cardType String 板卡类型
instanceType String 实例类型
amount Integer 余量
idcList ArrayList<Object> 机房余量列表
返回参数 参数类型 参数说明
idc String 机房编码
idcName String 机房名称
regionCode String 机房区域编码
amount Integer 余量

返回示例

{
    "status": 0,
    "data": [
        {
            "vendor": "XX",
            "cardType": "RK3588_128_A",
            "instanceType": "C5",
            "amount": 5,
            "idcList": [
                {
                    "idc": "IDC2",
                    "idcName": "",
                    "regionCode": "",
                    "amount": 5
                }
            ]
        }
    ],
    "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例订购

  1. 优先从一个机房分配，单个机房数量不够时，分散到多个机房

  2. 同一板卡的实例，只分配给一个租户

接口说明

地址 请求方式 版本
http://{ip}/api/v1/instance/subscribe POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
amount Integer 是 订购数量(整机订购时代表服务器的数量)
vendor String 是 供应商编码
cardType String 是 板卡类型，支持以下内容： QS865、QS8550、RK3588_128_A、RK3588_256_A、RK3588_256_B RK3588_256_B
instanceType String 是 实例类型，支持以下内容： C1、C2、C3、C4、C5、C6 C1
idc String 否 机房编码
serverSub Boolean 否 是否未整机订购，默认false
serverSn ArrayList<String> 否 服务器sn
spec Integer 否 服务器规格，机箱内板卡数量。参考：48、60、84

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
instanceId String 实例ID
cardSn String 板卡SN
serverSn String 服务器SN
cardType String 板卡类型
instanceType String 实例类型
ip String 板卡ip
gateway String 板卡网关
mask String 板卡掩码
dns String 板卡dns
systemVersion String 系统版本
androidVersion String 安卓系统版本： Android10、 Android12、 Andorid13
imageId Integer 镜像id，初始化：0
vendor String 供应商编码
idc String 机房编码
onlineStatus Integer 在线状态：0.离线 1.在线
powerStatus Integer 开机状态：0.关机 1.开机
upgradeStatus Integer 升级状态：（0 未升级  1 升级中 2 成功 3 失败）
streamStatus Integer 推流状态：0.未推流 1.推流中
adbStatus Integer adb状态：0.关闭 1.开启
sshStatus Integer ssh状态：0.关闭 1.开启
cpu String cpu上限
memory Integer 内存规格（MB）
storage Integer 存储规格（MB）

返回示例

{
  "status": 0,
  "data": [
    {
      "instanceId": "RK5838P1262200760_26c5c335-f7fd-4bfc-8bd1-9f95e071d9b7",
      "cardType": "RK3588_128_A",
      "instanceType": "C4",
      "cardSn": "RK5838P1262200760",
      "serverSn": "S12B42M2V22201573",
      "ip": "172.26.11.175",
      "gateway": "172.26.255.254",
      "mask": "255.255.0.0",
      "dns": "223.5.5.5",
      "systemVersion": "paasVC20241129:120",
      "androidVersion": "Android10",
      "imageId": null,
      "vendor": "SZNS",
      "idc": "SZSY",
      "onlineStatus": 1,
      "powerStatus": 1,
      "upgradeStatus": 0,
      "streamStatus": 0,
      "adbStatus": 0,
      "sshStatus": 0,
      "cpu": "25%",
      "memory": 3712,
      "storage": 16384
    }
  ],
  "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例退订

接口说明

地址 请求方式 版本
http://{ip}/api/v1/instance/unsubscribe POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 是 实例id列表

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Object 响应数据

响应数据

返回示例

{
    "status": 0,
    "data": true,
    "message": "操作成功"
}
1
2
3
4
5

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例列表

接口说明

地址 请求方式 版本
http://{ip}/api/v1/instance/list POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 否 实例ID
cardSns ArrayList<String> 否 板卡SN
serverSns ArrayList<String> 否 服务器SN
idcs ArrayList<String> 否 机房编码
instanceType String 否 实例类型
vendor String 否 供应商
page Integer 否 默认值1，表示查询第一页
pageSize Integer 否 默认值10，表示一页10条数据，最大值1000，最小1
label String 否 实例标签 A、B

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Page 响应数据

响应数据

返回参数 参数类型 参数说明
page Integer 页数
pageSize Integer 分页大小
total Integer 总大小
records ArrayList<Object> 分页数据
返回参数 参数类型 参数说明
instanceId String 实例ID
cardSn String 板卡SN
serverSn String 服务器SN
ip String 实例ip
InstanceType String 实例类型
gateway String 实例网关
mask String 实例掩码
dns String 实例dns
systemVersion String 系统版本
androidVersion String 安卓系统版本： Android10、 Android12、 Andorid13
imageId Integer 镜像id，默认0
idc String 机房编码
vendor String 供应商编码
onlineStatus Integer 在线状态：0.离线 1.在线
powerStatus Integer 开机状态：0.关机 1.开机
upgradeStatus Integer 升级状态：0 未升级  1 升级中 2 成功 3 失败
streamStatus Integer 推流状态：0.未推流 1.推流中
adbStatus Integer adb状态：0.关闭 1.开启
sshStatus Integer ssh状态：0.关闭 1.开启
cpu String cpu上限
memory Integer 内存上限
storage Integer 存储上限
forwardServer ArrayList<Object> 转发地址
sslForwardServer ArrayList<Object> ssl转发地址，返回结构和forwardServer一致
seekAddress String 寻址地址
sslSeekAddress String 寻址地址（ssl）
labels ArrayList<String> 实例标签，示例值： A: 弹性隔离 B: 硬隔离 ...其他
返回参数 参数类型 参数说明
publicIp String 公网ip
isp Integer 运营商

返回示例

{
  "status": 0,
  "data": {
    "page": 1,
    "pageSize": 10,
    "total": 1,
    "records": [
      {
        "instanceId": "RK3S51P1402408652_13a55c0f-de94-4610-8e0b-4c3c51cb4771",
        "cardSn": "RK3S51P1402408652",
        "serverSn": "S12B51M2312400101",
        "ip": "172.26.22.205",
        "instanceType": "C6",
        "gateway": "172.26.255.254",
        "mask": "255.255.0.0",
        "dns": "114.114.114.114",
        "systemVersion": "VC20250102:1482xw",
        "androidVersion": "Android10",
        "imageId": 79,
        "idc": "SZSY",
        "vendor": "SZNS",
        "onlineStatus": 1,
        "powerStatus": 1,
        "upgradeStatus": 2,
        "streamStatus": 1,
        "adbStatus": 0,
        "sshStatus": 0,
        "cpu": "16%",
        "memory": 3413,
        "storage": 30720,
        "forwardServer": [
          {
            "publicIp": "183.62.127.92:44912",
            "isp": 1
          }
        ],
        "sslForwardServer": [
          {
            "publicIp": "183.62.127.92:44913",
            "isp": 1
          }
        ]
      }
    ]
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例列表V2

接口说明

地址 请求方式 版本
http://{ip}/api/v2/instance/list POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 否 实例ID
cardSns ArrayList<String> 否 板卡SN
serverSns ArrayList<String> 否 服务器SN
idcs ArrayList<String> 否 机房编码
instanceType String 否 实例类型
vendor String 否 供应商
page Integer 否 默认值1，表示查询第一页
pageSize Integer 否 默认值10，表示一页10条数据，最大值1000，最小1
label String 否 实例标签 A、B
cardType String 否 板卡类型

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Page 响应数据

响应数据

返回参数 参数类型 参数说明
page Integer 页数
pageSize Integer 分页大小
total Integer 总大小
records ArrayList<Object> 分页数据
返回参数 参数类型 参数说明
instanceId String 实例ID
cardSn String 板卡SN
serverSn String 服务器SN
ip String 实例ip
InstanceType String 实例类型
gateway String 实例网关
mask String 实例掩码
dns String 实例dns
systemVersion String 系统版本
androidVersion String 安卓版本
imageId Integer 镜像id
idc String 机房编码
vendor String 供应商编码
onlineStatus Integer 在线状态：0.离线 1.在线
powerStatus Integer 开机状态：0.关机 1.开机
upgradeStatus Integer 升级状态：0 未升级  1 升级中 2 成功 3 失败
streamStatus Integer 推流状态：0.未推流 1.推流中
adbStatus Integer adb状态：0.关闭 1.开启
sshStatus Integer ssh状态：0.关闭 1.开启
cpu String cpu上限
memory Integer 内存上限
storage Integer 存储上限
forwardServer ArrayList<Object> 转发地址
sslForwardServer ArrayList<Object> ssl转发地址，返回结构和forwardServer一致
labels ArrayList<String> 实例标签，示例值： A: 弹性隔离 B: 硬隔离 ...其他
cardType String 板卡类型
返回参数 参数类型 参数说明
publicIp String 公网ip
isp Integer 运营商

返回示例

{
    "status": 0,
    "data": {
        "page": 1,
        "pageSize": 10,
        "total": 1,
        "records": [
            {
                "instanceId": "RK5838P1262204495_0983c1f6-1967-466c-b4fe-8f8a7e761aaa",
                "cardSn": "RK5838P1262204495",
                "cardType":"RK3588_128_A"
                "serverSn": "S12B43M11012222",
                "ip": "192.168.204.91",
                "instanceType": "C5",
                "gateway": "192.168.204.1",
                "mask": "",
                "dns": "223.5.5.5",
                "systemVersion": "VC.20241127.119",
                "androidVersion": "c1a268e2afc953ad9607e8b1eae4a4a8",
                "imageId": "",
                "idc": "SZNS",
                "vendor": "RC",
                "onlineStatus": 1,
                "powerStatus": 1,
                "upgradeStatus": 2,
                "pushStreamStatus": "",
                "adbStatus": 0,
                "sshStatus": 0,
                "cpu": "20%",
                "memory": 1111111,
                "storage": 1111111,
                "forwardServer": [
                    {
                        "publicIp": "xxx:44912",
                        "isp": 1
                    }
                ],
                "sslForwardServer": [
                    {
                        "publicIp": "xxx:44913",
                        "isp": 1
                    }
                ]
            }
        ]
    },
    "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例控制Token获取

接口说明

地址 请求方式 版本
http://{ip}/api/v1/instance/control/token/get POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 是 实例ID列表
deviceId String 是 设备ID
renewalTime Integer 否 有效时间（小时）：默认24小时

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Object 响应数据

响应数据

返回参数 参数类型 参数说明
token String 控制token
expireTime Datetime 过期时间

返回示例

{
    "status": 0,
    "message":"success",
    "data": {
        "token": "6ed86ad3f14db4db716c808cfc1ca392",
        "expireTime": "2024-12-20 00:00:00"
    }
}
1
2
3
4
5
6
7
8

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例控制Token获取V2

对于v1版本区别，token在有效期内不会重新生成

接口说明

地址 请求方式 版本
http://{ip}/api/v2/instance/control/token/get POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 是 实例ID列表
deviceId String 是 设备ID
renewalTime Integer 否 有效时间（小时）：默认24小时

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
instanceId String 实例id
idc String 机房标识
ip String 实例ip
token String 控制token
expireTime Datetime 过期时间

返回示例

{
    "status": 0,
    "message":"success",
    "data": [{
            "instanceId": "RK333333333333333_d6d00764-c246-4ed8-b942-f0e8ef28a3c1",
            "idc":"FSNH",
            "ip": "192.168.204.96",
            "token": "1511f7e343064320%7C123456",
            "expireTime": "2025-01-03 10:34:41"
        }]
}
1
2
3
4
5
6
7
8
9
10
11

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例推流Token获取

接口说明

地址 请求方式 版本
http://{ip}/api/v1/instance/stream/token/get POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
instanceId String 是 实例ID
deviceId String 是 设备ID
renewalTime Integer 否 有效时间（小时）：默认2小时

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Object 响应数据

响应数据

返回参数 参数类型 参数说明
deviceId String 设备ID
ip String 实例ip
token String 鉴权token
expireTime Datetime 过期时间
signalServer ApiSignalServer 信令服务器信息
coturnServers AarrayList<ApiCoturnServer> 转发服务器信息

ApiSignalServer

返回参数 参数类型 参数说明
tcpAddr String tcp信令地址
wsAddr String ws信令地址
wssAddr String wss信令地址

ApiCoturnServer

返回参数 参数类型 参数说明
isp Integer 运营商: 1.移动 2.联调 4.电信 8.BGP
addr String 服务器地址

返回示例

{
    "status": 0,
    "message":"success",
    "data": {
        "deviceId": "123456",
        "ip": "192.168.1.54",
        "token": "6ed86ad3f14db4db716c808cfc1ca392",
        "expireTime": "2024-12-20 00:00:00",
        "signalServer": {
          "tcpAddr": "nats://192.168.11.1:4432",
          "wsAddr": "nats://192.168.11.1:4431",
          "wssAddr": "wss://192.168.11.1:44913"
        },
        "coturnServers": [{
          "isp": 1,
          "addr": "192.168.11.3:3478"
        },{
          "isp": 2,
          "addr": "192.168.11.4:3478"
        }]
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例推流Token获取(批量)

接口说明

地址 请求方式 版本
http://{ip}/api/v1/instance/stream/token/batch/get POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 是 实例ID列表
deviceId String 是 设备ID
renewalTime Integer 否 有效时间（小时）：默认2小时

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
instanceId String 实例ID
ip String 实例ip
deviceId String 设备ID
token String 鉴权token
expireTime Datetime 过期时间
signalServer ApiSignalServer 信令服务器信息
coturnServers ArrayList<ApiCoturnServer> 转发服务器信息

ApiSignalServer

返回参数 参数类型 参数说明
tcpAddr String tcp信令地址
wsAddr String ws信令地址
wssAddr String wss信令地址

ApiCoturnServer

返回参数 参数类型 参数说明
isp Integer 运营商: 1.移动 2.联调 4.电信 8.BGP
addr String 服务器地址

返回示例

{
    "status": 0,
    "message":"success",
    "data": [{
        "instanceId":"xxxxxxxxxxxxxxx",
        "ip": "192.168.1.54",
        "deviceId": "123456",
        "token": "6ed86ad3f14db4db716c808cfc1ca392",
        "expireTime": "2024-12-20 00:00:00",
        "signalServer": {
          "tcpAddr": "nats://192.168.11.1:4432",
          "wsAddr": "nats://192.168.11.1:4431",
          "wssAddr": "wss://192.168.11.1:44913"
        },
        "coturnServers": [{
          "isp": 1,
          "addr": "192.168.11.3:3478"
        },{
          "isp": 2,
          "addr": "192.168.11.4:3478"
        }]
    }]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例推流Token获取V2

接口说明

地址 请求方式 版本
http://{ip}/api/v2/instance/stream/token/get POST 2.0

请求参数

请求参数 类型 必填 参数说明 示例
instanceId String 是 实例ID
deviceId String 是 设备ID
renewalTime Integer 否 有效时间（小时）：默认2小时

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Object 响应数据

响应数据

返回参数 参数类型 参数说明
instanceId String 实例标识
ip String 实例IP
deviceId String 设备ID
token String 鉴权token
expireTime Datetime 过期时间
signalInfo SignalInfo 信令服务器信息
coturnInfo CoturnInfo 转发服务寻址信息

SignalInfo

返回参数 参数类型 参数说明
signalTcp String tcp信令地址
signalWs String ws信令地址
signalWss String wss信令地址

CoturnInfo

返回参数 参数类型 参数说明
coturnHttp String http寻址地址
coturnHttps String https寻址地址

返回示例

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例推流Token获取(批量)V2

接口说明

地址 请求方式 版本
http://{ip}/api/v2/instance/stream/token/batch/get POST 2.0

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 是 实例ID列表
deviceId String 是 设备ID
renewalTime Integer 否 有效时间（小时）：默认2小时

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
instanceId String 实例ID
ip String 实例IP
deviceId String 设备ID
token String 鉴权token
expireTime Datetime 过期时间
signalInfo SignalInfo 信令服务器信息
coturnInfo CoturnInfo 转发服务寻址信息

SignalInfo

返回参数 参数类型 参数说明
signalTcp String tcp信令地址
signalWs String ws信令地址
signalWss String wss信令地址

CoturnInfo

返回参数 参数类型 参数说明
coturnHttp String http寻址地址
coturnHttps String https寻址地址

返回示例

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 获取实例SSH连接信息

接口说明

地址 请求方式 版本
http://{ip}/api/v1/instance/ssh/get GET 1.0

请求参数

请求参数 类型 必填 参数说明 示例
instanceId String 是 实例ID

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Object 响应数据

响应数据

返回参数 参数类型 参数说明
sshUrl String ssh ip
sshSslUrl String

返回示例

{
    "status": 0,
    "message":"success",
    "data": {
        "sshUrl": "http://14.15.63.25:8888/ssh.html",
        "sshSslUrl": "https://14.15.63.25:8889/ssh.html"
    }
}
1
2
3
4
5
6
7
8

code码说明

code msg
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 获取实例ADB连接信息

接口说明

地址 请求方式 版本
http://{ip}/api/v1/instance/adb/get GET 1.0

请求参数

请求参数 类型 必填 参数说明 示例
instanceId String 是 实例ID

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Object 响应数据

响应数据

返回参数 参数类型 参数说明
adbIp String adb ip
adbPort Integer adb 端口

返回示例

{
    "status": 0,
    "message":"success",
    "data": {
        "adbIp": "14.12.15.26",
        "adbPort": 3265
    }
}
1
2
3
4
5
6
7
8

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 终止实例推流

接口说明

地址 请求方式 版本
http://{ip}/api/v1/instance/stream/stop POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
instanceId String 是 实例ID

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Object 响应数据

响应数据

返回参数 参数类型 参数说明

返回示例

{
    "status": 0,
    "message":"success",
    "data": {}
}
1
2
3
4
5

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例执行命令（异步）

  1. 每个实例命令执行30秒内未完成，该实例按超时处理

接口说明

地址 请求方式 版本
http://{ip}/api/v1/instance/cmd/async/run POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 是 实例ID列表，最多1000个
command String 是 执行命令，不支持无法自主结束的命令 例如：top、vim 执行结果最大1KB ls
timeout Integer 是 超时时间范围1-10秒
isCallback Boolean 否 是否回调，默认：true
callbackUrl String 否 回调地址

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
resourceId String 实例ID
taskId Integer 主任务ID
subTaskId Integer 子任务ID

返回示例

{
    "status": 0,
    "data": [
        {
            "resourceId": "RK333333333333332_61ae5f48-b3f6-4c50-a9d6-a501d85ad277",
            "taskId": 529,
            "subTaskId": 698
        },
        {
            "resourceId": "RK333333333333332_d9bdf286-8bf2-49fe-b27e-9b64836862ef",
            "taskId": 529,
            "subTaskId": 699
        }
    ],
    "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例限速设置

接口说明

地址 请求方式 版本
http://{ip}/api/v1/instance/bandwidth/set POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 是 实例ID列表，最多1000个
downstream Integer 是 下行带宽，单位Mbps
upstream Integer 是 上行带宽，单位Mbps

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Object 响应数据

响应数据

返回参数 参数类型 参数说明
resourceId String 实例IDs
setResult String 设置结果说明
setStatus Integer 1设置成功，2设置失败

返回示例

{
    "status": 0,
    "data": [
        {
            "resourceId": "RK333333333333332_61ae5f48-b3f6-4c50-a9d6-a501d85ad277",
            "taskId": 530,
            "subTaskId": 700
        },
        {
            "resourceId": "RK333333333333332_d9bdf286-8bf2-49fe-b27e-9b64836862ef",
            "taskId": 530,
            "subTaskId": 701
        }
    ],
    "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例内存设置

接口说明

地址 请求方式 版本
http://{ip}/api/v1/instance/memory/set POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 是 实例ID列表，最多1000个
memorySize Integer 是 内存限制，单位MB，最小2048

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Object 响应数据

响应数据

返回参数 参数类型 参数说明
instanceId String 实例ID
status Integer 状态：0.失败 1.成功
msg String 失败结果说明

返回示例

{
    "status": 0,
    "message":"success",
    "data": [
        {
        "instanceId": "xxxxx",
        "status": 1,
        "msg": ""
        },
        {
        "instanceId": "xxxxx",
        "status": 0,
        "msg": "xxxxx"
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例屏幕截图

接口说明

地址 请求方式 版本
http://{ip}/api/v1/instance/screen/capture POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 是 实例ID列表，最多1000个
localStorage Boolean 否 是否保存到本地，默认false
isCallback Boolean 否 是否回调，默认：true
callbackUrl String 否 回调地址

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Object 响应数据

响应数据

返回参数 参数类型 参数说明
resourceId String 实例ID
taskId Integer 主任务ID
subTaskId Integer 子任务ID：如果截图成功，截图会保留在 /v1/subtask/list 接口的orderDesc字段

返回示例

{
    "status": 0,
    "data": [
        {
            "resourceId": "RK333333333333332_61ae5f48-b3f6-4c50-a9d6-a501d85ad277",
            "taskId": 531,
            "subTaskId": 702
        },
        {
            "resourceId": "RK333333333333332_d9bdf286-8bf2-49fe-b27e-9b64836862ef",
            "taskId": 531,
            "subTaskId": 703
        }
    ],
    "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例文件上传

  1. 文件分发到供应商之后，可以上传到供应商的实例

  2. path为父目录绝对路径，如：/data/media/0/  (末尾需要携带/)

接口说明

地址 请求方式 版本
http://{ip}/api/v1/instance/file/upload POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 是 实例ID列表，最多1000个
path String 是 实例文件保存路径
fileId Integer 是 文件ID，通过文件上传后获取 参考：文件管理-新增文件
isCallback Boolean 否 是否回调，默认：true
callbackUrl String 否 回调地址

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
resourceId String 实例ID
isSuccess Boolean 单个实例的执行结果，true：成功；false：失败
reason String 失败原因
taskId Integer 主任务ID，成功时有内容
subTaskId Integer 子任务ID，成功时有内容

返回示例

{
    "status": 0,
    "data": [
        {
            "resourceId": "RK333333333333332_61ae5f48-b3f6-4c50-a9d6-a501d85ad277",
            "taskId": 534,
            "subTaskId": 708,
            "isSuccess": true,
            "reason": ""
        },
        {
            "resourceId": "RK333333333333332_d9bdf286-8bf2-49fe-b27e-9b64836862ef",
            "taskId": 534,
            "subTaskId": 709,
            "isSuccess": true,
            "reason": ""
        }
    ],
    "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例文件上传V2

  1. path为父目录绝对路径，如：/data/media/0/  (末尾需要携带/)

接口说明

地址 请求方式 版本
http://{ip}/api/v2/instance/file/upload POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 是 实例ID列表，最多1000个
path String 是 实例文件保存路径
url String 是 文件下载地址
md5 String 否 文件md5
fileName String 否 文件名称
isCallback Boolean 否 是否回调，默认：true
callbackUrl String 否 回调地址

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
resourceId String 实例ID
isSuccess Boolean 单个实例的执行结果，true：成功；false：失败
reason String 失败原因
taskId Integer 主任务ID，成功时有内容
subTaskId Integer 子任务ID，成功时有内容

返回示例

{
    "status": 0,
    "data": [
        {
            "resourceId": "RK333333333333332_61ae5f48-b3f6-4c50-a9d6-a501d85ad277",
            "taskId": 534,
            "subTaskId": 708,
            "isSuccess": true,
            "reason": ""
        },
        {
            "resourceId": "RK333333333333332_d9bdf286-8bf2-49fe-b27e-9b64836862ef",
            "taskId": 534,
            "subTaskId": 709,
            "isSuccess": true,
            "reason": ""
        }
    ],
    "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例应用安装

接口说明

地址 请求方式 版本
http://{ip}/api/v1/instance/app/install POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 是 实例ID列表，最多1000个
appId Integer 是 应用ID
isCallback Boolean 否 是否回调，默认：true
callbackUrl String 否 回调地址

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
resourceId String 资源ID
taskId Integer 主任务ID
subTaskId Integer 子任务ID

返回示例

{
    "status": 0,
	"message":"success",
    "data": [
        {
        "resourceId": "xxxxxx",
        "taskId": 4,
        "subTaskId":1
        },
        {
        "resourceId": "xxxxxx",
        "taskId": 4,
        "subTaskId":1
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例应用安装V2

接口说明

地址 请求方式 版本
http://{ip}/api/v2/instance/app/install POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 是 实例ID列表，最多1000个
url String 是 应用下载地址
md5 String 否 文件md5
isCallback Boolean 否 是否回调，默认：true
callbackUrl String 否 回调地址

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
resourceId String 资源ID
taskId Integer 主任务ID
subTaskId Integer 子任务ID

返回示例

{
    "status": 0,
	"message":"success",
    "data": [
        {
        "resourceId": "xxxxxx",
        "taskId": 4,
        "subTaskId":1
        },
        {
        "resourceId": "xxxxxx",
        "taskId": 4,
        "subTaskId":1
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例应用控制

接口说明

地址 请求方式 版本
http://{ip}/api/v1/instance/app/control POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 是 实例ID列表，最多1000个
packageName String 是 应用包名
operatorType String 是 操作类型：uninstall(卸载) start(启动) stop(停止)  enable(启用) disable(禁用) clear(清理)
isCallback Boolean 否 是否回调，默认：true
callbackUrl String 否 回调地址

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
resourceId String 资源ID
taskId Integer 主任务ID
subTaskId Integer 子任务ID

返回示例

{
    "status": 0,
	"message":"success",
    "data": [
        {
        "resourceId": "xxxxxx",
        "taskId": 4,
        "subTaskId":1
        },
        {
        "resourceId": "xxxxxx",
        "taskId": 4,
        "subTaskId":1
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例重启

接口说明

地址 请求方式 版本
http://{ip}/api/v1/instance/reboot POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 是 实例ID列表，最多1000个
isCallback Boolean 否 是否回调，默认：true
callbackUrl String 否 回调地址

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
resourceId String 实例ID
taskId Integer 主任务ID
subTaskId Integer 子任务ID

返回示例

{
    "status": 0,
    "data": [
        {
            "resourceId": "RK333333333333332_61ae5f48-b3f6-4c50-a9d6-a501d85ad277",
            "taskId": 539,
            "subTaskId": 718
        },
        {
            "resourceId": "RK333333333333332_d9bdf286-8bf2-49fe-b27e-9b64836862ef",
            "taskId": 539,
            "subTaskId": 719
        }
    ],
    "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例开机

接口说明

地址 请求方式 版本
http://{ip}/api/v1/instance/start POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 是 实例ID列表，最多1000个
isCallback Boolean 否 是否回调，默认：true
callbackUrl String 否 回调地址

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
resourceId String 实例ID
taskId Integer 主任务ID
subTaskId Integer 子任务ID

返回示例

{
    "status": 0,
    "data": [
        {
            "resourceId": "RK333333333333332_61ae5f48-b3f6-4c50-a9d6-a501d85ad277",
            "taskId": 539,
            "subTaskId": 718
        },
        {
            "resourceId": "RK333333333333332_d9bdf286-8bf2-49fe-b27e-9b64836862ef",
            "taskId": 539,
            "subTaskId": 719
        }
    ],
    "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例关机

接口说明

地址 请求方式 版本
http://{ip}/api/v1/instance/stop POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 是 实例ID列表，最多1000个
isCallback Boolean 否 是否回调，默认：true
callbackUrl String 否 回调地址

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
resourceId String 实例ID
taskId Integer 主任务ID
subTaskId Integer 子任务ID

返回示例

{
    "status": 0,
    "data": [
        {
            "resourceId": "RK333333333333332_61ae5f48-b3f6-4c50-a9d6-a501d85ad277",
            "taskId": 539,
            "subTaskId": 718
        },
        {
            "resourceId": "RK333333333333332_d9bdf286-8bf2-49fe-b27e-9b64836862ef",
            "taskId": 539,
            "subTaskId": 719
        }
    ],
    "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例恢复出厂

接口说明

地址 请求方式 版本
http://{ip}/api/v1/instance/recovery POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 是 实例ID列表，最多1000个
isNewMachine Boolean 否 是否一键新机，默认为false
isCallback Boolean 否 是否回调，默认：true
callbackUrl String 否 回调地址

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
resourceId String 实例ID
taskId Integer 主任务ID
subTaskId Integer 子任务ID

返回示例

{
    "status": 0,
    "data": [
        {
            "resourceId": "RK333333333333332_61ae5f48-b3f6-4c50-a9d6-a501d85ad277",
            "taskId": 540,
            "subTaskId": 720
        },
        {
            "resourceId": "RK333333333333332_d9bdf286-8bf2-49fe-b27e-9b64836862ef",
            "taskId": 540,
            "subTaskId": 721
        }
    ],
    "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例换肤

接口说明

地址 请求方式 版本
http://{ip}/api/v1/instance/skin/refresh POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 是 实例ID列表，最多1000个
brand String 是 品牌 HUAWEI
model String 是 型号 HUAWEI META 60
isCallback Boolean 否 是否回调，默认：true
callbackUrl String 否 回调地址

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
resourceId String 实例ID
taskId Integer 主任务ID
subTaskId Integer 子任务ID

返回示例

{
    "status": 0,
    "data": [
        {
            "resourceId": "RK333333333333332_61ae5f48-b3f6-4c50-a9d6-a501d85ad277",
            "taskId": 597,
            "subTaskId": 793
        },
        {
            "resourceId": "RK333333333333332_d9bdf286-8bf2-49fe-b27e-9b64836862ef",
            "taskId": 597,
            "subTaskId": 794
        }
    ],
    "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例备份

  1. 备份路径只能是 /data/ 或者其子目录

  2. 同时有 excludes 和 includes，以 excludes为准

  3. excludes 和 includes 为空时，包含所有子文件和子文件夹

  4. exclueds 和 includes 中路径必须是以绝对路径开始

  5. 通配符只支持星号，并且只能一个，规则为匹配任意长度的任意字符

  6. 通配符只能出现在中间和结尾，不能出现在头部

  7. 备份时实例关机，还原时实例关机

备份逻辑：

path+includes取交集

然后在交集中剔除 excludes

接口说明

地址 请求方式 版本
http://{ip}/api/v1/instance/data/backup POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
instanceId String 是 实例ID
path String 是 根路径 /data/
includes ArrayList<String> 否 包含路径，支持通配符
excludes ArrayList<String> 否 排除路径，支持通配符
isCallback Boolean 否 是否回调，默认：true
callbackUrl String 否 回调地址

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Object 响应数据

响应数据

返回参数 参数类型 参数说明
resourceId String 实例ID
backupId String 备份ID
taskId Integer 主任务ID
subTaskId Integer 子任务ID

返回示例

{
    "status": 0,
    "data": {
        "resourceId": "RK333333333333332_d9bdf286-8bf2-49fe-b27e-9b64836862ef",
        "taskId": 541,
        "subTaskId": 722,
        "backupId": "25"
    },
    "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例还原

接口说明

地址 请求方式 版本
http://{ip}/api/v1/instance/data/restore POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 是 实例ID列表
backupId String 是 备份ID
isCallback Boolean 否 是否回调，默认：true
callbackUrl String 否 回调地址

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Object 响应数据

响应数据

返回参数 参数类型 参数说明
instanceId String 实例ID
taskId Integer 主任务ID
subTaskId Integer 子任务ID

返回示例

{
    "status": 0,
    "data": [
        {
            "resourceId": "RK333333333333332_61ae5f48-b3f6-4c50-a9d6-a501d85ad277",
            "taskId": 542,
            "subTaskId": 723
        },
        {
            "resourceId": "RK333333333333332_d9bdf286-8bf2-49fe-b27e-9b64836862ef",
            "taskId": 542,
            "subTaskId": 724
        }
    ],
    "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例换机（数据迁移）

源实例上的数据不清理

接口说明

地址 请求方式 版本
http://{ip}/api/v1/instance/data/replace POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
sourceInstanceId String 是 源实例ID
targetInstanceId String 是 目标实例ID
isCallback Boolean 否 是否回调，默认：true
callbackUrl String 否 回调地址

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Object 响应数据

响应数据

返回参数 参数类型 参数说明
sourceInstanceId String 源实例ID
targetInstanceId String 目标实例ID
taskId Integer 主任务ID
subTaskId Integer 子任务ID

返回示例

{
    "status": 0,
    "data": {
        "sourceInstanceId": "RK333333333333332_61ae5f48-b3f6-4c50-a9d6-a501d85ad277",
        "targetInstanceId": "RK333333333333332_d9bdf286-8bf2-49fe-b27e-9b64836862ef",
        "taskId": 545,
        "subTaskId": 728
    },
    "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例镜像更新

  1. 镜像必须分发完成

  2. 实例的供应商和板卡类型与镜像一致

接口说明

地址 请求方式 版本
http://{ip}/api/v1/instance/image/upgrade POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 是 实例ID列表，最多1000个
imageId Integer 是 实例镜像ID，参考：实例镜像管理-新增实例镜像
isCallback Boolean 否 是否回调，默认：true
callbackUrl String 否 回调地址

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
resourceId String 实例ID
taskId Integer 主任务ID
subTaskId Integer 子任务ID

返回示例

{
    "status": 0,
    "data": [
        {
            "resourceId": "RK333333333333332_61ae5f48-b3f6-4c50-a9d6-a501d85ad277",
            "taskId": 546,
            "subTaskId": 729
        },
        {
            "resourceId": "RK333333333333332_d9bdf286-8bf2-49fe-b27e-9b64836862ef",
            "taskId": 546,
            "subTaskId": 730
        }
    ],
    "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 宿主机重启

接口说明

地址 请求方式 版本
http://{ip}/api/v1/card/reboot POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
sn ArrayList<String> 是 宿主机sn列表，最多1000个
isCallback Boolean 否 是否回调，默认：true
callbackUrl String 否 回调地址

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
resourceId String 实例ID
taskId Integer 主任务ID
subTaskId Integer 子任务ID

返回示例

{
    "status": 0,
    "message":"success",
    "data": [
        {
        "resourceId": "xxxxxx",
        "taskId": 4,
        "subTaskId":1
        },
        {
        "resourceId": "xxxxxx",
        "taskId": 4,
        "subTaskId":1
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 查询实例应用清单

  1. 第三方应用

接口说明

地址 请求方式 版本
http://{ip}/api/v1/instance/app/list POST 2.0.4d

请求参数

请求参数 类型 必填 参数说明 示例
instanceId String 是 实例ID

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
label String 应用名称
packageName String 包名
version String 版本号
icon String icon图标（图片base64编码内容）
root Boolean 应用root权限：true：开启，false：关闭
appFrontStatus Boolean 应用前台保活状态：true：开启，false：关闭
appBackStatus Boolean 应用后台保活状态：true：开启，false：关闭
disable Boolean 应用是否禁用：true：禁用，false：启用

返回示例

{
    "status": 0,
    "message":"success",
    "data": [
        {
          "label": "xxxxxx",
          "packageName": "xxx",
          "version":"1",
          "icon": "xxx",
          "root": true,
          "appFrontStatus":true,
          "appBackStatus":true,
          "disable":true
        },
        {
          "label": "xxxxxx",
          "packageName": "xxx",
          "version":"1",
          "icon": "xxx",
          "root": true,
          "appFrontStatus":true,
          "appBackStatus":true,
          "disable":false
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 查询实例应用清单（批量同步）V2

  1. 第三方应用

接口说明

地址 请求方式 版本
http://{ip}/api/v2/instance/app/list POST 2.0.4d

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 是 实例ID集合

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
instanceId String 实例ID
label String 应用名称
packageName String 包名
version String 版本号

返回示例

{
    "status": 0,
    "message":"success",
    "data": [
        {
          "instanceId":"xxxxxxxxxx",
          "label": "xxxxxx",
          "packageName": "xxx",
          "version":"1",
        },
        {
          "instanceId":"xxxxxxxxxx",
          "label": "xxxxxx",
          "packageName": "xxx",
          "version":"1"
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例应用清单（异步）V2

  1. 第三方应用

接口说明

地址 请求方式 版本
http://{ip}/api/v2/instance/app/list/async POST 2.0.4b

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 是 实例ID列表，最多1000个
isCallback Boolean 否 是否回调，默认：true
callbackUrl String 否 回调地址

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
resourceId String 实例ID
taskId Integer 主任务ID
subTaskId Integer 子任务ID

返回示例

{
    "status": 0,
    "data": [
        {
            "resourceId": "RK333333333333332_61ae5f48-b3f6-4c50-a9d6-a501d85ad277",
            "taskId": 597,
            "subTaskId": 793
        },
        {
            "resourceId": "RK333333333333332_d9bdf286-8bf2-49fe-b27e-9b64836862ef",
            "taskId": 597,
            "subTaskId": 794
        }
    ],
    "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 查询机型列表

接口说明

地址 请求方式 版本
http://{ip}/api/v1/instance/machine/get GET 1.0

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
brand String 品牌
models ArrayList<String> 型号

返回示例

{
    "status": 0,
    "data": [
        {
            "brand": "HONOR",
            "models": [
                "ELZ-AN10",
                "OXF-AN10",
                "PGT-AN10",
                "PGT-AN00",
                "YAL-AL50"
            ]
        },
        {
            "brand": "samsung",
            "models": [
                "SM-A5160"
            ]
        },
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例全局root开启（同步）

接口说明

地址 请求方式 版本
http://{ip}/api/v2/instance/root/global/open/sync POST 2.0.4a

请求参数

请求参数 类型 必填 参数说明 示例
instanceId String 是 实例唯一标识

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Object 响应数据

返回示例

code码说明

code msg desc
0 success

详细说明

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例全局root开启（异步）

接口说明

地址 请求方式 版本
http://{ip}/api/v2/instance/root/global/open/async POST 2.0.4a

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 是 实例ID列表，最多1000个
isCallback Boolean 否 是否回调，默认：true
callbackUrl String 否 回调地址

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
resourceId String 实例ID
taskId Integer 主任务ID
subTaskId Integer 子任务ID

返回示例

{
    "status": 0,
    "data": [
        {
            "resourceId": "RK333333333333332_61ae5f48-b3f6-4c50-a9d6-a501d85ad277",
            "taskId": 597,
            "subTaskId": 793
        },
        {
            "resourceId": "RK333333333333332_d9bdf286-8bf2-49fe-b27e-9b64836862ef",
            "taskId": 597,
            "subTaskId": 794
        }
    ],
    "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例全局root关闭（同步）

接口说明

地址 请求方式 版本
http://{ip}/api/v2/instance/root/global/close/sync POST 2.0.4a

请求参数

请求参数 类型 必填 参数说明 示例
instanceId String 是 实例唯一标识

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Object 响应数据

返回示例

code码说明

code msg desc
0 success

详细说明

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例全局root关闭（异步）

接口说明

地址 请求方式 版本
http://{ip}/api/v2/instance/root/global/close/async POST 2.0.4a

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 是 实例ID列表，最多1000个
isCallback Boolean 否 是否回调，默认：true
callbackUrl String 否 回调地址

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
resourceId String 实例ID
taskId Integer 主任务ID
subTaskId Integer 子任务ID

返回示例

{
    "status": 0,
    "data": [
        {
            "resourceId": "RK333333333333332_61ae5f48-b3f6-4c50-a9d6-a501d85ad277",
            "taskId": 597,
            "subTaskId": 793
        },
        {
            "resourceId": "RK333333333333332_d9bdf286-8bf2-49fe-b27e-9b64836862ef",
            "taskId": 597,
            "subTaskId": 794
        }
    ],
    "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例应用root开启（同步）

接口说明

地址 请求方式 版本
http://{ip}/api/v2/instance/root/app/open/sync POST 2.0.4a

请求参数

请求参数 类型 必填 参数说明 示例
instanceId String 是 实例唯一标识
appPackageList ArrayList<String> 是 应用包名列表

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Object 响应数据

返回示例

{
    "status": 0,
    "data": [
        {
          "packageName":"xxxxxx",
          "executionResult":"success",
          "failReason":"xxxxxxx"
        },{
          "packageName":"xxxxxx",
          "executionResult":"fail",
          "failReason":"xxxxxxx"
        }]
    "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

code码说明

code msg desc
0 success

详细说明

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例应用root开启（异步）

当存在部分root开启失败时，异步任务状态为失败

接口说明

地址 请求方式 版本
http://{ip}/api/v2/instance/root/app/open/async POST 2.0.4a

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 是 实例ID列表，最多1000个
appPackageList ArrayList<String> 是 应用包名列表
isCallback Boolean 否 是否回调，默认：true
callbackUrl String 否 回调地址

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
resourceId String 实例ID
taskId Integer 主任务ID
subTaskId Integer 子任务ID，执行结构保留在 /v1/subtask/list 接口的orderDesc字段

orderDesc 字段返回示例

[{
        "packageName":"xxxxxx",
        "executionResult":"success",
        "failReason":"xxxxxxx"
    },{
        "packageName":"xxxxxx",
        "executionResult":"fail",
        "failReason":"xxxxxxx"
}]
1
2
3
4
5
6
7
8
9

返回示例

{
    "status": 0,
    "data": [
        {
            "resourceId": "RK333333333333332_61ae5f48-b3f6-4c50-a9d6-a501d85ad277",
            "taskId": 597,
            "subTaskId": 793
        },
        {
            "resourceId": "RK333333333333332_d9bdf286-8bf2-49fe-b27e-9b64836862ef",
            "taskId": 597,
            "subTaskId": 794
        }
    ],
    "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例应用root关闭（同步）

接口说明

地址 请求方式 版本
http://{ip}/api/v2/instance/root/app/close/sync POST 2.0.4a

请求参数

请求参数 类型 必填 参数说明 示例
instanceId String 是 实例唯一标识
appPackageList ArrayList<String> 是 应用包名列表

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Object 响应数据

返回示例

code码说明

code msg desc
0 success

详细说明

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例应用root关闭（异步）

当存在部分root开启失败时，异步任务状态为失败

接口说明

地址 请求方式 版本
http://{ip}/api/v2/instance/root/app/close/async POST 2.0.4a

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 是 实例ID列表，最多1000个
appPackageList ArrayList<String> 是 应用包名列表
isCallback Boolean 否 是否回调，默认：true
callbackUrl String 否 回调地址

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
resourceId String 实例ID
taskId Integer 主任务ID
subTaskId Integer 子任务ID, 执行结构保留在 /v1/subtask/list 接口的orderDesc字段

orderDesc 字段返回示例

[{
        "packageName":"xxxxxx",
        "executionResult":"success",
        "failReason":"xxxxxxx"
    },{
        "packageName":"xxxxxx",
        "executionResult":"fail",
        "failReason":"xxxxxxx"
}]
1
2
3
4
5
6
7
8
9

返回示例

{
    "status": 0,
    "data": [
        {
            "resourceId": "RK333333333333332_61ae5f48-b3f6-4c50-a9d6-a501d85ad277",
            "taskId": 597,
            "subTaskId": 793
        },
        {
            "resourceId": "RK333333333333332_d9bdf286-8bf2-49fe-b27e-9b64836862ef",
            "taskId": 597,
            "subTaskId": 794
        }
    ],
    "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例应用前台保活开启（同步）

接口说明

地址 请求方式 版本
http://{ip}/api/v2/instance/app/front/open/sync POST 2.0.4a

请求参数

请求参数 类型 必填 参数说明 示例
instanceId String 是 实例唯一标识
appPackage String 是 应用包名

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Object 响应数据

返回示例

code码说明

code msg desc
0 success

详细说明

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例应用前台保活开启（异步）

接口说明

地址 请求方式 版本
http://{ip}/api/v2/instance/app/front/open/async POST 2.0.4a

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 是 实例ID列表，最多1000个
appPackage String 是 应用包名
isCallback Boolean 否 是否回调，默认：true
callbackUrl String 否 回调地址

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
resourceId String 实例ID
taskId Integer 主任务ID
subTaskId Integer 子任务ID

返回示例

{
    "status": 0,
    "data": [
        {
            "resourceId": "RK333333333333332_61ae5f48-b3f6-4c50-a9d6-a501d85ad277",
            "taskId": 597,
            "subTaskId": 793
        },
        {
            "resourceId": "RK333333333333332_d9bdf286-8bf2-49fe-b27e-9b64836862ef",
            "taskId": 597,
            "subTaskId": 794
        }
    ],
    "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例应用前台保活关闭（同步）

接口说明

地址 请求方式 版本
http://{ip}/api/v2/instance/app/front/close/sync POST 2.0.4a

请求参数

请求参数 类型 必填 参数说明 示例
instanceId String 是 实例唯一标识
appPackage String 是 应用包名

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Object 响应数据

返回示例

code码说明

code msg desc
0 success

详细说明

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例应用前台保活关闭（异步）

接口说明

地址 请求方式 版本
http://{ip}/api/v2/instance/app/front/close/async POST 2.0.4a

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 是 实例ID列表，最多1000个
appPackage String 是 应用包名
isCallback Boolean 否 是否回调，默认：true
callbackUrl String 否 回调地址

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
resourceId String 实例ID
taskId Integer 主任务ID
subTaskId Integer 子任务ID

返回示例

{
    "status": 0,
    "data": [
        {
            "resourceId": "RK333333333333332_61ae5f48-b3f6-4c50-a9d6-a501d85ad277",
            "taskId": 597,
            "subTaskId": 793
        },
        {
            "resourceId": "RK333333333333332_d9bdf286-8bf2-49fe-b27e-9b64836862ef",
            "taskId": 597,
            "subTaskId": 794
        }
    ],
    "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例应用后台保活开启（同步）

接口说明

地址 请求方式 版本
http://{ip}/api/v2/instance/app/back/open/sync POST 2.0.4a

请求参数

请求参数 类型 必填 参数说明 示例
instanceId String 是 实例唯一标识
appPackageList ArrayList<String> 是 应用包名列表

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Object 响应数据

返回示例

code码说明

code msg desc
0 success

详细说明

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例应用后台保活开启（异步）

当存在部分root开启失败时，异步任务状态为失败

接口说明

地址 请求方式 版本
http://{ip}/api/v2/instance/app/back/open/async POST 2.0.4a

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 是 实例ID列表，最多1000个
appPackageList List<String> 是 应用包名列表
isCallback Boolean 否 是否回调，默认：true
callbackUrl String 否 回调地址

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
resourceId String 实例ID
taskId Integer 主任务ID
subTaskId Integer 子任务ID

返回示例

{
    "status": 0,
    "data": [
        {
            "resourceId": "RK333333333333332_61ae5f48-b3f6-4c50-a9d6-a501d85ad277",
            "taskId": 597,
            "subTaskId": 793
        },
        {
            "resourceId": "RK333333333333332_d9bdf286-8bf2-49fe-b27e-9b64836862ef",
            "taskId": 597,
            "subTaskId": 794
        }
    ],
    "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例应用后台保活关闭（同步）

接口说明

地址 请求方式 版本
http://{ip}/api/v2/instance/app/back/close/sync POST 2.0.4a

请求参数

请求参数 类型 必填 参数说明 示例
instanceId String 是 实例唯一标识
appPackageList List<String> 是 应用包名列表

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Object 响应数据

返回示例

code码说明

code msg desc
0 success

详细说明

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例应用后台保活关闭（异步）

接口说明

地址 请求方式 版本
http://{ip}/api/v2/instance/app/back/close/async POST 2.0.4a

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 是 实例ID列表，最多1000个
appPackageList List<String> 是 应用包名列表
isCallback Boolean 否 是否回调，默认：true
callbackUrl String 否 回调地址

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
resourceId String 实例ID
taskId Integer 主任务ID
subTaskId Integer 子任务ID

返回示例

{
    "status": 0,
    "data": [
        {
            "resourceId": "RK333333333333332_61ae5f48-b3f6-4c50-a9d6-a501d85ad277",
            "taskId": 531,
            "subTaskId": 702
        },
        {
            "resourceId": "RK333333333333332_d9bdf286-8bf2-49fe-b27e-9b64836862ef",
            "taskId": 531,
            "subTaskId": 703
        }
    ],
    "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例屏幕截图V2（异步）

接口说明

地址 请求方式 版本
http://{ip}/api/v2/instance/screen/capture/async POST 2.0.4a

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds List<String> 是 实例ID
localStorage Boolean 否 是否保存到本地，默认false
isCallback Boolean 否 是否回调，默认：true
callbackUrl String 否 回调地址

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
resourceId String 实例ID
taskId Integer 主任务ID
subTaskId Integer 子任务ID，如果截图成功，截图会保留在 /v1/subtask/list 接口的orderDesc字段

返回示例

{
    "status": 0,
    "data": [
        {
            "resourceId": "RK333333333333332_61ae5f48-b3f6-4c50-a9d6-a501d85ad277",
            "taskId": 531,
            "subTaskId": 702
        },
        {
            "resourceId": "RK333333333333332_d9bdf286-8bf2-49fe-b27e-9b64836862ef",
            "taskId": 531,
            "subTaskId": 703
        }
    ],
    "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例屏幕截图V2（批量同步）

  1. 持续自动截图模式下，若实例发生破坏行为（如：恢复出厂、重启等），则截图任务终止

接口说明

地址 请求方式 版本
http://{ip}/api/v2/instance/screen/capture/sync/batch POST 2.0.4b

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds List<String> 是 实例ID，最大数量200
quality Integer 否 画质，范围：1-100，默认：25 25
type String 否 截图类型（ONCE-单次截图，AUTO-自动截图），默认值：ONCE ONCE
interval Integer 否 自动截图模式，截图间隔，最小值：200，最大值：300000（5分钟），默认值：5000，单位：毫秒 5000
expire Long 否 自动截图模式，持续时长，最小值：3600000（1小时），最大值：7*24*3600000（7天），默认值：2*24*3600000（2天），单位：毫秒 172800000
orientation Integer 否 横屏竖屏类型（0-竖屏，1-横屏，2-系统默认）默认：2 2

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
resourceId String 实例ID
success Boolean 截图任务是否成功执行
url String 截图任务成功时返回截图地址(http)，否则为空
sslUrl String 截图任务成功时返回截图地址(https)，否则为空
reason String 截图任务失败时返回原因，否则为空

返回示例

 {
    "status": 0,
    "data": [
        {
            "resourceId": "RK333333333333332_61ae5f48-b3f6-4c50-a9d6-a501d85ad277",
            "success": true,
            "url": "http://test-pass-szsy.phone.androidscloud.com:44914/screenshot/omfIwf1l0SudvQhFQGXJJUpBm8NcEDAqgeapR-IFF5PMsilIGOEi6Ukep6XifjOjMy1ftdAVowbkwumGwKwZ"
            "sslUrl":"https://test-pass-szsy.phone.androidscloud.com:44914/screenshot/omfIwf1l0SudvQhFQGXJJUpBm8NcEDAqgeapR-IFF5PMsilIGOEi6Ukep6XifjOjMy1ftdAVowbkwumGwKwZ"
            "reason":""
        },
        {
            "resourceId": "RK333333333333332_d9bdf286-8bf2-49fe-b27e-9b64836862ef",
            "success": false,
            "reason": "timeout",
            "url":"",
            "sslUrl":""
        }
    ],
    "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例文件上传到相册

接口说明

上传到 /data/media/0/DCIM/ 目录，对应 /storage/emulated/0/DCIM/

地址 请求方式 版本
http://{ip}/api/v1/instance/file/uploadToPhoto POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 是 实例ID列表，最多1000个
fileId Integer 是 文件ID，通过文件上传后获取 参考：文件管理-新增文件
isCallback Boolean 否 是否回调，默认：true
callbackUrl String 否 回调地址

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
resourceId String 实例ID
isSuccess Boolean 单个实例的执行结果，true：成功；false：失败
reason String 失败原因
taskId Integer 主任务ID，成功时有内容
subTaskId Integer 子任务ID，成功时有内容

返回示例

{
    "status": 0,
    "data": [
        {
            "resourceId": "RK333333333333332_61ae5f48-b3f6-4c50-a9d6-a501d85ad277",
            "taskId": 534,
            "subTaskId": 708,
            "isSuccess": true,
            "reason": ""
        },
        {
            "resourceId": "RK333333333333332_d9bdf286-8bf2-49fe-b27e-9b64836862ef",
            "taskId": 534,
            "subTaskId": 709,
            "isSuccess": true,
            "reason": ""
        }
    ],
    "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例执行命令（异步）V2

  1. 每个实例命令执行指定时间内未完成，该实例按超时处理

接口说明

地址 请求方式 版本
http://{ip}/api/v2/instance/cmd/async/run POST 2.0.4d

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 是 实例ID列表，最多1000个
command String 是 执行命令，不支持无法自主结束的命令 例如：top、vim 执行结果最大1KB ls
timeout Integer 否 超时时间，单位：秒，范围：[1-60]，包含边界值 默认30秒
isCallback Boolean 否 是否回调，默认：true
callbackUrl String 否 回调地址

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
resourceId String 实例ID
taskId Integer 主任务ID
subTaskId Integer 子任务ID

返回示例

{
    "status": 0,
    "data": [
        {
            "resourceId": "RK333333333333332_61ae5f48-b3f6-4c50-a9d6-a501d85ad277",
            "taskId": 529,
            "subTaskId": 698
        },
        {
            "resourceId": "RK333333333333332_d9bdf286-8bf2-49fe-b27e-9b64836862ef",
            "taskId": 529,
            "subTaskId": 699
        }
    ],
    "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 推流属性设置（异步）

  1. 批量实例操作，设置分辨率，帧率，DPI

  2. **注意：**分辨率，帧率，DPI三个参数不可同时为空

接口说明

地址 请求方式 版本
http://{ip}/api/v2/instance/stream/prop/set/async POST 2.0.4d

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 是 实例唯一标识列表，最多1000个
resolution String 否 分辨率，格式：width*height 720*1280
dpi Integer 否 Dots Per Inch，每英寸点数 240
fps Integer 否 帧率/刷新率 60
isCallback Boolean 否 是否回调，默认：true
callbackUrl String 否 回调地址

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
resourceId String 实例ID
taskId Integer 主任务ID
subTaskId Integer 子任务ID

返回示例

{
    "status": 0,
    "data": [
        {
            "resourceId": "RK333333333333332_61ae5f48-b3f6-4c50-a9d6-a501d85ad277",
            "taskId": 529,
            "subTaskId": 698
        },
        {
            "resourceId": "RK333333333333332_d9bdf286-8bf2-49fe-b27e-9b64836862ef",
            "taskId": 529,
            "subTaskId": 699
        }
    ],
    "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 系统属性设置（异步）

  1. 批量实例操作，设置系统属性（清单查看接口详细说明）

接口说明

地址 请求方式 版本
http://{ip}/api/v2/instance/system/prop/set/async POST 2.0.4d

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 是 实例唯一标识列表，最多1000个
properties Map<String,Object> 是 系统属性key和value，具体参考系统属性表
isCallback Boolean 否 是否回调，默认：true
callbackUrl String 否 回调地址

系统属性

属性用途 key value示例
手机型号 persist.product.v-model rk3588_qt
手机品牌 persist.product.v-brand rockchip
安卓版本 persist.build.v-display_id rk3588_qt-userdebug
imei编号 persist.sys.v-imei 123456789
imsi编号 persist.sys.v-imsi abcdefghijk
系统版本 persist.version.v-release 10

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
resourceId String 实例ID
taskId Integer 主任务ID
subTaskId Integer 子任务ID

返回示例

{
    "status": 0,
    "data": [
        {
            "resourceId": "RK333333333333332_61ae5f48-b3f6-4c50-a9d6-a501d85ad277",
            "taskId": 529,
            "subTaskId": 698
        },
        {
            "resourceId": "RK333333333333332_d9bdf286-8bf2-49fe-b27e-9b64836862ef",
            "taskId": 529,
            "subTaskId": 699
        }
    ],
    "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例换肤（异步）V2

接口说明

地址 请求方式 版本
http://{ip}/api/v2/instance/skin/refresh/async POST 2.0.4d

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 是 实例ID列表，最多1000个
brand String 是 品牌 HUAWEI
model String 是 型号 HUAWEI META 60
isCallback Boolean 否 是否回调，默认：true
callbackUrl String 否 回调地址

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
resourceId String 实例ID
taskId Integer 主任务ID
subTaskId Integer 子任务ID

返回示例

{
    "status": 0,
    "data": [
        {
            "resourceId": "RK333333333333332_61ae5f48-b3f6-4c50-a9d6-a501d85ad277",
            "taskId": 597,
            "subTaskId": 793
        },
        {
            "resourceId": "RK333333333333332_d9bdf286-8bf2-49fe-b27e-9b64836862ef",
            "taskId": 597,
            "subTaskId": 794
        }
    ],
    "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例ADB服务启动（同步）V2

接口说明

地址 请求方式 版本
http://{ip}/api/v2/instance/adbd/start/sync POST 2.0.1

请求参数

请求参数 类型 必填 参数说明 示例
instanceId String 是 实例唯一标识

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Object 响应数据

返回示例

code码说明

code msg desc
0 success

详细说明

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例ADB服务启动（异步）V2

接口说明

地址 请求方式 版本
http://{ip}/api/v2/instance/adbd/start/async POST 2.0.4d

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 是 实例ID列表，最多1000个
isCallback Boolean 否 是否回调，默认：true
callbackUrl String 否 回调地址

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
resourceId String 实例ID
taskId Integer 主任务ID
subTaskId Integer 子任务ID

返回示例

{
    "status": 0,
    "data": [
        {
            "resourceId": "RK333333333333332_61ae5f48-b3f6-4c50-a9d6-a501d85ad277",
            "taskId": 597,
            "subTaskId": 793
        },
        {
            "resourceId": "RK333333333333332_d9bdf286-8bf2-49fe-b27e-9b64836862ef",
            "taskId": 597,
            "subTaskId": 794
        }
    ],
    "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例ADB服务停止（同步）V2

接口说明

地址 请求方式 版本
http://{ip}/api/v2/instance/adbd/stop/sync POST 2.0.1

请求参数

请求参数 类型 必填 参数说明 示例
instanceId String 是 实例唯一标识

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Object 响应数据

返回示例

code码说明

code msg desc
0 success

详细说明

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例ADB服务停止（异步）V2

接口说明

地址 请求方式 版本
http://{ip}/api/v2/instance/adbd/stop/async POST 2.0.4d

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 是 实例ID列表，最多1000个
isCallback Boolean 否 是否回调，默认：true
callbackUrl String 否 回调地址

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
resourceId String 实例ID
taskId Integer 主任务ID
subTaskId Integer 子任务ID

返回示例

{
    "status": 0,
    "data": [
        {
            "resourceId": "RK333333333333332_61ae5f48-b3f6-4c50-a9d6-a501d85ad277",
            "taskId": 597,
            "subTaskId": 793
        },
        {
            "resourceId": "RK333333333333332_d9bdf286-8bf2-49fe-b27e-9b64836862ef",
            "taskId": 597,
            "subTaskId": 794
        }
    ],
    "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例SSH服务启动（同步）V2

接口说明

地址 请求方式 版本
http://{ip}/api/v2/instance/sshd/start/sync POST 2.0.1

请求参数

请求参数 类型 必填 参数说明 示例
instanceId String 是 实例唯一标识

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Object 响应数据

返回示例

code码说明

code msg desc
0 success

详细说明

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例SSH服务启动（异步）V2

接口说明

地址 请求方式 版本
http://{ip}/api/v2/instance/sshd/start/async POST 2.0.4d

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 是 实例ID列表，最多1000个
isCallback Boolean 否 是否回调，默认：true
callbackUrl String 否 回调地址

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
resourceId String 实例ID
taskId Integer 主任务ID
subTaskId Integer 子任务ID

返回示例

{
    "status": 0,
    "data": [
        {
            "resourceId": "RK333333333333332_61ae5f48-b3f6-4c50-a9d6-a501d85ad277",
            "taskId": 597,
            "subTaskId": 793
        },
        {
            "resourceId": "RK333333333333332_d9bdf286-8bf2-49fe-b27e-9b64836862ef",
            "taskId": 597,
            "subTaskId": 794
        }
    ],
    "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例SSH服务停止（同步）V2

接口说明

地址 请求方式 版本
http://{ip}/api/v2/instance/sshd/stop/sync POST 2.0.1

请求参数

请求参数 类型 必填 参数说明 示例
instanceId String 是 实例唯一标识

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Object 响应数据

返回示例

code码说明

code msg desc
0 success

详细说明

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例SSH服务停止（异步）V2

接口说明

地址 请求方式 版本
http://{ip}/api/v2/instance/sshd/stop/async POST 2.0.4d

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 是 实例ID列表，最多1000个
isCallback Boolean 否 是否回调，默认：true
callbackUrl String 否 回调地址

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
resourceId String 实例ID
taskId Integer 主任务ID
subTaskId Integer 子任务ID

返回示例

{
    "status": 0,
    "data": [
        {
            "resourceId": "RK333333333333332_61ae5f48-b3f6-4c50-a9d6-a501d85ad277",
            "taskId": 597,
            "subTaskId": 793
        },
        {
            "resourceId": "RK333333333333332_d9bdf286-8bf2-49fe-b27e-9b64836862ef",
            "taskId": 597,
            "subTaskId": 794
        }
    ],
    "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# ADB鉴权管理

# 实例开启ADB鉴权（同步）

接口说明

地址 请求方式 版本
http://{ip}/api/v2/instance/adb/auth/start/sync POST 2.0.1

请求参数

请求参数 类型 必填 参数说明 示例
instanceId String 是 实例唯一标识

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Object 响应数据

返回示例

code码说明

code msg desc
0 success

详细说明

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例开启ADB鉴权（异步）

接口说明

地址 请求方式 版本
http://{ip}/api/v2/instance/adb/auth/start/async POST 2.0.4d

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 是 实例ID列表，最多1000个
isCallback Boolean 否 是否回调，默认：true
callbackUrl String 否 回调地址

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
resourceId String 实例ID
taskId Integer 主任务ID
subTaskId Integer 子任务ID

返回示例

{
    "status": 0,
    "data": [
        {
            "resourceId": "RK333333333333332_61ae5f48-b3f6-4c50-a9d6-a501d85ad277",
            "taskId": 597,
            "subTaskId": 793
        },
        {
            "resourceId": "RK333333333333332_d9bdf286-8bf2-49fe-b27e-9b64836862ef",
            "taskId": 597,
            "subTaskId": 794
        }
    ],
    "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例关闭ADB鉴权（同步）

接口说明

地址 请求方式 版本
http://{ip}/api/v2/instance/adb/auth/stop/sync POST 2.0.1

请求参数

请求参数 类型 必填 参数说明 示例
instanceId String 是 实例唯一标识

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Object 响应数据

返回示例

code码说明

code msg desc
0 success

详细说明

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例关闭ADB鉴权（异步）

接口说明

地址 请求方式 版本
http://{ip}/api/v2/instance/adb/auth/stop/async POST 2.0.4d

请求参数

请求参数 类型 必填 参数说明 示例
instanceIds ArrayList<String> 是 实例ID列表，最多1000个
isCallback Boolean 否 是否回调，默认：true
callbackUrl String 否 回调地址

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据

响应数据

返回参数 参数类型 参数说明
resourceId String 实例ID
taskId Integer 主任务ID
subTaskId Integer 子任务ID

返回示例

{
    "status": 0,
    "data": [
        {
            "resourceId": "RK333333333333332_61ae5f48-b3f6-4c50-a9d6-a501d85ad277",
            "taskId": 597,
            "subTaskId": 793
        },
        {
            "resourceId": "RK333333333333332_d9bdf286-8bf2-49fe-b27e-9b64836862ef",
            "taskId": 597,
            "subTaskId": 794
        }
    ],
    "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 同屏推流

# 创建同屏推流会话

接口说明

地址 请求方式 版本
http://{ip}/api/v1/multiple/stream/session/create POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
masterInstanceId String 是 主屏实例ID
slaveInstanceIds ArrayList<String> 是 实例ID列表，最多1000个

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Object 响应数据

响应数据

返回参数 参数类型 参数说明
sessionId String 会话ID
status Integer 群控状态：0.失败 1.成功
masterInstanceId String 主屏实例ID
successInstanceIds ArrayList<String> 成功实例id
failInstanceIds ArrayList<String> 失败实例id

返回示例

{
    "status": 0,
    "message":"success",
    "data": {
        "sessionId": "xxxxx",
        "status": 1,
        "masterInstanceId": "xxxxx",
        "successInstanceIds": []
		"failInstanceIds": []
    }
}
1
2
3
4
5
6
7
8
9
10
11

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 同屏推流会话续期

接口说明

地址 请求方式 版本
http://{ip}/api/v1/multiple/stream/session/renewal POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
sessionId String 是 同屏推流会话ID
renewalTime Integer 是 续期时间（单位：小时）

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Object 响应数据

响应数据

返回参数 参数类型 参数说明

返回示例

{
    "status": 0,
    "message":"success",
    "data": {
    }
}
1
2
3
4
5
6

code码说明

code msg desc
0 success
11003 群控会话失效或会话id不正确

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 注销同屏推流会话

接口说明

地址 请求方式 版本
http://{ip}/api/v1/multiple/stream/session/cancel POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
sessionId String 是 同屏推流会话ID

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Object 响应数据

响应数据

返回参数 参数类型 参数说明

返回示例

{
    "status": 0,
    "message":"success",
    "data": {
    }
}
1
2
3
4
5
6

code码说明

code msg desc
0 success
11003 群控会话失效或会话id不正确

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 主屏控制权切换

接口说明

地址 请求方式 版本
http://{ip}/api/v1/multiple/stream/session/master/switch POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
sessionId String 是 同屏推流会话ID
masterInstanceId String 是 新主屏实例ID

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Object 响应数据

响应数据

返回参数 参数类型 参数说明

返回示例

{
    "status": 0,
	"message":"success",
    "data": {
    }
}
1
2
3
4
5
6

code码说明

code msg desc
0 success
11003 群控会话失效或会话id不正确

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 从控设备切换

接口说明

地址 请求方式 版本
http://{ip}/api/v1/multiple/stream/session/slave/switch POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
sessionId String 是 同屏推流会话ID
type Integer 是 类型：1.增加 2.删除
slaveInstanceIds ArrayList<String> 是 从控设备列表

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Object 响应数据

响应数据

返回参数 参数类型 参数说明
sessionId String 会话ID
successInstanceIds ArrayList<String> 成功实例id
failInstanceIds ArrayList<String> 失败实例id

返回示例

{
    "status": 0,
    "message":"success",
    "data": {
        "sessionId": "xxxxx",
        "successInstanceIds": []
		"failInstanceIds": []
    }
}
1
2
3
4
5
6
7
8
9

code码说明

code msg desc
0 success
11003 群控会话失效或会话id不正确

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 从控设备生效选定

接口说明

地址 请求方式 版本
http://{ip}/api/v1/multiple/stream/session/slave/available POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
sessionId String 是 同屏推流会话ID
slaveInstanceIds ArrayList<String> 是 从控设备列表

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Object 响应数据

响应数据

返回参数 参数类型 参数说明

返回示例

{
    "status": 0,
	"message":"success",
    "data": {
    }
}
1
2
3
4
5
6

code码说明

code msg desc
0 success
11003 群控会话失效或会话id不正确

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 从控设备生效选定详情

接口说明

地址 请求方式 版本
http://{ip}/api/v1/multiple/stream/session/slave/available/detail POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
sessionId String 是 同屏推流会话ID

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Object 响应数据

响应数据

返回参数 参数类型 参数说明
masterInstanceId String 主控实例id
onlineSlaveInstanceIds ArrayList<String> 在线同屏推流从控设备
availableInstanceIds ArrayList<String> 选中同屏推流从控设备

返回示例

{
    "status": 0,
	"message":"success",
    "data": {
        "masterInstanceId": "12345678",
        "onlineSlaveInstanceIds": ["aaaa","bbb"],
        "availableInstanceIds": ["aaa", "bbb"]
    }
}
1
2
3
4
5
6
7
8
9

code码说明

code msg desc
0 success
11003 群控会话失效或会话id不正确

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 查看同屏推流会话详情

接口说明

地址 请求方式 版本
http://{ip}/api/v1/multiple/stream/session/get POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
sessionId String 是 同屏推流会话ID

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Object 响应数据

响应数据

返回参数 参数类型 参数说明
sessionId Integer 同屏推流会话ID
masterInstanceId String 主屏实例ID
successInstanceIds ArrayList<String> 所有成功同屏操作实例id
failInstanceIds ArrayList<String> 所有失败同屏操作实例id
status Integer 群控状态: 0.群控中 1.注销
createTime Datetime 创建时间

返回示例

{
    "status": 0,
	"message":"success",
    "data": {
        "sessionId": "carozhu",
        "masterInstanceId": "aaaa",
        "successInstanceIds": [],
        "failInstanceIds": [],
		"status": 0,
        "createTime": "2024-09-03 18:14:00"
    }
}
1
2
3
4
5
6
7
8
9
10
11
12

code码说明

code msg desc
0 success
11003 群控会话失效或会话id不正确

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 查看同屏推流会话列表

接口说明

地址 请求方式 版本
http://{ip}/api/v1/multiple/stream/session/list POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
sessionId String 否 同屏推流会话ID
status Integer 否 群控状态: 0.群控中 1.注销
page Integer 否 默认值1，表示查询第一页
pageSize Integer 否 默认值10，表示一页10条数据，最大值100，最小1

返回参数

返回参数 参数类型 参数说明
page Integer 页数
pageSize Integer 分页大小
total Integer 总大小
records ArrayList<Object> 分页数据

响应数据

返回参数 参数类型 参数说明
sessionId Integer 同屏推流会话ID
masterInstanceId String 主屏实例ID
successInstanceIds ArrayList<String> 所有成功同屏操作实例id
failInstanceIds ArrayList<String> 所有失败同屏操作实例id
status Integer 群控状态: 0.群控中 1.注销
createTime Datetime 创建时间

返回示例

{
    "status": 0,
	"message":"success",
    "data": {
		"page": 1,
		"pageSize": 10,
		"total": 20,
		"records":[
				{
				"sessionId": "carozhu",
				"masterInstanceId": "aaaa",
				"successInstanceIds": ["aaaa","bbb"],
                "failInstanceIds": [],
				"status": 0,
				"createTime": "2024-09-03 18:14:00"
			}
		]
	}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例镜像管理

# 新增实例镜像

接口说明

地址 请求方式 版本
http://{ip}/api/v1/instance/image/add POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
url String 是 镜像下载地址，无鉴权可直接下载的地址
md5 String 是 镜像md5
androidVersion String 是 安卓系统版本： Android10、Android12、 Andorid13
imageVersion String 是 系统版本，例: version:tag
cardType String 是 适应板卡类型 QS865、 RK3588_256_A、 RK3588_256_B、 RK3588_128_A、 QS8550
vendor String 是 供应商编码
remark String 否 镜像说明

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Object 响应数据

响应数据

返回参数 参数类型 参数说明
imageId Integer 镜像ID
imageStatus Integer 镜像状态:  1.上传中 2.成功 3.失败
imageMessage String 镜像状态说明

返回示例

{
    "status": 0,
	"message":"success",
    "data": {
        "imageId": 1,
        "imageStatus": 2,
        "imageMessage": "成功"
    }
}
1
2
3
4
5
6
7
8
9

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 删除实例镜像

接口说明

地址 请求方式 版本
http://{ip}/api/v1/instance/image/delete POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
imageId Integer 是 镜像ID

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Object 响应数据

响应数据

返回参数 参数类型 参数说明

返回示例

{
    "status": 0,
	"message":"success",
    "data": {
    }
}
1
2
3
4
5
6

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 实例镜像列表

接口说明

地址 请求方式 版本
http://{ip}/api/v1/instance/image/list POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
imageId Integer 否 镜像ID
cardType String 否 适应板卡类型 QS865、 RK3588_256_A、 RK3588_256_B、 RK3588_128_A、 QS8550
vendor String 否 供应商编码
remark String 否 镜像说明
page Integer 否 默认值1，表示查询第一页
pageSize Integer 否 默认值10，表示一页10条数据，最大值100，最小1

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Page 响应数据

响应数据

返回参数 参数类型 参数说明
page Integer 页数
pageSize Integer 分页大小
total Integer 总大小
records ArrayList<Object> 分页数据
返回参数 参数类型 参数说明
imageId Integer 镜像ID
imageStatus Integer 镜像状态:  1.上传中 2.成功 3.失败
imageMessage String 镜像状态说明
url String 原下载地址
md5 String md5
cardType String 板卡类型
vendor String 供应商编码
androidVersion String 安卓系统版本： Android10、 Android12、 Andorid13
imageVersion String 镜像版本
createTime Datetime 创建时间

返回示例

{
    "status": 0,
    "message":"success",
    "data": {
        "page": 1,
		"pageSize": 10,
		"total": 20,
		"records":[{
          "imageId":1234,
          "imageStatus":0,
          "imageMessage":"success",
          "md5": "6ed86ad3f14db4db716c808cfc1ca392",
          "url": "http://versions.update.com/xxx.apk",
          "cardType": "QS865",
    	  "vendor": "RC",
          "androidVersion": "Android10",
  		  "imageVersion": "rk3588-build-ro.test.build:v1",
          "createTime": "2024-09-03 18:14:00"
        }]
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 流量带宽

# 查询实例流量

接口说明

地址 请求方式 版本
http://{ip}/api/v1/instance/bandwidth POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
instanceId String 是 实例id
startTime Datetime 是 流量记录开始时间
endTime Datetime 是 流量记录截止时间startTime与endTime的差值需要小于30天
page Integer 否 默认值1，表示查询第一页
pageSize Integer 否 默认值10，表示一页10条数据，最大值100，最小1

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Object 响应数据

响应数据

返回参数 参数类型 参数说明
page Integer 页数
pageSize Integer 分页大小
total Integer 总大小
records ArrayList<Object> 分页数据

带宽统计数据

返回参数 参数类型 参数说明
id Int64 id
instanceId String 实例全局唯一 ID 列表
extranetUpstream Integer 实例外网上行使用带宽值：KB
extranetDownstream Integer 实例外网下行使用带宽值：KB
recordTime Datetime 时间

返回示例

{
    "status": 0,
    "message":"success",
    "data": {
		"page": 1,
		"pageSize": 10,
		"total": 20,
		"records":[
				{
              "id": "123456789",
			  "instanceId": "RK3588xx_1",
			  "extranetUpstream": 100,
			  "extranetDownstream": 200,
			  "recordTime": "2024-12-2 12:12:12"
			}
		]
	}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 任务管理

# 任务列表

接口说明

地址 请求方式 版本
http://{ip}/api/v1/task/list GET 1.0

请求参数

请求参数 类型 必填 参数说明 示例
taskId Integer 否 任务ID
taskType Integer 否 任务类型
taskStatus Integer 否 任务状态: 0.执行中 1.已完成
beginTime Datetime 否 默认当前时间减去2天，创建时间大于beginTime
endTime Datetime 否 默认当前时间，创建时间小于endTime，endTime和beginTime的差值小于5天
page Integer 否 默认值1，表示查询第一页
pageSize Integer 否 默认值10，表示一页10条数据，最大值100，最小1

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Page 响应数据，data默认createTime降序排序

响应数据

返回参数 参数类型 参数说明
page Integer 页数
pageSize Integer 分页大小
total Integer 总大小
records ArrayList<Object> 分页数据
返回参数 参数类型 参数说明
taskId Integer 任务ID
taskType Integer 任务类型：TODO
taskStatus Integer 任务状态：0.执行中 1.已完成
subTaskCount Integer 子任务数量
subTaskSuccessCount Integer 执行成功子任务数量
subTaskFailCount Integer 执行失败子任务数量
createTime Datetime 任务创建时间
startTime Datetime 开始执行时间
endTime Datetime 结束执行时间

返回示例

{
    "status": 0,
    "message":"success",
    "data":  {
		"page": 1,
		"pageSize": 10,
		"total": 20,
		"records":[
			{
				"taskId": 123,
				"taskType": 4,
				"taskStatus": 1,
				"subTaskCount": 100,
				"subTaskSuccessCount": 1,
				"subTaskFailCount": 99,
				"createTime":"2024-08-30 17:00:00",
				"startTime":"2024-08-30 17:00:00",
				"endTime":"2024-08-30 17:00:00"
			},
			{
				"taskId": 123,
				"taskType": 4,
				"taskStatus": 1,
				"subTaskCount": 100,
				"subTaskSuccessCount": 1,
				"subTaskFailCount": 99,
				"createTime":"2024-08-30 17:00:00",
				"startTime":"2024-08-30 17:00:00",
				"endTime":"2024-08-30 17:00:00"
			}
		]
	}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

code码说明

code msg desc
0 success

taskType 类型说明

taskType 类型说明
4 ### 实例应用安装
5 应用卸载
6 应用启动
7 应用停止
8 应用启用
9 应用停用
201 实例重启
202 实例开机
203 实例关机
204 实例命令执行
205 实例镜像更新
207 实例限速设置
208 实例系统属性设置
209 实例换机
210 实例恢复出厂
217 实例备份
218 实例还原
229 实例屏幕截图
230 实例文件上传

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 任务列表批量

接口说明

地址 请求方式 版本
http://{ip}/api/v1/task/batch/list POST 1.0

请求参数

请求参数 类型 必填 参数说明 示例
taskIds ArrayList<Intege> 是 任务ID，最大1000

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data ArrayList<Object> 响应数据，data默认createTime降序排序

响应数据

返回参数 参数类型 参数说明
taskId Integer 任务ID
taskType Integer 任务类型：TODO
taskStatus Integer 任务状态：0.执行中 1.已完成
subTaskCount Integer 子任务数量
subTaskSuccessCount Integer 执行成功子任务数量
subTaskFailCount Integer 执行失败子任务数量
createTime Datetime 任务创建时间
startTime Datetime 开始执行时间
endTime Datetime 结束执行时间

返回示例

{
    "status": 0,
    "message":"success",
    "data":  [{
				"taskId": 123,
				"taskType": 4,
				"taskStatus": 1,
				"subTaskCount": 100,
				"subTaskSuccessCount": 1,
				"subTaskFailCount": 99,
				"createTime":"2024-08-30 17:00:00",
				"startTime":"2024-08-30 17:00:00",
				"endTime":"2024-08-30 17:00:00"
			},
			{
				"taskId": 123,
				"taskType": 4,
				"taskStatus": 1,
				"subTaskCount": 100,
				"subTaskSuccessCount": 1,
				"subTaskFailCount": 99,
				"createTime":"2024-08-30 17:00:00",
				"startTime":"2024-08-30 17:00:00",
				"endTime":"2024-08-30 17:00:00"
			}
		]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 子任务列表

接口说明

地址 请求方式 版本
http://{ip}/api/v1/subtask/list GET 1.0

请求参数

请求参数 类型 必填 参数说明 示例
taskId Integer 否 主任务ID
subTaskId Integer 否 子任务ID
subTaskStatus Integer 否 任务状态: 0.失败 1.已完成  2.执行中 3.未执行
deviceId String 否 设备ID，例如：instanceID
page Integer 否 默认值1，表示查询第一页
pageSize Integer 否 默认值10，表示一页10条数据，最大值100，最小1

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Page 响应数据

响应数据

返回参数 参数类型 参数说明
page Integer 页数
pageSize Integer 分页大小
total Integer 总大小
records ArrayList<Object> 分页数据
返回参数 参数类型 参数说明
taskId Integer 任务ID
subTaskId Integer 子任务ID
subTaskStatus Integer 任务状态: 0.失败 1.已完成  2.执行中 3.未执行
deviceId String 设备ID
extraInfo String 额外信息
orderDesc String 描述
createTime Datetime 任务创建时间
startTime Datetime 开始执行时间
endTime Datetime 结束执行时间

返回示例

{
    "status": 0,
    "message":"success",
    "total":100,
    "data":{
		"page": 1,
		"pageSize": 10,
		"total": 20,
		"records":[
			{
			"taskId": 123,
			"subTaskId": 123,
			"subTaskStatus": 1,
			"deviceId": "xxxxxx",
			"extraInfo": "success",
            "orderDesc":"xxxxxx",
			"createTime":"2024-08-30 17:00:00",
			"startTime":"2024-08-30 17:00:00",
			"endTime":"2024-08-30 17:00:00"
			},
			{
			"taskId": 123,
			"subTaskId": 123,
			"subTaskStatus": 1,
			"deviceId": "xxxxxx",
			"extraInfo": "success",
            "orderDesc":"xxxxxx",
			"createTime":"2024-08-30 17:00:00",
			"startTime":"2024-08-30 17:00:00",
			"endTime":"2024-08-30 17:00:00"
			}
		]
	}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 设置全局回调地址

注意事项

  1. 回调地址需要填写租户自己系统的真实地址。

  2. 回调地址必须是以https://或http://开头的完整全路径地址，并且确保URL中的域名和IP是外网可以访问的，无任何非法字符（如空格、HTML 标签）且不能重定向。

  3. 回调地址的代码处理逻辑不能做登录态校验。

接口说明

地址 请求方式 版本
http://{ip}/api/v2/tenant/callback/set POST 2.0.4d

请求参数

请求参数 类型 必填 参数说明 示例
callbackUrl String 是 回调地址

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明
data Object 响应数据

返回示例

{
    "status": 0,
	"message":"success",
    "data": nul
}
1
2
3
4
5

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1

# 任务回调

注意事项

  1. 回调地址需要填写租户自己系统的真实地址。

  2. 回调地址必须是以https://或http://开头的完整全路径地址，并且确保URL中的域名和IP是外网可以访问的，无任何非法字符（如空格、HTML 标签）且不能重定向。

  3. 回调地址的代码处理逻辑不能做登录态校验。

  4. PaaS平台是用 POST 方式发送回调通知，返回结果：status 为 0 表示成功，其他表示失败。

  5. 租户后台系统收到回调结果通知，需要在5秒内返回应答报文，否则PaaS平台认为通知失败，后续会重复发送通知。只有无响应时才重试，收到失败结果响应后不再重试。

  6. 同样的通知可能会多次发送，租户后台系统必须能够正确处理重复的通知。如果已处理过，直接给PaaS平台返回成功。同一条回调通知重试时，参数中的 subTaskId 是不变的。

  7. 在进行回调通知交互时，如果PaaS平台认为通知失败，会通过一定的策略定期重新发起通知。重试逻辑为：立即尝试重发 3 次通知，若 3 次仍不成功，则后续通知的间隔频率为：4m、10m、10m、1h、2h、6h、15h，总计重试10次。

  8. 验签：sign生成规则与openapi一致，sign随http请求头下发。

接口说明

地址 请求方式 版本 说明
{callbackUrl} POST 2.0.4b 租户提供的回调地址，调用相应异步任务接口时设置

请求参数

请求参数 类型 必填 参数说明 示例
taskId Integer 是 任务ID
subTaskId Integer 是 子任务ID
subTaskStatus Integer 是 任务状态: 0.失败 1.已完成  2.执行中 3.未执行
deviceId String 是 设备ID
extraInfo String 否 额外信息
orderDesc String 否 描述
createTime Datetime 是 任务创建时间
startTime Datetime 是 开始执行时间
endTime Datetime 是 结束执行时间
callbackType Integer 是 子任务类型，参考子任务说明

子任务说明

子任务编码 对应接口
4 实例应用安装
5 实例应用控制，操作类型：卸载
6 实例应用控制，操作类型：启动
7 实例应用控制，操作类型：停止
8 实例应用控制，操作类型：启用
9 实例应用控制，操作类型：禁用
101 宿主机重启
106 实例应用控制，操作类型：清理
201 实例重启
202 实例开机
203 实例关机
204 实例执行命令（异步） 实例换肤 实例执行命令（异步）V2
205 实例镜像更新
209 实例换机（数据迁移）
210 实例恢复出厂
218 实例还原
230 实例文件上传
231 实例备份
251 推流属性设置（异步）
252 系统属性设置（异步）
253 实例换肤（异步）V2
254 实例ADB服务启动（异步）V2
255 实例ADB服务停止（异步）V2
256 实例SSH服务启动（异步）V2
257 实例SSH服务停止（异步）V2
260 实例开启ADB鉴权（异步）
261 实例关闭ADB鉴权（异步）
264 实例应用前台保活开启（异步）
265 实例应用前台保活关闭（异步）
266 实例应用后台保活开启（异步）
267 实例应用后台保活关闭（异步）
268 实例应用清单（异步）V2
269 实例屏幕截图V2（异步）
270 实例全局root开启（异步）
271 实例全局root关闭（异步）
272 实例应用root开启（异步）
273 实例应用root关闭（异步）
274 实例文件上传到相册

返回参数

返回参数 参数类型 参数说明
status Integer 0：成功，其他表示失败
message String 响应说明

返回示例

{
    "status": 0,
    "message":"success"
}
1
2
3
4

code码说明

code msg desc
0 success

详细说明

如有特别说明请描述
1

备注

关于其它错误返回值与错误代码，参见 [Code码说明](#Link)
1
最近更新
01
H5接入文档
04-24
02
PC接入文档
04-24
03
Android接入文档
04-24
更多文章>
Theme by Vdoing | Copyright © 2024-2025 Theme by PaaS