Метод «Зарегистрировать экземпляр сервиса»

Endpoint: PUT {hostname}/dh-registry-service/api/v1/applications/{name}/register

Метод сохраняет информацию о зарегистрированных экземплярах приложения с фильтрацией.

Более подробное описание метода находится в yaml файле «registry-service», который расположен в папке с документацией.

Маппинг параметров запроса

Входящие параметры Способ передачи параметров Требования к заполнению
name Path Наименование приложения, полученное методом GET {hostname}/dh-registry-service/api/v1/applications
localizedName Body Значение согласно описанию в зависимости от потребностей клиента
description Body Значение согласно описанию в зависимости от потребностей клиента
version Body Значение согласно описанию в зависимости от потребностей клиента
starterEnvEnabled Body Признак поддержки сервисом механизма переноса конфигураций
route:
· uri
· predicates
· filters		 Body Значение согласно описанию в зависимости от потребностей клиента
host Body Имя хоста, на котором запущено приложение
startup Body Время запуска экземпляра приложения
build:
· buildName
· buildNumber
· version
· group
· artifact		 Body Значение согласно описанию в зависимости от потребностей клиента
endpoints:
· id
· method
· url
· body
· headers:
- name
- value		 Body Значение согласно описанию в зависимости от потребностей клиента
metadata:
· additionalProp1
· additionalProp2
· additionalProp3		 Body Значение согласно описанию в зависимости от потребностей клиента
isDynamicService Body Признак того, что приложение динамическое, то есть не имеет физического развертывания

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

curl --location --request PUT 'https://docshouse-dev.k8s.lan.lanit.ru/dh-gateway-api-service/dh-registry-service/api/v1/applications/testApp/register' \

--header 'Accept: application/json' \

--header 'Content-Type: application/json' \

--header 'Authorization: Bearer

--data '{

 "localizedName": "string",

 "description": "string",

 "version": "string",

 "starterEnvEnabled": true,

 "route": {

  "uri": "string",

  "predicates": [

   "string"

  ],

  "filters": [

   "string"

  ]

 },

 "host": "dh-documents-service-69c7cc7c7d-6f",

 "startup": "2023-10-26T06:17:58.123Z",

 "build": {

  "buildTime": "2023-10-26T06:17:58.123Z",

  "buildNumber": "44bcb21",

  "version": "1.0.0",

  "group": "ru.docshouse.documents",

  "artifact": "dh-documents-service"

 },

 "endpoints": [

  {

   "id": "collection",

   "method": "GET",

   "url": "/api/v1/documents/${objectId}",

   "body": "string",

   "headers": [

​    {

​     "name": "string",

​     "value": "string"

​    }

   ]

  }

 ],

 "metadata": {

  "additionalProp1": {},

  "additionalProp2": {},

  "additionalProp3": {}

 },

 "isDynamicService": false

}'