Pobieranie właściwości usługi plików

  • Artykuł

Operacja Get File Service Properties pobiera właściwości zasobu przy użyciu interfejsu FileService API FileREST. Mimo że ten interfejs API jest w pełni obsługiwany, jest to starszy interfejs API zarządzania. Zalecamy zamiast tego użycie usług plików — pobierz właściwości usługi, które są udostępniane przez dostawcę zasobów magazynu (Microsoft.Storage). Aby dowiedzieć się więcej o programowej interakcji z FileService zasobem przy użyciu dostawcy zasobów magazynu, zobacz Operacje na zasobie Usługi plików.

Dostępność protokołu

Włączony protokół udziału plików Dostępne
SMB Tak
NFS Tak

Żądanie

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

Metoda Identyfikator URI żądania Wersja PROTOKOŁU HTTP
GET https://<account-name>.file.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

Parametr identyfikatora URI Opis
restype=service&comp=properties Wymagane. Kombinacja obu ciągów zapytania jest wymagana do ustawienia 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 plików.

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. Ta operacja jest dostępna tylko w wersji 2015-02-21 lub nowszej. Aby pobrać właściwości metryk dla usługi plików, należy określić wersję 2015-04-05 lub nowszą.

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 usługi Azure analityka magazynu 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 Azure Files.

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, które jest wykonywane względem 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 znajduje się w żądaniu, nie jest obecny w odpowiedzi.

Treść odpowiedzi

Format treści odpowiedzi dla wersji 2020-02-10 jest następujący:

<?xml version="1.0" encoding="utf-8"?>  
<StorageServiceProperties>  
    <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-seperated-list-of-response-headers</ExposedHeaders>  
            <AllowedHeaders>comma-seperated-list-of-request-headers</AllowedHeaders>  
        </CorsRule>  
    </Cors>
    <ShareDeleteRetentionPolicy>
        <Enabled>true|false</Enabled>
        <Days>integer-value</Days>
    </ShareDeleteRetentionPolicy>
    <ProtocolSettings>
        <SMB>
            <Multichannel>
                <Enabled>true|false</Enabled>
            </Multichannel>
            <Versions>comma-separated-list-of-smb-versions</Versions>
            <AuthenticationMethods>comma-separated-list-of-auth-methods</AuthenticationMethod>
            <KerberosTicketEncryption>csv-of-kerb-encryption-algorithms</KerberosTicketEncryption>
            <ChannelEncryption>csv-of-smb-encryption-algorithms</ChannelEncryption>
        </SMB>
    </ProtocolSettings>
</StorageServiceProperties>

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

Nazwa Opis
HourMetrics Grupuje ustawienia analityka magazynuHourMetrics. Ustawienia HourMetrics zawierają podsumowanie statystyk żądań pogrupowanych według interfejsu API w agregacjach godzinowych.
MinuteMetrics Grupuje ustawienia analityka magazynuMinuteMetrics. Ustawienia MinuteMetrics zapewniają statystyki żądań dla każdej minuty.
Version Wersja analityka magazynu, która jest obecnie używana.
Enabled Wskazuje, czy metryki są włączone dla usługi plików.
IncludeAPIs Wskazuje, czy metryki generują statystyki podsumowania dla wywoływanych operacji interfejsu API.
RetentionPolicy/Enabled Wskazuje, czy dla usługi plików włączono zasady przechowywania.
RetentionPolicy/Days Wskazuje liczbę dni przechowywania danych metryk. Wszystkie dane starsze niż ta wartość są usuwane w oparciu o najlepsze nakłady pracy.
Cors Grupuje wszystkie reguły współużytkowania zasobów między źródłami (CORS).
CorsRule Ustawienia grup dla reguły CORS.
AllowedOrigins Rozdzielona przecinkami lista domen pochodzenia dozwolonych za pośrednictwem mechanizmu CORS lub "*", jeśli wszystkie domeny są dozwolone.
ExposedHeaders Rozdzielona przecinkami lista nagłówków odpowiedzi uwidacznianych klientom CORS.
MaxAgeInSeconds Liczba sekund, w których klient lub przeglądarka powinna buforować odpowiedź wstępną.
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 Azure Files dozwolone metody to DELETE, GET, HEAD, MERGE, POST, OPTIONS i PUT.
ShareDeleteRetentionPolicy Właściwości usuwania nietrwałego udziałów plików platformy Azure na tym koncie magazynu.
Days Wskazuje liczbę dni, w których udział plików platformy Azure powinien zostać zachowany (usunięty nietrwale). Minimalna określona wartość może wynosić 1, a maksymalna wartość to 365.
Enabled Wskazuje, czy konto magazynu ma włączone usuwanie nietrwałe dla Azure Files.
ProtocolSettings Grupuje ustawienia protokołów systemu plików.
SMB Grupuje ustawienia bloku komunikatów serwera (SMB).
Multichannel Zawiera ustawienia funkcji SMB Multichannel. To ustawienie ma jedną właściwość: włączone/wyłączone.
Version Dostępne w wersji 2020-04-08. Rozdzielona przecinkami lista dozwolonych wersji protokołu SMB. Możliwe wartości: SMB2.1, SMB3.0i SMB3.1.1. Jeśli Version nie zostanie określony, wartością domyślną jest to, że wszystkie wersje są włączone. Jednak protokół SMB 2.1 jest dostępny tylko wtedy, gdy właściwość konta require secure transit magazynu jest wyłączona, ponieważ protokół SMB 2.1 nie obsługuje szyfrowania.
AuthenticationMethods Dostępne w wersji 2020-04-08. Rozdzielona przecinkami lista dozwolonych metod uwierzytelniania. Możliwe wartości: NTLMv2, Kerberos. Jeśli AuthenticationMethods nie zostanie określony, wartością domyślną jest to, że wszystkie metody uwierzytelniania są dozwolone.
KerberosTicketEncryption Dostępne w wersji 2020-04-08. Rozdzielana przecinkami lista dozwolonych algorytmów szyfrowania biletów Kerberos. Możliwe wartości: RC4-HMAC i AES-256. Jeśli KerberosTicketEncryption nie zostanie określony, domyślnie są obsługiwane wszystkie algorytmy szyfrowania biletów Kerberos.
ChannelEncryption Dostępne w wersji 2020-04-08. Rozdzielona przecinkami lista dozwolonych protokołów szyfrowania kanału SMB. Możliwe wartości: AES-128-CCM, AES-128-GCMi AES-256-GCM. Jeśli ChannelEncryption nie zostanie określony, domyślnie są obsługiwane wszystkie wartości szyfrowania kanału. Jeśli właściwość konta require secure transit magazynu jest wyłączona, dostęp niezaszyfrowanego protokołu SMB jest również dozwolony.

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 plików dla konta magazynu o nazwie myaccount:

Metoda Adres URL Protokół
GET https://myaccount.file.core.windows.net/?restype=service&comp=properties HTTP/1.1

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

x-ms-version: 2020-02-10  
x-ms-date: <date>  
Authorization: SharedKey  
myaccount:Z1lTLDwtq5o1UYQluucdsXk6/iB7YxEu0m6VofAEkUE=  
Host: myaccount.file.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: <date>  
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0  
x-ms-request-id: cb939a31-0cc6-49bb-9fe5-3327691f2a30  
x-ms-version: 2015-04-05

Odpowiedź zawiera następującą treść XML:

<?xml version="1.0" encoding="utf-8"?>  
<StorageServiceProperties>  
    <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>
    <ShareDeleteRetentionPolicy>
        <Enabled>true</Enabled>
        <Days>7</Days>
    </ShareDeleteRetentionPolicy>
    <ProtocolSettings>
        <SMB>
            <Multichannel>
                <Enabled>true</Enabled>
            </Multichannel>
            <Versions>SMB3.1.1</Versions>
            <AuthenticationMethods>Kerberos</AuthenticationMethods>
            <KerberosTicketEncryption>AES-256</KerberosTicketEncryption>
            <ChannelEncryption>AES-256-GCM</ChannelEncryption>
        </SMB>
    </ProtocolSettings>
</StorageServiceProperties>

Uwagi

Aby uzyskać szczegółowe informacje na temat reguł CORS i logiki oceny, zobacz Obsługa mechanizmu CORS dla usług Azure Storage.

Aby uzyskać więcej informacji, zobacz Usługa Storage Analytics.