CICD

Методы для конвейеров

Метод для получения информации о задачах

GET /project/{userAlias}/{projectAlias}/cicd/pipeline/{localId}/jobs

Запрос возвращает список задач

Переменная пути запроса Тип Описание
userAlias String Псевдоним пользователя
projectAlias String Псевдоним проекта
localId String Номер конвейера

Responses

STATUS 200 пример JSON:

Пример ответа 
    
{
    "_embedded": {
        "restPipelineJobModelList": [
            {
                "id": "018g00i9-1940-4t54-148f-249l22i2c5b8",
                "localId": 1,
                "finishedAt": "2023-01-01T00:00:00.00000Z",
                "startedAt": null,
                "name": "job 1",
                "stageName": "stage",
                "tag": false,
                "ref": "master",
                "erasedAt": null,
                "artifactsExpireAt": null,
                "status": "SUCCESS",
                "pipelineLocalId": 1
            }
        ]
    },
    "page": {
        "size": 10,
        "totalElements": 1,
        "totalPages": 1,
        "number": 0
    }
}


STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Метод для получения информации об артефактах

GET /project/{userAlias}/{projectAlias}/cicd/pipeline/{localId}/artifacts

Запрос возвращает список артефактов конвейера

Переменная пути запроса Тип Описание
userAlias String Псевдоним пользователя
projectAlias String Псевдоним проекта
localId String Номер конвейера

Responses

STATUS 200 пример JSON:

Пример ответа 
    
{
    "_embedded": {
        "restPipelineJobArtifactModelList": [
            {
                "id": "g4i6tfl6-i0c1-4g83-8567-i4t0707fl194",
                "fileType": "metadata",
                "size": 125667,
                "expireAt": "2023-06-13T15:40:26.145095Z",
                "fileName": "d00c197c-092a-43fe-81dc-a902b51f230f.log",
                "downloadUrl": "api.gitflic.ru/project/username/projectname/cicd/job/1/artifact/g4i6tfl6-i0c1-4g83-8567-i4t0707fl194/download",
                "jobLocalId": 1
            }
        ]
    },
    "page": {
        "size": 1,
        "totalElements": 1,
        "totalPages": 1,
        "number": 0
    }
}


STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Метод для скачивания артефактов

GET /project/{userAlias}/{projectAlias}/cicd/pipeline/{localId}/artifacts-download

Запрос скачивания артефактов конвейера

Переменная пути запроса Тип Описание
userAlias String Псевдоним пользователя
projectAlias String Псевдоним проекта
localId String Номер конвейера

Responses

STATUS 200 - Начинается процесс скачивания файла

STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Метод для запуска конвейера

POST /project/{userAlias}/{projectAlias}/cicd/pipeline/start

Запрос запускает новый конвейер

Переменная пути запроса Тип Описание
userAlias String Псевдоним пользователя
projectAlias String Псевдоним проекта

Responses

STATUS 200 - Начало выполнения нового конвейера

STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Метод для перезапуска конвейера

POST /project/{userAlias}/{projectAlias}/cicd/pipeline/{localId}/restart

Запрос перезапускает конвейер

Переменная пути запроса Тип Описание
userAlias String Псевдоним пользователя
projectAlias String Псевдоним проекта
localId String Номер конвейера

Responses

STATUS 200 - Перезапуск конвейера

STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Метод для отмены выполнения конвейера

POST /project/{userAlias}/{projectAlias}/cicd/pipeline/{localId}/cancel

Запрос отменяет выполнение конвейера

Переменная пути запроса Тип Описание
userAlias String Псевдоним пользователя
projectAlias String Псевдоним проекта
localId String Номер конвейера

Responses

STATUS 200 - Прекращение выполнения конвейера

STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Метод удаления конвейера

DELETE /project/{userAlias}/{projectAlias}/cicd/pipeline/{localId}/delete

Запрос удаляет конвейер

Переменная пути запроса Тип Описание
userAlias String Псевдоним пользователя
projectAlias String Псевдоним проекта
localId String Номер конвейера

Responses

STATUS 200 - Удаление конвейера

STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Методы для задач

Метод получения информации о задаче по id

GET /project/{userAlias}/{projectAlias}/cicd/job/{localId}

Запрос возвращает информацию о задаче

Переменная пути запроса Тип Описание
userAlias String Псевдоним пользователя
projectAlias String Псевдоним проекта
localId String Номер задачи

Responses

STATUS 200 пример JSON:

Пример ответа 
    
{
    "id": "g00i197t-092f-43li-81cg-4902i51t230f",
    "localId": 1,
    "finishedAt": "2023-01-01T00:00:00.00000Z",
    "startedAt": null,
    "name": "job 1",
    "stageName": "stage",
    "tag": false,
    "ref": "master",
    "erasedAt": null,
    "artifactsExpireAt": null,
    "status": "FAILED",
    "pipelineLocalId": 1
}


STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Метод получения информации об артефактах задачи

GET /project/{userAlias}/{projectAlias}/cicd/job/{localId}/artifacts

Запрос возвращает информацию об артефактах задачи

Переменная пути запроса Тип Описание
userAlias String Псевдоним пользователя
projectAlias String Псевдоним проекта
localId String Номер задачи

Responses

STATUS 200 пример JSON:

Пример ответа 
    
{
    "_embedded": {
        "restPipelineJobArtifactModelList": [
            {
                "id": "g4i6tfl6-i0c1-4g83-8567-i4t0707fl194",
                "fileType": "metadata",
                "size": 125667,
                "expireAt": "2023-01-01T00:00:0.00000Z",
                "fileName": "g4i6tfl6-i0c1-4g83-8567-i4t0707fl194.log",
                "downloadUrl": "api.gitflic.ru/project/username/projectname/cicd/job/1/artifact/g4i6tfl6-i0c1-4g83-8567-i4t0707fl194/download",
                "jobLocalId": 1
            }
        ]
    },
    "page": {
        "size": 1,
        "totalElements": 1,
        "totalPages": 1,
        "number": 0
    }
}


STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Метод скачивания артефактов задачи

GET /project/{userAlias}/{projectAlias}/cicd/job/{localId}/artifacts-download

Запрос для скачивания артефактов задачи

Переменная пути запроса Тип Описание
userAlias String Псевдоним пользователя
projectAlias String Псевдоним проекта
localId String Номер задачи

Responses

STATUS 200 - Скачивание артефактов

STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Метод скачивания артефакта по uuid

GET /project/{userAlias}/{projectAlias}/cicd/job/{localId}/artifact/{artifactUuid}/download

Запрос для скачивания артефакта

Переменная пути запроса Тип Описание
userAlias String Псевдоним пользователя
projectAlias String Псевдоним проекта
localId String Номер задачи
artifactUuid String UUID артефакта

Responses

STATUS 200 - Скачивание артефактов

STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Метод перезапуска задачи

POST /project/{userAlias}/{projectAlias}/cicd/job/{localId}/restart

Запрос перезапускает задачу

Переменная пути запроса Тип Описание
userAlias String Псевдоним пользователя
projectAlias String Псевдоним проекта
localId String Номер задачи

Responses

STATUS 200 - Перезапуск задачи

STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Метод отмены выполнения задачи

POST /project/{userAlias}/{projectAlias}/cicd/job/{localId}/cancel

Запрос отменяет выполнение задачи

Переменная пути запроса Тип Описание
userAlias String Псевдоним пользователя
projectAlias String Псевдоним проекта
localId String Номер задачи

Responses

STATUS 200 - Отмена выполнения задачи

STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Метод удаления артефакта

DELETE /project/{userAlias}/{projectAlias}/cicd/job/{localId}/artifact/{artifactUuid}/delete

Запрос удаляет артефакт

Переменная пути запроса Тип Описание
userAlias String Псевдоним пользователя
projectAlias String Псевдоним проекта
localId String Номер задачи
artifactUuid String UUID артефакта

Responses

STATUS 200 - Удаление проекта

STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Навигация