Экспорт (0) Печать
Развернуть все

Размещение сообщения (API-интерфейс REST)

Обновлено: Сентябрь 2014 г.

Операция Put Message добавляет новое сообщение в конец очереди сообщений. Можно также задать время ожидания видимости, чтобы сообщение было невидимым, пока не истечет это время ожидания. Сообщение должно быть в формате, который может включаться в XML-запрос с кодировкой UTF-8. Закодированное сообщение может иметь размер до 64 КБ в версиях 2011-08-18 и более поздних и до 8 КБ в более ранних версиях.

Запрос Put Message можно составить следующим образом. Рекомендуется использовать протокол HTTPS. Замените myaccount именем вашей учетной записи хранилища, а myqueue именем очереди.

 

Метод URI запроса Версия HTTP

POST

https://myaccount.queue.core.windows.net/myqueue/messages?visibilitytimeout=<int-seconds>&messagettl=<int-seconds>

HTTP/1.1

Эта операция и необязательный параметр visibilitytimeout поддерживаются в пакете SDK версии 1.6 и более новых версий.

При построении запроса к эмулированной службе хранилища укажите имя узла эмулятора и порт службы очередей в виде 127.0.0.1:10001, затем укажите имя эмулированной учетной записи хранилища.

 

Метод URI запроса Версия HTTP

POST

http://127.0.0.1:10001/devstoreaccount1/myqueue/messages?visibilitytimeout=<int-seconds>&messagettl=<int-seconds>

HTTP/1.1

Дополнительные сведения см. в разделе About Development Storage.

В URI запроса могут быть заданы следующие параметры.

 

Параметр Описание

visibilitytimeout=<int=seconds>

Необязательно. Если он указан, запрос следует выполнять с применением версии x-ms-version 2011-08-18 или более новой. Если не указано, значение по умолчанию равно 0. Указывает новое значение времени ожидания видимости в секундах, отсчитываемое относительно времени сервера. Новое значение должно быть больше или равно 0 и не может превышать 7 дней. Значение времени ожидания видимости сообщения не может быть позже истечения срока действия. Значение visibilitytimeout должно быть меньше значения срока существования.

messagettl=<int-seconds>

Необязательно. Задает интервал срока существования сообщения в секундах. Максимальный разрешенный срок существования составляет 7 дней. Если этот параметр пропущен, по умолчанию срок существования составляет 7 дней.

timeout

Необязательно. Параметр timeout указывается в секундах. Дополнительные сведения см. в разделе Задание времени ожидания для операций службы очередей.

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

 

Заголовок запроса Описание

Authorization

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

Date or x-ms-date

Обязательно. Задает время в формате UTC для запроса. Дополнительные сведения см. в разделе Проверка подлинности для служб хранения Azure.

x-ms-version

Необязательно. Задает версию операции, используемой для этого запроса. Дополнительные сведения см. в разделе Управление версиями для служб хранилища Azure.

x-ms-client-request-id

Необязательно. Предоставляет сформированное клиентом непрозрачное значение с ограничением в 1 КБ, которое записывается в журналы аналитики, когда включено ведение журналов аналитики хранилища. Этот заголовок настоятельно рекомендуется использовать для соотнесения действий, выполняемых на стороне клиента, с запросами, получаемыми сервером. Дополнительные сведения см. в разделах Сведения о ведении журнала службы аналитики хранилища и Ведение журналов в Windows Azure: использование журналов для отслеживания запросов к хранилищу.

Текст запроса содержит данные сообщения в следующем формате XML. Обратите внимание, что содержимое сообщения должно быть в формате, который допускает кодировку UTF-8.

<QueueMessage>
    <MessageText>message-content</MessageText>
</QueueMessage>

Request:
POST https://myaccount.queue.core.windows.net/messages?visibilitytimeout=30&timeout=30 HTTP/1.1

Headers:
x-ms-version: 2011-08-18
x-ms-date: Tue, 30 Aug 2011 01:03:21 GMT
Authorization: SharedKey myaccount:sr8rIheJmCd6npMSx7DfAY3L//V3uWvSXOzUBCV9wnk=
Content-Length: 100

Body:
<QueueMessage>
<MessageText>PHNhbXBsZT5zYW1wbGUgbWVzc2FnZTwvc2FtcGxlPg==</MessageText>
</QueueMessage>

Ответ включает код статуса HTTP и набор заголовков ответа.

Успешная операция возвращает код состояния 201 (Создано).

Сведения о кодах состояния см. в разделе Коды состояний и ошибок.

Ответ для этой операции включает следующие заголовки. Ответ может также включать дополнительные стандартные заголовки HTTP. Все стандартные заголовки соответствуют Спецификации протокола HTTP/1.1.

 

Заголовок запроса Описание

x-ms-request-id

Этот заголовок однозначно определяет выполненный запрос, его также можно использовать для устранения связанных с запросом неполадок. Дополнительные сведения см. в разделе Устранение неполадок при API-операциях.

x-ms-version

Указывает версию службы очередей, которая используется для выполнения запроса. Этот заголовок возвращается для запросов к версии 2009-09-19 и более поздним версиям.

Date

Значение даты и времени в формате UTC, сформированное службой и указывающее время, когда был инициирован ответ.

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

Необязательное время ожидания видимости задает время, в течение которого сообщение будет невидимо. После истечения времени ожидания сообщение станет видимым. Если время ожидания видимости не указано, по умолчанию используется значение 0.

Необязательный срок существования сообщения указывает, как долго сообщение будет оставаться в очереди. При истечении срока существования сообщение удаляется из очереди.

Если сообщение слишком большое, служба возвращает код состояния 400 (неправильный запрос).

Показ:
© 2014 Microsoft