13.Управление приложениями
1. Установить apk
Адрес интерфейса:/v2/command/instance
Метод запроса:POST
Тип данных запроса:application/json
Тип данных ответа:*/*,application/json
Поддерживаемая версия:v1.1.1
callbackUrl предоставляется версией v1.7.4
Описание интерфейса:
Пакетная операция с контейнерами: установить APK в контейнер
Параметры запроса:
| Имя параметра | Описание параметра | Местоположение | Обязательно ли | Тип данных | Описание |
|---|---|---|---|---|---|
| instanceUuids | один или несколько uuid контейнеров | body | true | List<string> | |
| command | Команда операции установки apk | body | true | string | Здесь фиксированно указывается [ install ] |
| content | Объект содержимого операции | body | true | object | |
| path | Исходный путь apk на контейнере (используется в приоритете) | body | false | string | [ path ] и [ url ] обязателен один из двух |
| url | http-адрес apk | body | false | string | |
| removeApk | Удалять ли исходный файл apk после установки APK. | body | false | boolean | true удалить ,false не удалять,по умолчанию false |
| callbackUrl | Адрес callback уведомления | body | false | string | POST-запрос |
Пример запроса:
POST "/openapi/v2/command/instance"
body:
{
"command": "install",
"content": {
"url": "http://www.test.com/xapkazqxz.apk",
"removeApk": false
},
"instanceUuids": [
"0248c04cfb5a4442a636c903fa003dc8",
"0c70e660f6ee4590ad4b65112f4d7af0"
]
}
Параметры ответа:
| Имя параметра | Описание параметра | Тип | Описание |
|---|---|---|---|
| code | Код возврата | integer(int32) | integer(int32) |
| message | Возвращаемое сообщение обработки | string | |
| result | Возвращаемый объект данных | list<object> | Конкретный объект данных для обработки запроса |
| jobId | ID задачи | string | |
| code | Код статуса отправки задачи | integer | При успешной отправке задачи значение равно 200, остальные значения означают ошибку отправки задачи |
| message | Описание отправки задачи | string | |
| uuid | uuid контейнера | string | |
| command | Команда | string | |
| nodeUuid | UUID узла | string | |
| timestamp | Временная метка | integer(int64) | integer(int64) |
| traceId | ID обработки запроса | string | ID запроса, этот traceId можно использовать для пакетного запроса результатов задач в рамках данного запроса |
Пример ответа:
{
"message": "操作成功",
"code": 200,
"result": [
{
"jobId": "99df88be558e4fee9a029181ed7d770d",
"code": 200,
"message": "success",
"uuid": "0248c04cfb5a4442a636c903fa003dc8",
"command": "install",
"nodeUuid": "7a3eacab1939fefec0c1998e37d87ae2"
},
{
"jobId": "2fdb77cd25054c1491e9792729bbc023",
"code": 200,
"message": "success",
"uuid": "0c70e660f6ee4590ad4b65112f4d7af0",
"command": "install",
"nodeUuid": "7a3eacab1939fefec0c1998e37d87ae2"
}
],
"timestamp": 1691370882363,
"traceId": "E75720230807091442338"
}
2. Удалить apk
Адрес интерфейса:/v2/command/instance
Метод запроса:POST
Тип данных запроса:application/json
Тип данных ответа:*/*,application/json
Поддерживаемая версия:v1.1.1
callbackUrl предоставляется версией v1.7.4
Описание интерфейса:
Пакетная операция с контейнерами: удалить установленный APK из контейнера
Параметры запроса:
| Имя параметра | Описание параметра | Местоположение | Обязательно ли | Тип данных | Описание |
|---|---|---|---|---|---|
| instanceUuids | один или несколько uuid контейнеров | body | true | list<string> | |
| command | Команда операции установки apk | body | true | string | Здесь фиксированно указывается [ uninstall ] |
| content | Объект содержимого операции | body | true | object | |
| packageName | Имя пакета целевого apk для удаления | body | true | string | |
| callbackUrl | Адрес callback уведомления | body | false | string | POST-запрос |
Пример запроса:
POST "/openapi/v2/command/instance"
body:
{
"command":"uninstall",
"content":{
"packageName":"com.ioncannon.cpuburn.gpugflops"
},
"instanceUuids": [
"0248c04cfb5a4442a636c903fa003dc8","0c70e660f6ee4590ad4b65112f4d7af0"
]
}
Параметры ответа:
| Имя параметра | Описание параметра | Тип | Описание |
|---|---|---|---|
| code | Код возврата | integer(int32) | |
| message | Возвращаемое сообщение обработки | string | |
| result | Возвращаемый объект данных | List | Конкретный объект данных для обработки запроса |
| jobId | ID задачи | string | |
| code | Код статуса отправки задачи | integer | При успешной отправке задачи значение равно 200, остальные значения означают ошибку отправки задачи |
| message | Описание отправки задачи | string | |
| uuid | uuid контейнера | string | |
| command | Команда | string | |
| nodeUuid | UUID узла | string | |
| timestamp | Временная метка | integer(int64) | |
| traceId | ID обработки запроса | string | ID запроса, этот traceId можно использовать для пакетного запроса результатов задач в рамках данного запроса |
Пример ответа:
{
"message": "操作成功",
"code": 200,
"result": [
{
"jobId": "2bb246e78fba43ad8d07fd55aef55ecf",
"code": 200,
"message": "success",
"uuid": "0248c04cfb5a4442a636c903fa003dc8",
"command": "uninstall",
"nodeUuid": "7a3eacab1939fefec0c1998e37d87ae2"
},
{
"jobId": "b88f839b104446a0a87ab4d3fc61338f",
"code": 200,
"message": "success",
"uuid": "0c70e660f6ee4590ad4b65112f4d7af0",
"command": "uninstall",
"nodeUuid": "7a3eacab1939fefec0c1998e37d87ae2"
}
],
"timestamp": 1691370955888,
"traceId": "E75820230807091555866"
}
3. Запустить APP
Адрес интерфейса:/v2/command/instance
Метод запроса:POST
Тип данных запроса:application/json
Тип данных ответа:*/*,application/json
Поддерживаемая версия:v1.6.0
Описание интерфейса:
Запустить определенный APP в контейнере
Параметры запроса:
| Имя параметра | Описание параметра | Местоположение | Обязательно ли | Тип данных | Описание |
|---|---|---|---|---|---|
| instanceUuids | uuid контейнера | body | true | List<string> | |
| command | Команда операции | body | true | string | Фиксированно заполняется [ app-start ] |
| content | Конкретная команда выполнения | body | true | object | |
| packageName | Имя пакета app, который нужно запустить | body | true | string | |
| callbackUrl | Адрес callback уведомления | body | false | string | POST-запрос |
Пример запроса:
POST "/openapi/v2/command/instance"
body:
{
"command": "app-start",
"content": {
"packageName": "com.tencent.mobileqq"
},
"instanceUuids": [
"i-67faf939d0cddd911be4de422f09e392"
]
}
Параметры ответа:
| Имя параметра | Описание параметра | Тип | Описание |
|---|---|---|---|
| code | Код возврата | integer(int32) | |
| message | Возвращаемое сообщение обработки | string | |
| result | Возвращаемый объект данных | List | Конкретный объект данных для обработки запроса |
| jobId | ID задачи | string | |
| code | Код статуса отправки задачи | integer | При успешной отправке задачи значение равно 200, остальные значения означают ошибку отправки задачи |
| message | Описание отправки задачи | string | |
| uuid | uuid контейнера | string | |
| command | Команда | string | |
| nodeUuid | UUID узла | string | |
| timestamp | Временная метка | integer(int64) | |
| traceId | ID обработки запроса | string | ID запроса, этот traceId можно использовать для пакетного запроса результатов задач в рамках данного запроса |
Пример ответа:
{
"message": "操作成功",
"code": 200,
"result": [
{
"jobId": "ec1c2ac1d5e544428c66a0f4f0d9f603",
"code": 200,
"message": "success",
"uuid": "165b41ce26fd406cab7cac868262df44",
"command": "app-start",
"nodeUuid": "7a3eacab1939fefec0c1998e37d87ae2"
},
{
"jobId": "43c7740d8f484b36b08623adac3f6f1d",
"code": 200,
"message": "success",
"uuid": "20271b8ef9674bd2ab59cededc9d3e49",
"command": "app-start",
"nodeUuid": "7a3eacab1939fefec0c1998e37d87ae2"
}
],
"timestamp": 1691371028402,
"traceId": "E75920230807091708379"
}
4. Остановить APP
Адрес интерфейса:/v2/command/instance
Метод запроса:POST
Тип данных запроса:application/json
Тип данных ответа:*/*,application/json
Поддерживаемая версия:v1.6.0
Описание интерфейса:
Остановить определенное APP в контейнере
Параметры запроса:
| Имя параметра | Описание параметра | Местоположение | Обязательно ли | Тип данных | Описание |
|---|---|---|---|---|---|
| instanceUuids | uuid контейнера | body | true | List<string> | |
| command | Команда операции | body | true | string | Фиксированно заполняется [ app-stop] |
| content | Конкретная команда выполнения | body | true | object | |
| packageName | Имя пакета app, который нужно запустить | body | true | string | |
| callbackUrl | Адрес callback уведомления | body | false | string | POST-запрос |
Пример запроса:
POST "/openapi/v2/command/instance"
body:
{
"command": "app-stop",
"content": {
"packageName": "com.tencent.mobileqq"
},
"instanceUuids": [
"i-67faf939d0cddd911be4de422f09e392"
]
}
Параметры ответа:
| Имя параметра | Описание параметра | Тип | Описание |
|---|---|---|---|
| code | Код возврата | integer(int32) | |
| message | Возвращаемое сообщение обработки | string | |
| result | Возвращаемый объект данных | List | Конкретный объект данных для обработки запроса |
| jobId | ID задачи | string | |
| code | Код статуса отправки задачи | integer | При успешной отправке задачи значение равно 200, остальные значения означают ошибку отправки задачи |
| message | Описание отправки задачи | string | |
| uuid | uuid контейнера | string | |
| command | Команда | string | |
| nodeUuid | UUID узла | string | |
| timestamp | Временная метка | integer(int64) | |
| traceId | ID обработки запроса | string | ID запроса, этот traceId можно использовать для пакетного запроса результатов задач в рамках данного запроса |
Пример ответа:
{
"message": "操作成功",
"code": 200,
"result": [
{
"jobId": "ec1c2ac1d5e544428c66a0f4f0d9f603",
"code": 200,
"message": "success",
"uuid": "165b41ce26fd406cab7cac868262df44",
"command": "app-stop",
"nodeUuid": "7a3eacab1939fefec0c1998e37d87ae2"
},
{
"jobId": "43c7740d8f484b36b08623adac3f6f1d",
"code": 200,
"message": "success",
"uuid": "20271b8ef9674bd2ab59cededc9d3e49",
"command": "app-stop",
"nodeUuid": "7a3eacab1939fefec0c1998e37d87ae2"
}
],
"timestamp": 1691371028402,
"traceId": "E75920230807091708379"
}
5. Установить App в Enable
Адрес интерфейса:/v2/command/instance
Метод запроса:POST
Тип данных запроса:application/json
Тип данных ответа:*/*,application/json
Поддерживаемая версия:v1.6.0
Описание интерфейса:
Остановить определенное APP в контейнере
Параметры запроса:
| Имя параметра | Описание параметра | Местоположение | Обязательно ли | Тип данных | Описание |
|---|---|---|---|---|---|
| instanceUuids | uuid контейнера | body | true | List<string> | |
| command | Команда операции | body | true | string | Фиксированно заполняется [ app-enable] |
| content | Конкретная команда выполнения | body | true | object | |
| packageName | Имя пакета app, который нужно отображать | body | true | string | |
| callbackUrl | Адрес callback уведомления | body | false | string | POST-запрос |
Пример запроса:
POST "/openapi/v2/command/instance"
body:
{
"command": "app-enable",
"content": {
"packageName": "com.tencent.mobileqq"
},
"instanceUuids": [
"i-67faf939d0cddd911be4de422f09e392"
]
}
Параметры ответа:
| Имя параметра | Описание параметра | Тип | Описание |
|---|---|---|---|
| code | Код возврата | integer(int32) | |
| message | Возвращаемое сообщение обработки | string | |
| result | Возвращаемый объект данных | List | Конкретный объект данных для обработки запроса |
| jobId | ID задачи | string | |
| code | Код статуса отправки задачи | integer | При успешной отправке задачи значение равно 200, остальные значения означают ошибку отправки задачи |
| message | Описание отправки задачи | string | |
| uuid | uuid контейнера | string | |
| command | Команда | string | |
| nodeUuid | UUID узла | string | |
| timestamp | Временная метка | integer(int64) | |
| traceId | ID обработки запроса | string | ID запроса, этот traceId можно использовать для пакетного запроса результатов задач в рамках данного запроса |
Пример ответа:
{
"message": "操作成功",
"code": 200,
"result": [
{
"jobId": "ec1c2ac1d5e544428c66a0f4f0d9f603",
"code": 200,
"message": "success",
"uuid": "165b41ce26fd406cab7cac868262df44",
"command": "app-enable",
"nodeUuid": "7a3eacab1939fefec0c1998e37d87ae2"
},
{
"jobId": "43c7740d8f484b36b08623adac3f6f1d",
"code": 200,
"message": "success",
"uuid": "20271b8ef9674bd2ab59cededc9d3e49",
"command": "app-enable",
"nodeUuid": "7a3eacab1939fefec0c1998e37d87ae2"
}
],
"timestamp": 1691371028402,
"traceId": "E75920230807091708379"
}
6. Установить APP в Disable
Адрес интерфейса:/v2/command/instance
Метод запроса:POST
Тип данных запроса:application/json
Тип данных ответа:*/*,application/json
Поддерживаемая версия:v1.6.0
Описание интерфейса:
Остановить определенное APP в контейнере
Параметры запроса:
| Имя параметра | Описание параметра | Местоположение | Обязательно ли | Тип данных | Описание |
|---|---|---|---|---|---|
| instanceUuids | uuid контейнера | body | true | List<string> | |
| command | Команда операции | body | true | string | Фиксированно заполняется [ app-disable] |
| content | Конкретная команда выполнения | body | true | object | |
| packageName | Имя пакета app, который нужно скрыть | body | true | string | |
| callbackUrl | Адрес callback уведомления | body | false | string | POST-запрос |
Пример запроса:
POST "/openapi/v2/command/instance"
body:
{
"command": "app-disable",
"content": {
"packageName": "com.tencent.mobileqq"
},
"instanceUuids": [
"i-67faf939d0cddd911be4de422f09e392"
]
}
Параметры ответа:
| Имя параметра | Описание параметра | Тип | Описание |
|---|---|---|---|
| code | Код возврата | integer(int32) | |
| message | Возвращаемое сообщение обработки | string | |
| result | Возвращаемый объект данных | List | Конкретный объект данных для обработки запроса |
| jobId | ID задачи | string | |
| code | Код статуса отправки задачи | integer | При успешной отправке задачи значение равно 200, остальные значения означают ошибку отправки задачи |
| message | Описание отправки задачи | string | |
| uuid | uuid контейнера | string | |
| command | Команда | string | |
| nodeUuid | UUID узла | string | |
| timestamp | Временная метка | integer(int64) | |
| traceId | ID обработки запроса | string | ID запроса, этот traceId можно использовать для пакетного запроса результатов задач в рамках данного запроса |
Пример ответа:
{
"message": "操作成功",
"code": 200,
"result": [
{
"jobId": "ec1c2ac1d5e544428c66a0f4f0d9f603",
"code": 200,
"message": "success",
"uuid": "165b41ce26fd406cab7cac868262df44",
"command": "app-disable",
"nodeUuid": "7a3eacab1939fefec0c1998e37d87ae2"
},
{
"jobId": "43c7740d8f484b36b08623adac3f6f1d",
"code": 200,
"message": "success",
"uuid": "20271b8ef9674bd2ab59cededc9d3e49",
"command": "app-disable",
"nodeUuid": "7a3eacab1939fefec0c1998e37d87ae2"
}
],
"timestamp": 1691371028402,
"traceId": "E75920230807091708379"
}