searchInstallationRecipes

Получение списка планов развертывания OC, с возможностью фильтрации и постраничного вывода.

POST /v1/installation_recipes/search

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

Имя Описание Обязательный Тип Пример

page

Общее количество страниц

Нет

integer

2

pageSize

Количество элементов, возвращаемых в запросе

Нет

integer

20

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

См. InstallationRecipeSearchRequest.

Пример запроса

{
  "name": "installationRecipeNameExample",
  "installationProfileIds": [
    "018fc943-f767-76aa-a340-2e7015bd90e3"
  ],
  "provisioningMethodIds": [
    "bootdisknetinst"
  ],
  "deploymentModeIds": [
    "installation"
  ],
  "configurationIds": [
    101
  ]
}

Тип контента

application/json

Ответы

Код Сообщение Тип данных / объект схемы (DTO) Пример

200

Список планов развертывания

InstallationRecipePagedResponse

 
{
  "installationRecipes": [
    {
      "installationRecipeId": "a550fe40-1102-4e4d-9fd2-b587131246f5",
      "name": "Installation recipe name",
      "description": "Installation recipe description",
      "installationProfile": {
        "installationProfileId": "a480re55-9988-7a7d-9fd2-b587139946f5",
        "name": "Installation profile"
      },
      "provisioningMethod": {
        "provisioningMethodId": "bootdisknetinst",
        "name": "Boot disk and network"
      },
      "configurationId": 101,
      "configurationVersionId": 102,
      "deploymentMode": {
        "deploymentModeId": "installation",
        "name": "Installation"
      },
      "rootHashPassword": "8743b52063cd84097a65d1633f5c74f5",
      "hashAlgorithm": "MD5",
      "isCreateUser": false,
      "userAccount": {
        "userFullName": "Ivanov Ivan Ivanovich",
        "userName": "Ivan",
        "userHashPassword": "5f4dcc3b5aa765d61d8327deb882cf99"
      },
      "domainName": "inno.local",
      "createdAt": "2024-03-18T14:53:08.865312Z",
      "createdBy": "some_user@some_domain",
      "updatedAt": "2024-03-18T14:53:08.865312Z",
      "updatedBy": "some_user@some_domain"
    }
  ],
  "meta": {}
}

400

Incorrect request params (некорректные параметры запроса)

BasicError

 
{
  "code": "validation_failed",
  "message": "createInstallationRecipeId.displayName: size must be between 3 and 256"
}

401

Ошибка аутентификации

404

Объект не найден

BasicError

 
{
  "code": "object_not_found",
  "message": "string"
}

500

Внутренняя ошибка

BasicError

 
{
  "code": "internal_error",
  "message": "string"
}