REST API Служба Azure SignalR
Статья 10/24/2023
1 участник
Обратная связь
В этой статье
Версия: 2022-06-01
Доступные интерфейсы API
/api/health
HEAD
Итоги
Получение состояния работоспособности службы.
Получение состояния работоспособности службы
HEAD /api/health
Параметры
Имя.
Расположение
Description
Обязательное поле
Схема
api-version
query
Версия REST API.
Да
строка
Отклики
Код
Описание
200
Служба работоспособна
default
Отклик в случае ошибки
/api/hubs/{hub}/:closeConnections
POST
Итоги
Закройте все подключения в концентраторе.
Закройте все подключения в концентраторе
POST /api/hubs/{hub}/:closeConnections
Параметры
Имя.
Расположение
Description
Обязательное поле
Схема
hub
path
Имя целевого концентратора, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Да
строка
приложений
query
Имя целевого приложения, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Нет
строка
Исключены
query
Исключите эти идентификаторы подключения при закрытии подключений в концентраторе.
No
[ строка ]
reason
query
Причина закрытия клиентских подключений.
Нет
строка
api-version
query
Версия REST API.
Да
строка
Отклики
Код
Описание
Схема
204
Удачное завершение
default
Отклик в случае ошибки
ErrorDetail
/api/hubs/{hub}/:send
POST
Итоги
Трансляция сообщения всем клиентам, подключенным к целевому концентратору.
Трансляция сообщения всем клиентам, подключенным к целевому концентратору
POST /api/hubs/{hub}/:send
Параметры
Имя.
Расположение
Description
Обязательное поле
Схема
hub
path
Имя целевого концентратора, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Да
строка
приложений
query
Имя целевого приложения, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Нет
строка
Исключены
query
Исключенные идентификаторы подключения
No
[ строка ]
api-version
query
Версия REST API.
Да
строка
message
текст
Сообщение полезных данных.
Да
Полезные данныеMessage
Отклики
/api/hubs/{hub}/connections/{connectionId}
HEAD
Итоги
Проверьте, существует ли подключение с заданным идентификатором подключения.
Проверьте, существует ли подключение с заданным идентификатором подключения.
HEAD /api/hubs/{hub}/connections/{connectionId}
Параметры
Имя.
Расположение
Description
Обязательное поле
Схема
hub
path
Имя целевого концентратора, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Да
строка
connectionId
path
Идентификатор подключения.
Да
строка
приложений
query
Имя целевого приложения, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Нет
строка
api-version
query
Версия REST API.
Да
строка
Отклики
DELETE
Итоги
Закрытие подключения клиента
Закрытие подключения клиента
DELETE /api/hubs/{hub}/connections/{connectionId}
Параметры
Имя.
Расположение
Description
Обязательное поле
Схема
hub
path
Имя целевого концентратора, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Да
строка
connectionId
path
Идентификатор подключения.
Да
строка
приложений
query
Имя целевого приложения, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Нет
строка
reason
query
Причина закрытия подключения.
Нет
строка
api-version
query
Версия REST API.
Да
строка
Отклики
/api/hubs/{hub}/connections/{connectionId}/:send
POST
Итоги
Отправьте сообщение в определенное подключение.
Отправка сообщения в определенное подключение
POST /api/hubs/{hub}/connections/{connectionId}/:send
Параметры
Имя.
Расположение
Description
Обязательное поле
Схема
hub
path
Имя целевого концентратора, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Да
строка
connectionId
path
Идентификатор подключения.
Да
строка
приложений
query
Имя целевого приложения, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Нет
строка
api-version
query
Версия REST API.
Да
строка
message
текст
Сообщение полезных данных.
Да
Полезные данныеMessage
Отклики
/api/hubs/{hub}/groups/{group}
HEAD
Итоги
Проверьте наличие клиентских подключений в данной группе
Проверьте наличие клиентских подключений в данной группе
HEAD /api/hubs/{hub}/groups/{group}
Параметры
Имя.
Расположение
Description
Обязательное поле
Схема
hub
path
Имя целевого концентратора, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Да
строка
group
path
Имя целевой группы, длина которой должна превышать 0 и меньше 1025.
Да
строка
приложений
query
Имя целевого приложения, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Нет
строка
api-version
query
Версия REST API.
Да
строка
Отклики
/api/hubs/{hub}/groups/{group}/:closeConnections
POST
Итоги
Закройте подключения в определенной группе.
Закрытие подключений в определенной группе
POST /api/hubs/{hub}/groups/{group}/:closeConnections
Параметры
Имя.
Расположение
Description
Обязательное поле
Схема
hub
path
Имя целевого концентратора, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Да
строка
group
path
Имя целевой группы, длина которой должна превышать 0 и меньше 1025.
Да
строка
приложений
query
Имя целевого приложения, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Нет
строка
Исключены
query
Исключите эти идентификаторы подключения при закрытии подключений в концентраторе.
No
[ строка ]
reason
query
Причина закрытия клиентских подключений.
Нет
строка
api-version
query
Версия REST API.
Да
строка
Отклики
Код
Описание
Схема
204
Удачное завершение
default
Отклик в случае ошибки
ErrorDetail
/api/hubs/{hub}/groups/{group}/:send
POST
Итоги
Трансляция сообщения всем клиентам в целевой группе.
Трансляция сообщения всем клиентам в целевой группе
POST /api/hubs/{hub}/groups/{group}/:send
Параметры
Имя.
Расположение
Description
Обязательное поле
Схема
hub
path
Имя целевого концентратора, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Да
строка
group
path
Имя целевой группы, длина которой должна превышать 0 и меньше 1025.
Да
строка
приложений
query
Имя целевого приложения, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Нет
строка
Исключены
query
Исключенные идентификаторы подключения
No
[ строка ]
api-version
query
Версия REST API.
Да
строка
message
текст
Сообщение полезных данных.
Да
Полезные данныеMessage
Отклики
/api/hubs/{hub}/groups/{group}/connections/{connectionId}
PUT
Итоги
Добавьте подключение к целевой группе.
Добавление подключения к целевой группе
PUT /api/hubs/{hub}/groups/{group}/connections/{connectionId}
Параметры
Имя.
Расположение
Description
Обязательное поле
Схема
hub
path
Имя целевого концентратора, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Да
строка
group
path
Имя целевой группы, длина которой должна превышать 0 и меньше 1025.
Да
строка
connectionId
path
Идентификатор целевого подключения
Да
строка
приложений
query
Имя целевого приложения, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Нет
строка
api-version
query
Версия REST API.
Да
строка
Отклики
DELETE
Итоги
Удалите подключение из целевой группы.
Удаление подключения из целевой группы
DELETE /api/hubs/{hub}/groups/{group}/connections/{connectionId}
Параметры
Имя.
Расположение
Description
Обязательное поле
Схема
hub
path
Имя целевого концентратора, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Да
строка
group
path
Имя целевой группы, длина которой должна превышать 0 и меньше 1025.
Да
строка
connectionId
path
Идентификатор целевого подключения
Да
строка
приложений
query
Имя целевого приложения, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Нет
строка
api-version
query
Версия REST API.
Да
строка
Отклики
/api/hubs/{hub}/connections/{connectionId}/groups
DELETE
Итоги
Удаление подключения из всех групп
Удаление подключения из всех групп
DELETE /api/hubs/{hub}/connections/{connectionId}/groups
Параметры
Имя.
Расположение
Description
Обязательное поле
Схема
hub
path
Имя целевого концентратора, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Да
строка
connectionId
path
Идентификатор целевого подключения
Да
строка
приложений
query
Имя целевого приложения, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Нет
строка
api-version
query
Версия REST API.
Да
строка
Отклики
/api/hubs/{hub}/users/{user}
HEAD
Итоги
Проверьте, подключены ли клиентские подключения для данного пользователя
Проверьте, подключены ли клиентские подключения для данного пользователя
HEAD /api/hubs/{hub}/users/{user}
Параметры
Имя.
Расположение
Description
Обязательное поле
Схема
hub
path
Имя целевого концентратора, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Да
строка
Пользователь
path
Идентификатор пользователя.
Да
строка
приложений
query
Имя целевого приложения, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Нет
строка
api-version
query
Версия REST API.
Да
строка
Отклики
/api/hubs/{hub}/users/{user}/:closeConnections
POST
Итоги
Закройте подключения для конкретного пользователя.
Закрытие подключений для конкретного пользователя
POST /api/hubs/{hub}/users/{user}/:closeConnections
Параметры
Имя.
Расположение
Description
Обязательное поле
Схема
hub
path
Имя целевого концентратора, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Да
строка
Пользователь
path
Идентификатор пользователя.
Да
строка
приложений
query
Имя целевого приложения, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Нет
строка
Исключены
query
Исключите эти идентификаторы подключения при закрытии подключений в концентраторе.
No
[ строка ]
reason
query
Причина закрытия клиентских подключений.
Нет
строка
api-version
query
Версия REST API.
Да
строка
Отклики
Код
Описание
Схема
204
Удачное завершение
default
Отклик в случае ошибки
ErrorDetail
/api/hubs/{hub}/users/{user}/:send
POST
Итоги
Трансляция сообщения всем клиентам принадлежит целевому пользователю.
Трансляция сообщения всем клиентам принадлежит целевому пользователю
POST /api/hubs/{hub}/users/{user}/:send
Параметры
Имя.
Расположение
Description
Обязательное поле
Схема
hub
path
Имя целевого концентратора, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Да
строка
Пользователь
path
Идентификатор пользователя.
Да
строка
приложений
query
Имя целевого приложения, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Нет
строка
api-version
query
Версия REST API.
Да
строка
message
текст
Сообщение полезных данных.
Да
Полезные данныеMessage
Отклики
/api/hubs/{hub}/users/{user}/groups/{group}
HEAD
Итоги
Проверьте, существует ли пользователь в целевой группе.
Проверьте, существует ли пользователь в целевой группе
HEAD /api/hubs/{hub}/users/{user}/groups/{group}
Параметры
Имя.
Расположение
Description
Обязательное поле
Схема
hub
path
Имя целевого концентратора, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Да
строка
group
path
Имя целевой группы, длина которой должна превышать 0 и меньше 1025.
Да
строка
Пользователь
path
Идентификатор целевого пользователя
Да
строка
приложений
query
Имя целевого приложения, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Нет
строка
api-version
query
Версия REST API.
Да
строка
Отклики
PUT
Итоги
Добавьте пользователя в целевую группу.
Добавление пользователя в целевую группу
PUT /api/hubs/{hub}/users/{user}/groups/{group}
Параметры
Имя.
Расположение
Description
Обязательное поле
Схема
hub
path
Имя целевого концентратора, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Да
строка
group
path
Имя целевой группы, длина которой должна превышать 0 и меньше 1025.
Да
строка
Пользователь
path
Идентификатор целевого пользователя
Да
строка
приложений
query
Имя целевого приложения, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Нет
строка
ttl
query
Указывает секунды, которые пользователь существует в группе. Если этот параметр не задан, пользователь находится в группе в течение 1 года в большинстве случаев. Если пользователь добавляется в некоторые группы без ограничения ttl, только последние обновленные 100 групп будут зарезервированы среди всех групп, присоединенных пользователем без TTL. Если значение ttl = 0, в целевую группу будут добавлены только текущие подключенные подключения целевого пользователя.
No
integer
api-version
query
Версия REST API.
Да
строка
Отклики
DELETE
Итоги
Удалите пользователя из целевой группы.
Удаление пользователя из целевой группы
DELETE /api/hubs/{hub}/users/{user}/groups/{group}
Параметры
Имя.
Расположение
Description
Обязательное поле
Схема
hub
path
Имя целевого концентратора, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Да
строка
group
path
Имя целевой группы, длина которой должна превышать 0 и меньше 1025.
Да
строка
Пользователь
path
Идентификатор целевого пользователя
Да
строка
приложений
query
Имя целевого приложения, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Нет
строка
api-version
query
Версия REST API.
Да
строка
Отклики
Код
Описание
Схема
204
Удачное завершение
default
Отклик в случае ошибки
ErrorDetail
/api/hubs/{hub}/users/{user}/groups
DELETE
Итоги
Удалите пользователя из всех групп.
Удаление пользователя из всех групп
DELETE /api/hubs/{hub}/users/{user}/groups
Параметры
Имя.
Расположение
Description
Обязательное поле
Схема
hub
path
Имя целевого концентратора, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Да
строка
Пользователь
path
Идентификатор целевого пользователя
Да
строка
приложений
query
Имя целевого приложения, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.
Нет
строка
api-version
query
Версия REST API.
Да
строка
Отклики
Код
Описание
Схема
204
Удачное завершение
default
Отклик в случае ошибки
ErrorDetail
Модели
ErrorDetail
Объект ошибки.
Имя.
Тип
Описание
Обязательное поле
кодом
строка
Один из определяемых сервером кодов ошибок.
No
message
строка
Читаемое пользователем представление ошибки.
No
целевой объект
строка
Целевой объект ошибки.
No
details
[ ErrorDetail ]
Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.
No
inner…
InnerError No
InnerError
Имя.
Тип
Описание
Обязательное поле
кодом
строка
Более конкретный код ошибки, чем был предоставлен содержащей ошибкой.
No
inner…
InnerError No
Полезные данныеMessage
Имя.
Тип
Описание
Обязательное поле
целевой объект
строка
Да
аргументы
[ ]
No
ServiceResponse
Имя.
Тип
Описание
Обязательное поле
кодом
string
Нет
level
строка
Перечисление: "Info", , "Warning""Error"No
область
строка
Перечисление: "Unknown", , "User""Request""Connection""Group"No
errorKind
строка
Перечисление: "Unknown", , "NotExisted""NotInGroup""Invalid"No
message
строка
Нет
jsonObject
No
isSuccess
boolean
No