7.Пара ключей

1. Импорт пары ключей

Адрес интерфейса: /v1/keystore/loadAdbKey

Метод запроса:POST

Тип данных запроса:application/json

Тип данных ответа:*/*,application/json

Поддерживаемая версия:v1.4.0

Описание интерфейса:

Выполнить импорт пары ключей

Параметры запроса:

Имя параметра	Описание параметра	Местоположение	Обязательно ли	Тип данных	Описание
projectId	Id проекта	body	false	string	По умолчанию проект по умолчанию текущего пользователя
name	Имя пары ключей	body	true	string
type	Тип	body	true	string	Фиксированно заполняется [ 2 ]
publicKey	Публичный ключ	body	true	string
remark	Примечание	body	false	string

Пример запроса, в фактическом запросе замените значения параметров:

POST "/openapi/v1/keystore/loadAdbKey"
body:
{
    "name": "btnt1",
    "projectId": "project_admin",
    "publicKey": "QAAAAJMd+fRldygaF366zSFm26/pqYq9biFDO85oQtRBIlCHtXPxlVMVL0gAYP9JcZFqmDpdfBHi19zAl29l2+CW5Smy9py7YT3y09x/3aTaliXd4GK9LtR0UQdDtH3nR/e0dYLG3PtUP1T+t0w3t8Mcyad+Q7VvJmtDAcggKp9e0wcXSJSqUFXAP5J4TtnOtaud4RHcqKeGZ8t1f36qhlSG8NPUDr9vjrQhKoS8d803KfvF/WEzCf+5VspPtB7U0JuBsFzBtPiSrDAAkDedX//6pFehVbya58lmwkv6quXwZ9TdGzKXAkzx+KjxD421ZOoRvH6J4pDX1GLfbhJogh6j95O5h7/cZGLsOTfNQjn929660+Wtjn/v0WjjrPmM6/1WqEtpL8H4n9WmFHbtJPQBV8SSj420fEa5UlojEGWg3bWccI6wRjyyT1GFQe3R6gT6t9vdRL3EvPKFl4YgE9N9wKAsVqWzFEN6tO1YfRQSGnEf+6PQeYFB3iRNllbq8ZU3d+n5GX1LOQWqlxuG+bGbrqL4y6JPbcRdGJYQtjZuqWDdrMgrExt5Glo+v8XvSod7vaIdia79G5LL8T/u5Wi+uKHb35seJssYv4Imjw6jxiFnsqhEiQDRCHs9A2OhQMg1xT0agP4l95LoFCrLL53wr9OV4MGsbu+TcgPyC/zxFyVbRZ22ugEAAQA= root@docker-swarm-3",
    "type": 2
}

Параметры ответа:

Имя параметра	Описание параметра	Тип	Описание
code	Код возврата	integer(int32)
message	Возвращаемое сообщение обработки	string
result	Возвращаемый объект данных	object
jobId	ID задачи	string
uuid	uuid контейнера	string
status	Код статуса задачи	integer	0:ошибка 2:успешно
beginTime	Время начала	string
endTime	Время окончания	string
timestamp	Временная метка	integer(int64)
traceId	ID обработки запроса	string

Пример ответа:

{
    "message": "操作成功！",
    "code": 200,
    "result": {
        "uuid": "47b78ac884fb44ec8ac5843d54060be0",
        "jobId": "4730ee885e6845ec8a4f026fe90e7920",
        "status": 2,
        "beginTime": "2024-01-17 16:14:21",
        "endTime": "2024-01-17 16:14:22"
    },
    "timestamp": 1705479262853,
    "traceId": "C20240117161421507001"
}

2. Привязать пару ключей к контейнеру

Адрес интерфейса: /v1/keystore/bindInstancesAdbKey

Метод запроса:POST

Тип данных запроса:application/json

Тип данных ответа:*/*,application/json

Поддерживаемая версия:v1.4.0

callbackUrl предоставляется версией v1.7.4

Описание интерфейса:

Выполнить привязку пары ключей к контейнеру

Параметры запроса:

Имя параметра	Описание параметра	Местоположение	Обязательно ли	Тип данных	Описание
secretKeyId	id пары ключей	body	true	string	uuid, возвращенный интерфейсом создания ключа
instanceUuids	Список uuid контейнеров	body	true	list	Одна или несколько записей данных
callbackUrl	Адрес callback уведомления	body	false	string	POST-запрос

Пример запроса, в фактическом запросе замените значения параметров:

POST "/openapi/v1/keystore/bindInstancesAdbKey"
body:
{
    "instanceIds": [
        "i-236a0f378e9f109584d13c3591c42dff",
        "i-39757fe1833c29fd0ef8263b8d2f46d3"
    ],
    "secretKeyId": "9b6a005ee876312e0bdf2b7a3de2c4e6"
}

Параметры ответа:

Имя параметра	Описание параметра	Тип	Описание
code	Код возврата	integer(int32)
message	Возвращаемое сообщение обработки	string
result	Возвращаемый объект данных	object
jobId	ID задачи	string
code	Код статуса отправки задачи	integer	При успешной отправке задачи значение равно 200, остальные значения означают ошибку отправки задачи
message	Описание задачи	string
uuid	uuid контейнера	string
traceId	ID обработки запроса	string
timestamp	Временная метка	integer(int64)

Пример ответа:

{
    "message": "操作成功！",
    "code": 200,
    "result": [
        {
            "uuid": "i-236a0f378e9f109584d13c3591c42dff",
            "jobId": "ff3144359ef54e4eb18f295b3f45f9e2",
            "code": 200,
            "message": "SUCCESS"
        },
        {
            "uuid": "i-39757fe1833c29fd0ef8263b8d2f46d3",
            "jobId": "c152d74720c64228b8b14e52e754fe1d",
            "code": 200,
            "message": "SUCCESS"
        }
    ],
    "timestamp": 1705482616364,
    "traceId": "C20240117171016046003"
}

3. Отвязка пары ключей от контейнера

Адрес интерфейса: /v1/keystore/unbindInstancesAdbKey

Метод запроса:POST

Тип данных запроса:application/json

Тип данных ответа:*/*,application/json

Поддерживаемая версия:v1.4.0

callbackUrl предоставляется версией v1.7.4

Описание интерфейса:

Выполнить отвязку пары ключей от контейнера

Параметры запроса:

Имя параметра	Описание параметра	Местоположение	Обязательно ли	Тип данных	Описание
secretKeyId	id пары ключей	body	true	string	uuid, возвращенный интерфейсом создания ключа
instanceUuids	Список uuid контейнеров	body	true	list	Одна или несколько записей данных
callbackUrl	Адрес callback уведомления	body	false	string	POST-запрос

Пример запроса, в фактическом запросе замените значения параметров:

POST "/openapi/v1/keystore/unbindInstancesAdbKey"
body:
{
    "instanceIds": [
        "i-236a0f378e9f109584d13c3591c42dff",
        "i-39757fe1833c29fd0ef8263b8d2f46d3"
    ],
    "secretKeyId": "9b6a005ee876312e0bdf2b7a3de2c4e6"
}

Параметры ответа:

Имя параметра	Описание параметра	Тип	Описание
code	Код возврата	integer(int32)
message	Возвращаемое сообщение обработки	string
result	Возвращаемый объект данных	object
jobId	ID задачи	string
code	Код статуса отправки задачи	integer	При успешной отправке задачи значение равно 200, остальные значения означают ошибку отправки задачи
message	Описание задачи	string
uuid	uuid контейнера	string
traceId	ID обработки запроса	string
timestamp	Временная метка	integer(int64)

Пример ответа:

{
    "message": "操作成功！",
    "code": 200,
    "result": [
        {
            "uuid": "i-236a0f378e9f109584d13c3591c42dff",
            "jobId": "ff3144359ef54e4eb18f295b3f45f9e2",
            "code": 200,
            "message": "SUCCESS"
        },
        {
            "uuid": "i-39757fe1833c29fd0ef8263b8d2f46d3",
            "jobId": "c152d74720c64228b8b14e52e754fe1d",
            "code": 200,
            "message": "SUCCESS"
        }
    ],
    "timestamp": 1705482616364,
    "traceId": "C20240117171016046003"
}

4. Список пар ключей

Адрес интерфейса: /v1/keystore/listAdbKey

Метод запроса:POST

Тип данных запроса:application/json

Тип данных ответа:*/*,application/json

Поддерживаемая версия:v1.4.0

Описание интерфейса:

Постраничное получение пар ключей ADB в системе

Параметры запроса:

Имя параметра	Описание параметра	Местоположение	Обязательно ли	Тип данных	Описание
projectId	Id проекта	body	false	string	По умолчанию проект по умолчанию текущего пользователя
pageNum	Номер текущей страницы		false	integer	По умолчанию 1
pageSize	Количество данных на текущей странице		false	integer	По умолчанию 10

Пример запроса, в фактическом запросе замените значения параметров:

POST "/openapi/v1/keystore/listAdbKey"
body:
{
    "pageNum": 1,
    "pageSize": 10,
    "projectId": "project_admin"
}

Параметры ответа:

Имя параметра	Описание параметра	Тип	Описание
code	Код возврата	integer(int32)
message	Возвращаемое сообщение обработки	string
result	Возвращаемый объект данных	object
records	Список данных текущей страницы	list<object>
id	id пары ключей	string
name	Имя пары ключей	string
digest	Сводка	string	Удалить двоеточие
digestColon	Сводка	string
publicKey	Публичный ключ	string
remark	Примечание	string
createTime	Время создания	string
bindInstanceNum	Количество привязанных контейнеров	integer
createUserId	id пользователя	long
username	Имя пользователя	string
total	Общее количество записей	integer
current	Номер текущей страницы	integer
pages	Общее количество страниц	integer
size	Количество строк на странице	integer
timestamp	Временная метка	integer(int64)
traceId	ID обработки запроса	string

Пример ответа:

{
    "message": "操作成功！",
    "code": 200,
    "result": {
        "records": [
            {
                "id": "47b78ac884fb44ec8ac5843d54060be0",
                "name": "btnt1",
                "digest": "12E1B68B6E10A550358B4538B232D1F2",
                "digestColon": "12:E1:B6:8B:6E:10:A5:50:35:8B:45:38:B2:32:D1:F2",
                "publicKey": "QAAAAJMd+fRldygaF366zSFm26/pqYq9biFDO85oQtRBIlCHtXPxlVMVL0gAYP9JcZFqmDpdfBHi19zAl29l2+CW5Smy9py7YT3y09x/3aTaliXd4GK9LtR0UQdDtH3nR/e0dYLG3PtUP1T+t0w3t8Mcyad+Q7VvJmtDAcggKp9e0wcXSJSqUFXAP5J4TtnOtaud4RHcqKeGZ8t1f36qhlSG8NPUDr9vjrQhKoS8d803KfvF/WEzCf+5VspPtB7U0JuBsFzBtPiSrDAAkDedX//6pFehVbya58lmwkv6quXwZ9TdGzKXAkzx+KjxD421ZOoRvH6J4pDX1GLfbhJogh6j95O5h7/cZGLsOTfNQjn929660+Wtjn/v0WjjrPmM6/1WqEtpL8H4n9WmFHbtJPQBV8SSj420fEa5UlojEGWg3bWccI6wRjyyT1GFQe3R6gT6t9vdRL3EvPKFl4YgE9N9wKAsVqWzFEN6tO1YfRQSGnEf+6PQeYFB3iRNllbq8ZU3d+n5GX1LOQWqlxuG+bGbrqL4y6JPbcRdGJYQtjZuqWDdrMgrExt5Glo+v8XvSod7vaIdia79G5LL8T/u5Wi+uKHb35seJssYv4Imjw6jxiFnsqhEiQDRCHs9A2OhQMg1xT0agP4l95LoFCrLL53wr9OV4MGsbu+TcgPyC/zxFyVbRZ22ugEAAQA= root@docker-swarm-3",
                "remark": null,
                "createTime": "2024-01-17 16:14:22",
                "createUserId": 7,
                "bindInstanceNum": 0,
                "username": "zlf"
            }
        ],
        "total": 1,
        "current": 1,
        "size": 10,
        "pages": 1
    },
    "timestamp": 1705482652441,
    "traceId": "C20240117171052441005"
}