Hämta kötjänstegenskaper

Artikel
06/27/2023

Åtgärden Get Queue Service Properties hämtar egenskaperna för ett Azure Queue Storage-konto, inklusive egenskaper för Lagringsanalys och CORS-regler (cross-origin resource sharing).

Mer information om CORS-regler (cross-origin resource sharing) och utvärderingslogik finns i CORS-stöd för Azure Storage-tjänsterna.

Förfrågan

Begäran Get Queue Service Properties kan anges på följande sätt. Vi rekommenderar att du använder HTTPS. Ersätt <kontonamnet> med namnet på ditt lagringskonto:

Metod	URI för förfrågan	HTTP-version
GET	`https://<account-name>.queue.core.windows.net/?restype=service&comp=properties`	HTTP/1.1

Anteckning

URI:n måste alltid innehålla ett snedstreck (/) för att skilja värdnamnet från sökvägen och frågedelarna i URI:n. I den här åtgärden är sökvägsdelen av URI:n tom.

URI-parametrar

Följande ytterligare parametrar kan anges i begärande-URI:n:

Parameter	Beskrivning
`restype=service&comp=properties`	Krävs. Kombinationen av båda frågesträngarna krävs för att hämta egenskaperna för lagringstjänsten.
`timeout`	Valfritt. Parametern `timeout` uttrycks i sekunder. Mer information finns i Ange tidsgränser för Azure Queue Storage-åtgärder.

Begärandehuvuden

I följande tabell beskrivs obligatoriska och valfria begärandehuvuden.

Begärandehuvud	Beskrivning
`Authorization`	Krävs. Anger auktoriseringsschema, lagringskontonamn och signatur. Mer information finns i Auktorisera begäranden till Azure Storage.
`Date` eller `x-ms-date`	Krävs. Anger Coordinated Universal Time (UTC) för begäran. Mer information finns i Auktorisera begäranden till Azure Storage.
`x-ms-version`	Krävs för alla auktoriserade begäranden. Anger vilken version av åtgärden som ska användas för den här begäran. Mer information finns i Versionshantering för Azure Storage-tjänsterna.
`x-ms-client-request-id`	Valfritt. Tillhandahåller ett klientgenererat, täckande värde med en teckengräns på 1 kibibyte (KiB) som registreras i loggarna när loggningen har konfigurerats. Vi rekommenderar starkt att du använder det här huvudet för att korrelera aktiviteter på klientsidan med begäranden som servern tar emot. Mer information finns i Övervaka Azure Queue Storage.

Begärandetext

Inga.

Svarsåtgärder

Svaret innehåller en HTTP-statuskod, en uppsättning svarshuvuden och en svarstext.

Statuskod

En lyckad åtgärd returnerar statuskoden 200 (OK).

Svarshuvuden

Svaret för den här åtgärden innehåller följande rubriker. Svaret kan också innehålla ytterligare HTTP-standardhuvuden. Alla standardhuvuden överensstämmer med HTTP/1.1-protokollspecifikationen.

Svarsrubrik	Description
`x-ms-request-id`	Identifierar unikt en begäran mot tjänsten.
`x-ms-version`	Anger vilken version av åtgärden som används för svaret. Mer information finns i Versionshantering för Azure Storage-tjänsterna.
`x-ms-client-request-id`	Kan användas för att felsöka begäranden och motsvarande svar. Värdet för det här huvudet är lika med värdet `x-ms-client-request-id` för huvudet om det finns i begäran och värdet inte innehåller fler än 1 024 synliga ASCII-tecken. `x-ms-client-request-id` Om rubriken inte finns i begäran visas den inte i svaret.

Själva svaret

För version 2012-02-12 och tidigare är formatet för svarstexten följande:

<?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>

Från och med version 2013-08-15 är formatet för svarstexten följande:

<?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>

Elementen i svarstexten beskrivs i följande tabell:

Elementnamn	Description
Loggning	Grupperar inställningarna för Lagringsanalys loggning.
Mått	Grupperar inställningarna för Lagringsanalys mått. Inställningarna för mått ger en sammanfattning av begärandestatistik grupperad efter API i timaggregeringar för köer.
HourMetrics	Grupperar inställningarna för Lagringsanalys HourMetrics. HourMetrics-inställningarna ger en sammanfattning av begärandestatistik grupperad efter API i timaggregeringar för köer.
MinuteMetrics	Grupperar inställningarna för Lagringsanalys MinuteMetrics. MinuteMetrics-inställningarna* tillhandahåller begärandestatistik för varje minut för köer.
Version	Den version av Lagringsanalys som används för närvarande.
Ta bort	Gäller endast för loggningskonfigurationen. Anger om borttagningsbegäranden loggas.
Läsa	Gäller endast för loggningskonfigurationen. Anger om läsbegäranden loggas.
Skriva	Gäller endast för loggningskonfigurationen. Anger om skrivbegäranden loggas.
Aktiverad	Anger om mått är aktiverade för Azure Queue Storage. Om geo-redundant replikering med läsåtkomst är aktiverad samlas både primära och sekundära mått in. Om geo-redundant replikering med läsåtkomst inte är aktiverad samlas endast primära mått in.
IncludeAPIs	Gäller endast för måttkonfiguration. Anger om mått genererar sammanfattningsstatistik för kallade API-åtgärder.
RetentionPolicy/Aktiverad	Anger om en kvarhållningsprincip är aktiverad för lagringstjänsten.
RetentionPolicy/Days	Anger hur många dagar som mått eller loggningsdata ska behållas. Alla data som är äldre än det här värdet tas bort.
Cors	Grupperar alla CORS-regler.
CorsRule	Gruppinställningar för en CORS-regel.
AllowedOrigins	En kommaavgränsad lista över ursprungsdomäner som tillåts via CORS eller en asterisk (*) om alla domäner tillåts.
ExposedHeaders	En kommaavgränsad lista över svarshuvuden som ska exponeras för CORS-klienter.
MaxAgeInSeconds	Antalet sekunder som klienten eller webbläsaren ska cachelagrat ett förinställt svar.
AllowedHeaders	En kommaavgränsad lista med rubriker som tillåts vara en del av begäran om korsande ursprung.
AllowedMethods	En kommaavgränsad lista över HTTP-metoder som kan köras av ursprunget. För Azure Storage är tillåtna metoder DELETE, GET, HEAD, MERGE, POST, OPTIONS eller PUT.

Auktorisering

Endast lagringskontoägaren kan anropa den här åtgärden.

Exempel på begäran och svar

Följande exempel-URI gör en begäran om att hämta kötjänstegenskaperna för det fiktiva lagringskontot med namnet myaccount:

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

Begäran skickas med följande rubriker:

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

När begäran har skickats returneras följande svar:

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

Svarstexten liknar följande:

<?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>

Se även

Lagringsanalys
CORS-stöd för Azure Storage-tjänsterna
CORS HTTP-specifikation

Dela via