Web Pub Sub - Send To Connection

Служба:

Azure Web PubSub Service

Версия API:

2023-07-01

Отправка содержимого в тексте запроса к определенному соединению.

POST {endpoint}/api/hubs/{hub}/connections/{connectionId}/:send?api-version=2023-07-01

С использованием необязательных параметров:

POST {endpoint}/api/hubs/{hub}/connections/{connectionId}/:send?api-version=2023-07-01&messageTtlSeconds={messageTtlSeconds}

Параметры URI

Имя	В	Обязательно	Тип	Описание
connectionId	path	True	string	Идентификатор подключения.
endpoint	path	True	string url	Конечная точка HTTP или HTTPS для экземпляра службы Web PubSub.
hub	path	True	string	Имя целевого концентратора, которое должно начинаться с букв и содержать только буквенно-цифровые символы или символы подчеркивания. Шаблон регулярного выражения: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$
api-version	query	True	string	Версия REST API.
messageTtlSeconds	query		integer int32	Значение срока жизни (TTL) в секундах для сообщений, отправленных в службу. 0 является значением по умолчанию, что означает, что срок действия сообщения никогда не истекает. 300 — максимальное значение. Если этот параметр не равен нулю, служба удаляет сообщения, которые не используются клиентом в рамках указанного срока жизни. Этот параметр может помочь, если пропускная способность клиента ограничена.

Текст запроса

Media Types: "application/octet-stream", "text/plain", "application/json"

Имя	Тип	Описание
message	string	Текст полезных данных.

Ответы

Имя	Тип	Описание
202 Accepted		Принято
Other Status Codes	ErrorDetail	Сообщение об ошибке Заголовки x-ms-error-code: string

Примеры

WebPubSub_SendToConnection

Образец запроса

HTTP

POST {endpoint}/api/hubs/hub1/connections/connection1/:send?api-version=2023-07-01&messageTtlSeconds=15

"Message to send"

Пример ответа

Код состояния:

202

Определения

Имя	Описание
ErrorDetail	Объект ошибки.
InnerError

ErrorDetail

Объект ошибки.

Имя	Тип	Описание
code	string	Один из серверных наборов кодов ошибок.
details	ErrorDetail[]	Массив сведений о конкретных ошибках, которые привели к этой сообщаемой ошибке.
inner	InnerError
message	string	Понятное представление ошибки.
target	string	Целевой объект ошибки.

InnerError

Имя	Тип	Описание
code	string	Более конкретный код ошибки, чем указано в содержающей ошибке.
inner	InnerError