Wyczyść komunikaty

  • Artykuł

Operacja Clear Messages usuwa wszystkie komunikaty z określonej kolejki.

Żądanie

Żądanie można skonstruować Clear Messages w następujący sposób. Zalecamy użycie protokołu HTTPS. Zastąp ciąg myaccount nazwą konta magazynu i zastąp ciąg myqueue nazwą kolejki.

Metoda Identyfikator URI żądania Wersja PROTOKOŁU HTTP
DELETE https://myaccount.queue.core.windows.net/myqueue/messages HTTP/1.1

Identyfikator URI emulowanej usługi magazynu

Podczas wysyłania żądania względem emulowanej usługi magazynu określ nazwę hosta emulatora i port usługi Azure Queue Storage jako 127.0.0.1:10001, a następnie nazwę emulowanego konta magazynu:

Metoda Identyfikator URI żądania Wersja PROTOKOŁU HTTP
DELETE http://127.0.0.1:10001/devstoreaccount1/myqueue/messages HTTP/1.1

Parametry identyfikatora URI

W identyfikatorze URI żądania można określić następujące dodatkowe parametry:

Parametr Opis
timeout Opcjonalny. Parametr jest wyrażony timeout w sekundach. Aby uzyskać więcej informacji, zobacz Ustawianie limitów czasu dla operacji usługi Queue Storage.

Nagłówki żądań

W poniższej tabeli opisano wymagane i opcjonalne nagłówki żądań:

Nagłówek żądania Opis
Authorization Wymagane. Określa schemat autoryzacji, nazwę konta i podpis. Aby uzyskać więcej informacji, zobacz Autoryzowanie żądań do usługi Azure Storage.
Date lub x-ms-date Wymagane. Określa dla żądania godzinę w formacie uniwersalnego czasu koordynowanego (UTC). Aby uzyskać więcej informacji, zobacz Autoryzowanie żądań do usługi Azure Storage.
x-ms-version Opcjonalny. Określa wersję operacji do użycia dla tego żądania. Aby uzyskać więcej informacji, zobacz Przechowywanie wersji usług Azure Storage.
x-ms-client-request-id Opcjonalny. Udostępnia nieprzezroczystą wartość wygenerowaną przez klienta z limitem znaków 1-kibibyte (KiB), który jest rejestrowany w dziennikach podczas konfigurowania rejestrowania. Zdecydowanie zalecamy używanie tego nagłówka do korelowania działań po stronie klienta z żądaniami odbieranymi przez serwer.

Treść żądania

Brak.

Reakcja

Odpowiedź zawiera kod stanu HTTP i zestaw nagłówków odpowiedzi.

Kod stanu

Operacja zakończona powodzeniem zwraca kod stanu 204 (Brak zawartości).

Aby uzyskać informacje o kodach stanu, zobacz Stan i kody błędów.

Nagłówki odpowiedzi

Odpowiedź na tę operację zawiera następujące nagłówki. Odpowiedź zawiera również dodatkowe standardowe nagłówki HTTP. Wszystkie nagłówki standardowe są zgodne ze specyfikacją protokołu HTTP/1.1.

Nagłówek żądania Opis
x-ms-request-id Jednoznacznie identyfikuje wykonane żądanie. Ten nagłówek służy do rozwiązywania problemów z żądaniem. Aby uzyskać więcej informacji, zobacz Rozwiązywanie problemów z operacjami interfejsu API.
x-ms-version Wskazuje wersję usługi Queue Storage, która jest używana do wykonania żądania. Ten nagłówek jest zwracany dla żądań wysyłanych w wersji 2009-09-19 lub nowszej.
Date Wartość daty/godziny UTC wskazująca godzinę, w której usługa wysłała odpowiedź.
x-ms-client-request-id Może służyć do rozwiązywania problemów z żądaniami i odpowiadającymi im odpowiedziami. Wartość tego nagłówka jest równa wartości x-ms-client-request-id nagłówka, jeśli znajduje się w żądaniu, a wartość wynosi co najwyżej 1024 widoczne znaki ASCII. x-ms-client-request-id Jeśli nagłówek nie znajduje się w żądaniu, ten nagłówek nie będzie obecny w odpowiedzi.

Treść odpowiedzi

Brak.

Autoryzacja

Tylko właściciel konta może wywołać tę operację.

Uwagi

Jeśli kolejka zawiera dużą liczbę komunikatów, Clear Messages może upłynąć limit czasu przed usunięciem wszystkich komunikatów. W takim przypadku usługa Queue Storage zwraca kod stanu 500 (wewnętrzny błąd serwera) z dodatkowym kodem błędu OperationTimedOut. Jeśli zostanie wyświetlony ten kod błędu, operacja może lub nie powiodła się po stronie serwera i należy wykonać zapytanie o stan serwera przed ponowieniu próby wykonania operacji. Jeśli operacja przekroczyła limit czasu i jest zdeterminowana, że niepowodzenie po stronie serwera, klient powinien kontynuować ponawianie próby Clear Messages , dopóki nie powiedzie się, aby upewnić się, że wszystkie komunikaty zostały usunięte.

Zobacz też

Kody błędów usługi Queue Storage
Autoryzowanie żądań do usługi Azure Storage
Kody stanu i błędów