Ссылка на контекст координатора кластера

Следующие функции добавляются в контекст глобальной конфигурации Координатора кластера при проверке его свойства Enabled . Все функции также доступны в качестве действий в контекстном меню Координатора кластера.

Добавить организацию

Добавить организацию в кластер.

Имя функции

addTenant

Права доступа

Доступна на уровне прав администратора

Формат входных данных:

Название

Тип

Описание

tenantID

String

Уникальный идентификатор организации.

tenantDescription

String

Описание организации.

Выходные записи:

0

Формат выходных данных:

Нет

Удалить организацию

Удалить указанную организацию из кластера.

Имя функции

removeTenant

Права доступа

Доступна на уровне прав администратора

Формат входных данных:

Название

Тип

Описание

removeTenant

String

Уникальный идентификатор организации.

Выходные записи:

0

Формат выходных данных:

Нет

Добавить ресурс

Эта функция помогает горизонтальному кластеру "зарегистрировать" ресурс, который уже существует на первичном узле. Этот ресурс добавляется в реестр ресурсов кластера и далее управляется кластером.

Функция Добавить ресурс обычно используется внутри кластера, когда первичный узел сообщает о создании нового ресурса. Вручную ее вызывать не следует.

Имя функции

addResource

Права доступа

Доступна на уровне прав администратора

Формат входных данных:

Название

Тип

Описание

tenantID

String

Уникальный идентификатор организации, к которой будет добавлен ресурс.

orgUnitUID

String

Уникальный идентификатор подразделения организации, в которое будет добавлен ресурс.

userUID

String

Уникальный идентификатор пользователя.

resourcePath

String

Путь к контексту ресурса на основном узле.

uid

String

Уникальный идентификатор первичного узла для поиска ресурса.

Выходные записи:

0

Формат выходных данных:

Нет

Удалить ресурс

Текущая функция "не зарегистрирует" ресурс у координатора кластера.

Функция Удалить Ресурс обычно используется внутри кластера, когда первичный узел сообщает, что ресурс был удален. Вручную ее вызывать не следует.

Имя функции

removeResource

Права доступа

Доступна на уровне прав администратора

Формат входных данных:

Название

Тип

Описание

tenantID

String

Уникальный идентификатор организации.

resourcePath

String

Путь контекста к ресурсу.

uid

String

Уникальный идентификатор первичного узла.

Выходные записи:

0

Формат выходных данных:

Нет

Получить Ресурсы

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

Имя функции

getResources

Права доступа

Доступна на уровне прав администратора

Формат входных данных:

Название

Тип

Описание

tenantID

String

Уникальный идентификатор организации.

orgUnitUID

String

Уникальный идентификатор подразделения организации.

userUID

String

Уникальный идентификатор пользователя.

Выходные записи:

0...неограниченно

Формат выходных данных:

Название

Тип

Описание

primaryNodeServerID

String

Уникальный идентификатор сервера основного узла.

primaryNodeIpAddress

String

Адрес сервера первичного узла.

primaryNodePort

String

Порт сервера основного узла.

primaryNodeLogin

String

Логин пользователя основного узла.

primaryNodePassword

String

Пароль пользователя основного узла.

primaryNodeResources

Data Table

Таблица ресурсов первичного узла с колонками:

  • contextPath: Путь к ресурсу

  • permissionLevel: Уровень прав доступа, необходимый для доступа к ресурсу

Получить права доступа

Возврат списка разрешений, необходимых для доступа к ресурсам, которые принадлежат целевому арендатору, организации и пользователю.

Текущая функция используется внутренними серверами входа в систему. В большинстве случаев ее не следует вызывать вручную.

Имя функции

getPermissions

Права доступа

Доступна на уровне прав администратора

Формат входных данных:

Название

Тип

Описание

tenantID

String

Уникальный идентификатор организации.

orgUnitUID

String

Уникальный индентификатор подразделения организации.

пользователя.

Выходные записи:

0...Не ограничено

Формат выходных данных:

Имя

Тип

Описание

contextPath

String

Путь контекста ресурса.

permissionLevel

String

Уровень прав доступа, необходимый для доступа к ресурсу.

Выделить узел

Определяет, на каком первичном узле должен быть создан новый ресурс.

Имя функции

allocateNode

Права доступа

Доступна на уровне прав администратора

Формат входных данных:

Название

Тип

Описание

tenantID

String

Уникальный идентификатор организации.

orgUnitUID

String

Уникальный идентификатор подразделения организации.

userUID

String

Уникальный идентификатор пользователя.

defaultTable

Data Table

Таблица по умолчанию для вычислителя выражений распределения.

Выходные записи:

1

Формат выходных данных:

Имя

Тип

Описание

primaryNodeServerID

String

Уникальный идентификатор сервера основного узла.

primaryNodeIpAddress

String

Адрес сервера первичного узла.

primaryNodePort

String

Порт сервера основного узла.

primaryNodeLogin

String

Логин пользователя основного узла.

primaryNodePassword

String

Пароль пользователя основного узла.

Проверка доступности имени ресурса

Проверяет, доступен ли данный путь к ресурсу для регистрации.

Имя функции

checkResourceNameAvailability

Права доступа

Доступна на уровне прав администратора

Формат входных данных:

Название

Тип

Описание

tenantID

String

Уникальный идентификатор организации.

resourcePath

String

Путь к контексту ресурса для проверки

Выходные записи:

1

Формат выходных данных:

Имя

Тип

Описание

nameAvailable

Boolean

Указывает, доступен ли указанный путь к ресурсу.

path

String

Путь к ресурсу.

nodeUID

String

Идентификатор конечной вершины.

Добавить основной узел

Добавляет основной узел в кластер.

Имя функции

addPrimaryNode

Права доступа

Доступна на уровне прав администратора

Формат входных данных:

Название

Тип

Описание

tenantID

String

Уникальный идентификатор арендатора.

primaryNodeIpAddress

String

Адрес сервера первичного узла.

primaryNodePort

String

Порт сервера основного узла.

primaryNodeLogin

String

Логин пользователя основного узла.

primaryNodePassword

String

Пароль пользователя основного узла.

Выходные записи:

1

Формат выходных данных:

Имя

Тип

Описание

primaryNodeServerID

String

Идентификатор сервера основного узла.

статус

String

Сообщение о статусе.

applicationParameters

Data Table

Таблица, содержащая результаты регистрации приложений на вновь созданном узле. Она содержит следующие поля:

  • Имя приложения

  • Результаты развертывания приложения

Удалить основной узел

Удаляет указанный основной узел и мигрирует все его ресурсы в соответствии с правилами распределения. Возврат списка мигрированных ресурсов и статуса их миграции.

Имя функции

removePrimaryNode

Права доступа

Доступна на уровне прав администратора

Формат входных данных:

Название

Тип

Описание

идентификатор

String

Идентификатор сервера основного узла, который необходимо удалить.

tenantID

String

Уникальный идентификатор арендатора.

Выходные записи:

0...неограниченно

Формат выходных данных:

Название

Тип

Описание

primaryNodeServerID

String

Идентификатор первичного узла, на который был мигрирован ресурс.

resourceLocationsResourcePath

String

Путь к контексту ресурса.

creationStatus

String

Статус создания ресурса на новом первичном узле.

Статус удаления

String

Статус удаления ресурса.

Мигрировать ресурсы

Мигрировать ресурсы с указанного первичного узла и арендатора в соответствии с правилами распределения.

Имя функции

migrateResources

Права доступа

Доступна на уровне прав администратора

Формат входных данных:

Название

Тип

Описание

идентификатор

String

Уникальный идентификатор сервера основного узла.

tenantID

String

Уникальный идентификатор организации.

resourcesToMigrate

Data Table

Таблица ресурсов для миграции:

  • contextPath - путь к ресурсу

  • serverId - Идентификатор сервера, на который необходимо перенести ресурс

Выходные записи:

0...неограниченно

Формат выходных данных:

Название

Тип

Описание

primaryNodeServerID

String

Уникальный идентификатор сервера основного узла.

resourceLocationsResourcePath

String

Уникальный путь к ресурсу.

creationStatus

String

Статус создания ресурса на новом первичном узле.

Статус удаления

String

Статус удаления первичного узла.

Сканирование Ресурсов

Сканирует ресурсы первичного узла и арендатора и заполняет кластерный координатор любыми не зарегистрированными ресурсами. Только ресурсы, которые пропустили Правила распределения, будут добавлены в координатор кластера.

Имя функции

scanResources

Права доступа

Доступна на уровне прав администратора

Формат входных данных:

Название

Тип

Описание

id

String

Уникальный идентификатор сервера основного узла.

tenantID

String

Уникальный идентификатор организации.

Выходные записи:

0...неограниченно

Формат выходных данных:

Название

Тип

Описание

resourceLocationsResourcePath

String

Уникальный путь к ресурсу.

creationStatus

String

Статус создания ресурса на координаторе кластера.

Удалить таблицу

Удаляет указанную таблицу из базы данных координатора кластера.

Имя функции

dropTable

Права доступа

Доступна на уровне прав администратора

Формат входных данных:

Название

Тип

Описание

tableName

String

Имя таблицы, которую необходимо удалить.

indexName

String

Имя индекса, который необходимо удалить.

resourceFilters

Data Table

Фильтры ресурсов:

  • filterExpression - Выражение для фильтрации

  • filterMask - Маска контекста

Выходные записи:

0

Формат выходных данных:

Нет