REST API плоскости данных Служба Azure SignalR — версия 1
Статья 10/24/2023
1 участник
Обратная связь
В этой статье
В этой статье содержатся ИНТЕРФЕЙСы REST API версии 1 для плоскости данных Служба Azure SignalR.
Доступные интерфейсы API
Трансляция сообщения всем клиентам, подключенным к целевому концентратору.
POST /api/v1/hubs/{hub}
Параметры
Имя
Расположение
Description
Обязательное поле
Схема
hub
path
Имя целевого концентратора, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Да
строка
Исключены
query
Исключенные идентификаторы подключения
Нет
[ строка ]
Отклики
Код
Описание
202
Удачное завершение
400
ошибка запроса
Трансляция сообщения всем клиентам принадлежит целевому пользователю.
POST /api/v1/hubs/{hub}/users/{id}
Параметры
Имя
Расположение
Description
Обязательное поле
Схема
hub
path
Имя целевого концентратора, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Да
строка
id
path
Идентификатор пользователя.
Да
строка
Отклики
Код
Описание
202
Удачное завершение
400
ошибка запроса
Отправьте сообщение в определенное подключение.
POST /api/v1/hubs/{hub}/connections/{connectionId}
Параметры
Имя
Расположение
Description
Обязательное поле
Схема
hub
path
Имя целевого концентратора, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Да
строка
connectionId
path
Идентификатор подключения.
Да
строка
Отклики
Код
Описание
202
Удачное завершение
400
ошибка запроса
Проверьте, существует ли подключение с заданным идентификатором подключения.
GET /api/v1/hubs/{hub}/connections/{connectionId}
Параметры
Имя
Расположение
Description
Обязательное поле
Схема
hub
path
Да
строка
connectionId
path
Да
строка
Отклики
Код
Описание
200
Удачное завершение
400
ошибка запроса
404
Не найдено
Закрытие подключения клиента
DELETE /api/v1/hubs/{hub}/connections/{connectionId}
Параметры
Имя
Расположение
Description
Обязательное поле
Схема
hub
path
Да
строка
connectionId
path
Да
строка
reason
query
Нет
строка
Отклики
Код
Описание
202
Удачное завершение
400
ошибка запроса
Трансляция сообщения всем клиентам в целевой группе.
POST /api/v1/hubs/{hub}/groups/{group}
Параметры
Имя
Расположение
Description
Обязательное поле
Схема
hub
path
Имя целевого концентратора, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Да
строка
group
path
Имя целевой группы, длина которой должна превышать 0 и меньше 1025.
Да
строка
Исключены
query
Исключенные идентификаторы подключения
Нет
[ строка ]
Отклики
Код
Описание
202
Удачное завершение
400
ошибка запроса
Проверьте наличие клиентских подключений в данной группе
GET /api/v1/hubs/{hub}/groups/{group}
Параметры
Имя
Расположение
Description
Обязательное поле
Схема
hub
path
Да
строка
group
path
Да
строка
Отклики
Код
Описание
200
Удачное завершение
400
ошибка запроса
404
Не найдено
Проверьте, подключены ли клиентские подключения для данного пользователя
GET /api/v1/hubs/{hub}/users/{user}
Параметры
Имя
Расположение
Description
Обязательное поле
Схема
hub
path
Да
строка
Пользователь
path
Да
строка
Отклики
Код
Описание
200
Удачное завершение
400
ошибка запроса
404
Не найдено
Добавьте подключение к целевой группе.
PUT /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}
Параметры
Имя
Расположение
Description
Обязательное поле
Схема
hub
path
Имя целевого концентратора, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Да
строка
group
path
Имя целевой группы, длина которой должна превышать 0 и меньше 1025.
Да
строка
connectionId
path
Идентификатор целевого подключения
Да
строка
Отклики
Код
Описание
200
Удачное завершение
400
ошибка запроса
404
Не найдено
Удалите подключение из целевой группы.
DELETE /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}
Параметры
Имя
Расположение
Description
Обязательное поле
Схема
hub
path
Имя целевого концентратора, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Да
строка
group
path
Имя целевой группы, длина которой должна превышать 0 и меньше 1025.
Да
строка
connectionId
path
Идентификатор целевого подключения
Да
строка
Отклики
Код
Описание
200
Удачное завершение
400
ошибка запроса
404
Не найдено
Проверьте, существует ли пользователь в целевой группе.
GET /api/v1/hubs/{hub}/groups/{group}/users/{user}
Параметры
Имя
Расположение
Description
Обязательное поле
Схема
hub
path
Имя целевого концентратора, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Да
строка
group
path
Имя целевой группы, длина которой должна превышать 0 и меньше 1025.
Да
строка
Пользователь
path
Идентификатор целевого пользователя
Да
строка
Отклики
Код
Описание
200
Удачное завершение
400
ошибка запроса
404
Не найдено
Добавьте пользователя в целевую группу.
PUT /api/v1/hubs/{hub}/groups/{group}/users/{user}
Параметры
Имя
Расположение
Description
Обязательное поле
Схема
hub
path
Имя целевого концентратора, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Да
строка
group
path
Имя целевой группы, длина которой должна превышать 0 и меньше 1025.
Да
строка
Пользователь
path
Идентификатор целевого пользователя
Да
строка
ttl
query
Указывает секунды, которые пользователь существует в группе. Если этот параметр не задан, пользователь живет в группе не более 1 года. Обратите внимание, что если ttl не задан, служба сохраняет 100 связей групп пользователей на пользователя и старых отношений группы пользователей перезаписываются только что добавленными.
Нет
integer
Отклики
Код
Описание
202
Удачное завершение
400
ошибка запроса
Удалите пользователя из целевой группы.
DELETE /api/v1/hubs/{hub}/groups/{group}/users/{user}
Параметры
Имя
Расположение
Description
Обязательное поле
Схема
hub
path
Имя целевого концентратора, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Да
строка
group
path
Имя целевой группы, длина которой должна превышать 0 и меньше 1025.
Да
строка
Пользователь
path
Идентификатор целевого пользователя
Да
строка
Отклики
Код
Описание
202
Удачное завершение
400
ошибка запроса
Удалите пользователя из всех групп.
DELETE /api/v1/hubs/{hub}/users/{user}/groups
Параметры
Имя
Расположение
Description
Обязательное поле
Схема
hub
path
Имя целевого концентратора, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Да
строка
Пользователь
path
Идентификатор целевого пользователя
Да
строка
Отклики
Код
Описание
200
Пользователь удаляется
202
Запрос на удаление принимается, и служба обрабатывает запрос в фоновом режиме.
400
ошибка запроса
Модели
Полезные данныеMessage
Имя.
Тип
Описание
Обязательное поле
Назначение
строка
Нет
Аргументы
[ объект ]
Нет