Pobieranie właściwości usługi kolejki

Artykuł
06/27/2023

Operacja Get Queue Service Properties pobiera właściwości konta usługi Azure Queue Storage, w tym właściwości reguł analityka magazynu i współużytkowania zasobów między źródłami (CORS).

Aby uzyskać więcej informacji na temat reguł współużytkowania zasobów między źródłami (CORS) i logiki oceny, zobacz Obsługa mechanizmu CORS dla usług Azure Storage.

Żądanie

Żądanie Get Queue Service Properties można określić w następujący sposób. Zalecamy używanie protokołu HTTPS. Zastąp <nazwę> konta nazwą konta magazynu:

Metoda	Identyfikator URI żądania	Wersja PROTOKOŁU HTTP
GET	`https://<account-name>.queue.core.windows.net/?restype=service&comp=properties`	HTTP/1.1

Uwaga

Identyfikator URI musi zawsze zawierać znak ukośnika (/), aby oddzielić nazwę hosta od ścieżki i fragmentów zapytania identyfikatora URI. W tej operacji część ścieżki identyfikatora URI jest pusta.

Parametry identyfikatora URI

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

Parametr	Opis
`restype=service&comp=properties`	Wymagane. Kombinacja obu ciągów zapytania jest wymagana do pobrania właściwości usługi magazynu.
`timeout`	Opcjonalny. Parametr jest wyrażony `timeout` w sekundach. Aby uzyskać więcej informacji, zobacz Ustawianie limitów czasu dla operacji usługi Azure 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 magazynu 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`	Wymagane dla wszystkich autoryzowanych żądań. 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. Aby uzyskać więcej informacji, zobacz Monitorowanie usługi Azure Queue Storage.

Treść żądania

Brak.

Reakcja

Odpowiedź zawiera kod stanu HTTP, zestaw nagłówków odpowiedzi i treść odpowiedzi.

Kod stanu

Operacja zakończona powodzeniem zwraca kod stanu 200 (OK).

Nagłówki odpowiedzi

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

Nagłówek odpowiedzi	Opis
`x-ms-request-id`	Jednoznacznie identyfikuje żądanie skierowane do usługi.
`x-ms-version`	Określa wersję operacji używanej dla odpowiedzi. Aby uzyskać więcej informacji, zobacz Przechowywanie wersji usług Azure Storage.
`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ść nie zawiera więcej niż 1024 widocznych znaków ASCII. `x-ms-client-request-id` Jeśli nagłówek nie jest obecny w żądaniu, nie będzie on obecny w odpowiedzi.

Treść odpowiedzi

W przypadku wersji 2012-02-12 i starszej format treści odpowiedzi jest następujący:

<?xml version="1.0" encoding="utf-8"?>  
<StorageServiceProperties>  
    <Logging>  
        <Version>version-number</Version>  
        <Delete>true|false</Delete>  
        <Read>true|false</Read>  
        <Write>true|false</Write>  
        <RetentionPolicy>  
            <Enabled>true|false</Enabled>  
            <Days>number-of-days</Days>  
        </RetentionPolicy>  
    </Logging>  
    <Metrics>  
        <Version>version-number</Version>  
        <Enabled>true|false</Enabled>  
        <IncludeAPIs>true|false</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true|false</Enabled>  
            <Days>number-of-days</Days>  
        </RetentionPolicy>  
    </Metrics>  
</StorageServiceProperties>

Od wersji 2013-08-15 format treści odpowiedzi jest następujący:

<?xml version="1.0" encoding="utf-8"?>  
<StorageServiceProperties>  
    <Logging>  
        <Version>version-number</Version>  
        <Delete>true|false</Delete>  
        <Read>true|false</Read>  
        <Write>true|false</Write>  
        <RetentionPolicy>  
            <Enabled>true|false</Enabled>  
            <Days>number-of-days</Days>  
        </RetentionPolicy>  
    </Logging>  
    <HourMetrics>  
        <Version>version-number</Version>  
        <Enabled>true|false</Enabled>  
        <IncludeAPIs>true|false</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true|false</Enabled>  
            <Days>number-of-days</Days>  
        </RetentionPolicy>  
    </HourMetrics>  
    <MinuteMetrics>  
        <Version>version-number</Version>  
        <Enabled>true|false</Enabled>  
        <IncludeAPIs>true|false</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true|false</Enabled>  
            <Days>number-of-days</Days>  
        </RetentionPolicy>  
    </MinuteMetrics>  
    <Cors>  
        <CorsRule>  
            <AllowedOrigins>comma-separated-list-of-allowed-origins</AllowedOrigins>  
            <AllowedMethods>comma-separated-list-of-HTTP-verb</AllowedMethods>  
            <MaxAgeInSeconds>max-caching-age-in-seconds</MaxAgeInSeconds>  
            <ExposedHeaders>comma-separated-list-of-response-headers</ExposedHeaders>  
            <AllowedHeaders> comma-separated-list-of-request-headers </AllowedHeaders>  
        </CorsRule>  
    </Cors>  
</StorageServiceProperties>

Elementy treści odpowiedzi opisano w poniższej tabeli:

Nazwa elementu	Opis
Rejestrowanie	Grupuje ustawienia rejestrowania analityka magazynu.
Metryki	Grupuje ustawienia metryk analityka magazynu. Ustawienia metryk zawierają podsumowanie statystyk żądań pogrupowanych według interfejsu API w agregacjach godzinowych dla kolejek.
Metryki godzin	Grupuje ustawienia analityka magazynu HourMetrics. Ustawienia HourMetrics zawierają podsumowanie statystyk żądań pogrupowanych według interfejsu API w godzinowych agregacjach dla kolejek.
Metryki minut	Grupuje ustawienia analityka magazynu MinuteMetrics. Ustawienia MinuteMetrics* zapewniają statystyki żądań dla każdej minuty dla kolejek.
Wersja	Wersja analityka magazynu, która jest obecnie używana.
Usuwanie	Dotyczy tylko konfiguracji rejestrowania. Wskazuje, czy żądania usuwania są rejestrowane.
Read	Dotyczy tylko konfiguracji rejestrowania. Wskazuje, czy żądania odczytu są rejestrowane.
Write	Dotyczy tylko konfiguracji rejestrowania. Wskazuje, czy żądania zapisu są rejestrowane.
Włączono	Wskazuje, czy metryki są włączone dla usługi Azure Queue Storage. Jeśli włączono replikację geograficznie nadmiarową dostępu do odczytu, zbierane są zarówno metryki podstawowe, jak i pomocnicze. Jeśli replikacja geograficznie nadmiarowa dostępu do odczytu nie jest włączona, zbierane są tylko podstawowe metryki.
IncludeAPIs	Dotyczy tylko konfiguracji metryk. Wskazuje, czy metryki generują statystyki podsumowania dla wywoływanych operacji interfejsu API.
RetentionPolicy/Enabled	Wskazuje, czy zasady przechowywania są włączone dla usługi magazynu.
RetentionPolicy/Days	Wskazuje liczbę dni przechowywania metryk lub danych rejestrowania. Wszystkie dane starsze niż ta wartość zostaną usunięte.
Cors	Grupuje wszystkie reguły CORS.
CorsRule	Ustawienia grup dla reguły CORS.
AllowedOrigins	Rozdzielona przecinkami lista domen pochodzenia dozwolonych za pośrednictwem mechanizmu CORS lub gwiazdka (*) , jeśli wszystkie domeny są dozwolone.
ExposedHeaders	Rozdzielona przecinkami lista nagłówków odpowiedzi uwidacznianych klientom CORS.
MaxAgeInSeconds	Liczba sekund buforowania odpowiedzi wstępnej przez klienta lub przeglądarkę.
AllowedHeaders	Rozdzielona przecinkami lista nagłówków, które mogą być częścią żądania między źródłami.
AllowedMethods	Rozdzielona przecinkami lista metod HTTP, które mogą być wykonywane przez źródło. W przypadku usługi Azure Storage dozwolone metody to DELETE, GET, HEAD, MERGE, POST, OPTIONS lub PUT.

Autoryzacja

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

Przykładowe żądanie i odpowiedź

Następujący przykładowy identyfikator URI wysyła żądanie pobrania właściwości usługi Kolejki dla fikcyjnego konta magazynu o nazwie myaccount:

GET https://myaccount.queue.core.windows.net/?restype=service&comp=properties HTTP/1.1

Żądanie jest wysyłane z następującymi nagłówkami:

x-ms-version: 2013-08-15  
x-ms-date: Wed, 23 Oct 2013 04:49:03 GMT  
Authorization: SharedKey  
myaccount:Z1lTLDwtq5o1UYQluucdsXk6/iB7YxEu0m6VofAEkUE=  
Host: myaccount.queue.core.windows.net

Po wysłaniu żądania zostanie zwrócona następująca odpowiedź:

HTTP/1.1 200 OK  
Content-Length: 1020  
Content-Type: application/xml  
Date: Wed, 23 Oct 2013 04:49:04 GMT  
Server: Windows-Azure-Queue/1.0 Microsoft-HTTPAPI/2.0  
x-ms-request-id: cb939a31-0cc6-49bb-9fe5-3327691f2a30  
x-ms-version: 2013-08-15

Treść odpowiedzi jest podobna do następującej:

<?xml version="1.0" encoding="utf-8"?>  
<StorageServiceProperties>  
    <Logging>  
        <Version>1.0</Version>  
        <Delete>true</Delete>  
        <Read>false</Read>  
        <Write>true</Write>  
        <RetentionPolicy>  
            <Enabled>true</Enabled>  
            <Days>7</Days>  
        </RetentionPolicy>  
    </Logging>  
    <HourMetrics>  
        <Version>1.0</Version>  
        <Enabled>true</Enabled>  
        <IncludeAPIs>false</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true</Enabled>  
            <Days>7</Days>  
        </RetentionPolicy>  
    </HourMetrics>  
        <MinuteMetrics>  
        <Version>1.0</Version>  
        <Enabled>true</Enabled>  
        <IncludeAPIs>true</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true</Enabled>  
            <Days>7</Days>  
        </RetentionPolicy>  
    </MinuteMetrics>  
    <Cors>  
        <CorsRule>  
            <AllowedOrigins> http://www.fabrikam.com,http://www.contoso.com</AllowedOrigins>  
            <AllowedMethods>GET,PUT</AllowedMethods>  
            <MaxAgeInSeconds>500</MaxAgeInSeconds>  
            <ExposedHeaders>x-ms-meta-data*,x-ms-meta-customheader</ExposedHeaders>  
            <AllowedHeaders>x-ms-meta-target*,x-ms-meta-customheader</AllowedHeaders>  
        </CorsRule>  
    </Cors>  
</StorageServiceProperties>

Zobacz też

Analityka magazynu
Obsługa mechanizmu CORS dla usług Azure Storage
Specyfikacja PROTOKOŁU HTTP MECHANIZMU CORS