Eigenschappen van wachtrijservice ophalen

Artikel
06/27/2023

Met Get Queue Service Properties de bewerking worden de eigenschappen van een Azure Queue Storage-account opgehaald, inclusief eigenschappen voor Opslaganalyse en CORS-regels (Cross-Origin Resource Sharing).

Zie CORS-ondersteuning voor de Azure Storage-services voor meer informatie over CORS-regels (Cross-Origin Resource Sharing) en evaluatielogica.

Aanvraag

De Get Queue Service Properties aanvraag kan als volgt worden opgegeven. U wordt aangeraden HTTPS te gebruiken. Vervang accountnaam> door <de naam van uw opslagaccount:

Methode	Aanvraag-URI	HTTP-versie
GET	`https://<account-name>.queue.core.windows.net/?restype=service&comp=properties`	HTTP/1.1

Notitie

De URI moet altijd een slash (/) bevatten om de hostnaam te scheiden van het pad en de querygedeelten van de URI. In deze bewerking is het padgedeelte van de URI leeg.

URI-parameters

De volgende aanvullende parameters kunnen worden opgegeven voor de aanvraag-URI:

Parameter	Beschrijving
`restype=service&comp=properties`	Vereist. De combinatie van beide queryreeksen is vereist om de eigenschappen van de opslagservice op te halen.
`timeout`	Optioneel. De `timeout` parameter wordt uitgedrukt in seconden. Zie Time-outs instellen voor Azure Queue Storage-bewerkingen voor meer informatie.

Aanvraagheaders

In de volgende tabel worden vereiste en optionele aanvraagheaders beschreven.

Aanvraagheader	Beschrijving
`Authorization`	Vereist. Hiermee geeft u het autorisatieschema, de naam van het opslagaccount en de handtekening op. Zie Aanvragen autoriseren voor Azure Storage voor meer informatie.
`Date` of `x-ms-date`	Vereist. Geef de Coordinated Universal Time (UTC) op voor de aanvraag. Zie Aanvragen autoriseren voor Azure Storage voor meer informatie.
`x-ms-version`	Vereist voor alle geautoriseerde aanvragen. Hiermee geeft u de versie van de bewerking te gebruiken voor deze aanvraag. Zie Versiebeheer voor de Azure Storage-services voor meer informatie.
`x-ms-client-request-id`	Optioneel. Biedt een door de client gegenereerde, ondoorzichtige waarde met een limiet van 1 kibibyte (KiB) die wordt vastgelegd in de logboeken wanneer logboekregistratie is geconfigureerd. We raden u ten zeerste aan deze header te gebruiken om activiteiten aan de clientzijde te correleren met aanvragen die de server ontvangt. Zie Azure Queue Storage bewaken voor meer informatie.

Aanvraagbody

Geen.

Antwoord

Het antwoord bevat een HTTP-statuscode, een set antwoordheaders en een antwoordtekst.

Statuscode

Een geslaagde bewerking retourneert statuscode 200 (OK).

Antwoordheaders

Het antwoord voor deze bewerking bevat de volgende headers. Het antwoord kan ook aanvullende standaard-HTTP-headers bevatten. Alle standaardheaders voldoen aan de HTTP/1.1-protocolspecificatie.

Antwoordheader	Beschrijving
`x-ms-request-id`	Identificeert op unieke wijze een aanvraag die is ingediend tegen de service.
`x-ms-version`	Hiermee geeft u de versie op van de bewerking die wordt gebruikt voor het antwoord. Zie Versiebeheer voor de Azure Storage-services voor meer informatie.
`x-ms-client-request-id`	Kan worden gebruikt om problemen met aanvragen en bijbehorende antwoorden op te lossen. De waarde van deze header is gelijk aan de waarde van de `x-ms-client-request-id` header als deze aanwezig is in de aanvraag en de waarde niet meer dan 1024 zichtbare ASCII-tekens bevat. Als de `x-ms-client-request-id` header niet aanwezig is in de aanvraag, is deze niet aanwezig in het antwoord.

Hoofdtekst van de reactie

Voor versie 2012-02-12 en eerder is de indeling van de antwoordtekst als volgt:

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

Vanaf versie 2013-08-15 is de indeling van de antwoordtekst als volgt:

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

De elementen van de hoofdtekst van het antwoord worden beschreven in de volgende tabel:

Naam van element	Beschrijving
Logboekregistratie	Groepeert de Opslaganalyse instellingen voor logboekregistratie.
Metrische gegevens	Hiermee worden de instellingen voor metrische gegevens Opslaganalyse gegroepeerd. De instellingen voor metrische gegevens bieden een overzicht van aanvraagstatistieken gegroepeerd per API in aggregaties per uur voor wachtrijen.
HourMetrics	Groepeert de instellingen Opslaganalyse HourMetrics. De HourMetrics-instellingen bieden een overzicht van aanvraagstatistieken gegroepeerd per API in aggregaties per uur voor wachtrijen.
MinuteMetrics	Groepeert de instellingen Opslaganalyse MinuteMetrics. De MinuteMetrics-instellingen* bieden aanvraagstatistieken voor elke minuut voor wachtrijen.
Versie	De versie van Opslaganalyse die momenteel in gebruik is.
Verwijderen	Is alleen van toepassing op de configuratie voor logboekregistratie. Hiermee wordt aangegeven of verwijderingsaanvragen worden geregistreerd.
Lezen	Is alleen van toepassing op de configuratie voor logboekregistratie. Hiermee wordt aangegeven of leesaanvragen worden geregistreerd.
Schrijven	Is alleen van toepassing op de configuratie voor logboekregistratie. Hiermee wordt aangegeven of schrijfaanvragen worden geregistreerd.
Ingeschakeld	Hiermee wordt aangegeven of metrische gegevens zijn ingeschakeld voor Azure Queue Storage. Als geografisch redundante replicatie met leestoegang is ingeschakeld, worden zowel primaire als secundaire metrische gegevens verzameld. Als geografisch redundante replicatie met leestoegang niet is ingeschakeld, worden alleen primaire metrische gegevens verzameld.
IncludeAPIs	Is alleen van toepassing op de configuratie van metrische gegevens. Geeft aan of metrische gegevens samenvattingsstatistieken genereren voor aangeroepen API-bewerkingen.
RetentionPolicy/Ingeschakeld	Hiermee wordt aangegeven of een bewaarbeleid is ingeschakeld voor de opslagservice.
RetentionPolicy/dagen	Geeft het aantal dagen aan dat metrische gegevens of logboekgegevens worden bewaard. Alle gegevens die ouder zijn dan deze waarde, worden verwijderd.
Cors	Alle CORS-regels groepeert.
CorsRule	Groepeert instellingen voor een CORS-regel.
AllowedOrigins	Een door komma's gescheiden lijst met oorsprongsdomeinen die zijn toegestaan via CORS, of een sterretje (*) als alle domeinen zijn toegestaan.
ExposedHeaders	Een door komma's gescheiden lijst met antwoordheaders om beschikbaar te maken voor CORS-clients.
MaxAgeInSeconds	Het aantal seconden dat de client of browser een preflight-reactie in de cache moet opslaan.
AllowedHeaders	Een door komma's gescheiden lijst met kopteksten die deel mogen uitmaken van de cross-origin-aanvraag.
AllowedMethods	Een door komma's gescheiden lijst met HTTP-methoden die door de oorsprong mogen worden uitgevoerd. Voor Azure Storage zijn toegestane methoden DELETE, GET, HEAD, MERGE, POST, OPTIONS of PUT.

Autorisatie

Alleen de eigenaar van het opslagaccount kan deze bewerking aanroepen.

Voorbeeld van aanvraag en antwoord

Met de volgende voorbeeld-URI wordt een aanvraag ingediend om de eigenschappen van de Queue-service op te halen voor het fictieve opslagaccount met de naam myaccount:

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

De aanvraag wordt verzonden met de volgende headers:

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

Nadat de aanvraag is verzonden, wordt het volgende antwoord geretourneerd:

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

De hoofdtekst van het antwoord ziet er ongeveer als volgt uit:

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

Zie ook

Storage Analytics
CORS-ondersteuning voor de Azure Storage-services
CORS HTTP-specificatie