Получение свойств службы очередей

Статья
06/27/2023

Операция Get Queue Service Properties получает свойства учетной записи хранилища очередей Azure, включая свойства для Аналитика Службы хранилища и правил общего доступа к ресурсам независимо от источника (CORS).

Дополнительные сведения о правилах общего доступа к ресурсам независимо от источника (CORS) и логике оценки см. в статье Поддержка CORS для служб хранилища Azure.

Запрос

Запрос Get Queue Service Properties можно указать следующим образом. Рекомендуется использовать ПРОТОКОЛ HTTPS. Замените <account-name> именем своей учетной записи хранения:

Метод	Универсальный код ресурса (URI) запроса	параметр "Версия HTTP"
GET	`https://<account-name>.queue.core.windows.net/?restype=service&comp=properties`	HTTP/1.1

Примечание

Универсальный код ресурса (URI) всегда должен содержать символ косой черты (/), чтобы отделить имя узла от частей пути и запроса URI. В этой операции часть пути URI пуста.

Параметры универсального кода ресурса (URI)

В URI запроса можно указать следующие дополнительные параметры:

Параметр	Описание
`restype=service&comp=properties`	Обязательный. Для получения свойств службы хранилища требуется сочетание обеих строк запроса.
`timeout`	Необязательный элемент. Параметр `timeout` указывается в секундах. Дополнительные сведения см. в статье Настройка времени ожидания для операций хранилища очередей Azure.

Заголовки запросов

В следующей таблице перечислены обязательные и необязательные заголовки запросов.

Заголовок запроса	Описание
`Authorization`	Обязательный. Указывает схему авторизации, имя учетной записи хранения и подпись. Дополнительные сведения см. в статье Авторизация запросов к Службе хранилища Azure.
`Date` или `x-ms-date`	Обязательный. Задает время запроса в формате UTC. Дополнительные сведения см. в статье Авторизация запросов к Службе хранилища Azure.
`x-ms-version`	Требуется для всех авторизованных запросов. Задает версию операции, используемой для этого запроса. Дополнительные сведения см. в разделе Управление версиями для служб хранилища Azure.
`x-ms-client-request-id`	Необязательный элемент. Предоставляет созданное клиентом непрозрачное значение с ограничением в 1 кибибайт (КиБ), которое записывается в журналы при настройке ведения журнала. Мы настоятельно рекомендуем использовать этот заголовок для сопоставления действий на стороне клиента с запросами, получаемыми сервером. Дополнительные сведения см. в статье Мониторинг хранилища очередей Azure.

Текст запроса

Нет.

Ответ

Ответ включает код состояния HTTP, набор заголовков ответа и текст ответа.

Код состояния

Успешная операция возвращает код состояния 200 (ОК).

Заголовки ответов

Ответ для этой операции включает следующие заголовки. Ответ может также включать дополнительные стандартные заголовки HTTP. Все стандартные заголовки соответствуют спецификации протокола HTTP/1.1.

Заголовок ответа	Описание
`x-ms-request-id`	Однозначно идентифицирует запрос, выполненный к службе.
`x-ms-version`	Задает версию операции, используемой для ответа. Дополнительные сведения см. в разделе Управление версиями для служб хранилища Azure.
`x-ms-client-request-id`	Может использоваться для устранения неполадок с запросами и соответствующими ответами. Значение этого заголовка равно значению заголовка `x-ms-client-request-id` , если он присутствует в запросе и содержит не более 1024 видимых символов ASCII. Если заголовок `x-ms-client-request-id` отсутствует в запросе, он не будет присутствовать в ответе.

Текст ответа

Текст ответа для версии 2012-02-12 и более ранних имеет следующий формат:

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

В версии 2013-08-15 формат текста ответа выглядит следующим образом:

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

Элементы основного текста ответа описываются в следующей таблице.

Имя элемента	Описание
Logging	Группирует параметры Аналитика Службы хранилища ведения журнала.
Метрики	Группирует параметры метрик Аналитика Службы хранилища. Параметры Metrics предоставляют сводку статистики запросов, сгруппированную по API в почасовую статистику для очередей.
HourMetrics	Группирует параметры Аналитика Службы хранилища HourMetrics. Параметры HourMetrics предоставляют сводку статистики запросов, сгруппированную по API в почасовую статистику для очередей.
MinuteMetrics	Группирует параметры Аналитика Службы хранилища MinuteMetrics. Параметры MinuteMetrics* предоставляют статистику запроса на каждую минуту для очередей.
Версия	Версия Аналитика Службы хранилища, которая используется в настоящее время.
Удалить	Применяется только к конфигурации ведения журнала. Указывает, вносятся ли в журнал запросы удаления.
Чтение	Применяется только к конфигурации ведения журнала. Указывает, вносятся ли в журнал запросы чтения.
запись	Применяется только к конфигурации ведения журнала. Указывает, вносятся ли в журнал запросы записи.
Enabled	Указывает, включены ли метрики для хранилища очередей Azure. Если географически избыточная репликация с доступом для чтения включена, то будет вестись сбор как первичных, так и вторичных показателей. Если географически избыточная репликация с доступом для чтения не включена, то будет вестись сбор только первичных показателей.
IncludeAPIs	Применяется только к настройкам метрики. Указывает, должны ли метрики сформировать сводную статистику для вызываемых операций API-интерфейса.
RetentionPolicy/Enabled	Указывает, включена ли политика сохранения для службы хранилища.
RetentionPolicy/Days	Указывает число дней, в течение которых данные метрики или журнала будут сохраняться. Данные, которые старше указанного значения, удаляются.
Cors	Группирует все правила CORS.
элемент	Группирует параметры для правил CORS.
AllowedOrigins	Разделенный запятыми список исходных доменов, разрешенных через CORS, или звездочка (*), если все домены разрешены.
ExposedHeaders	Список заголовков ответов с разделителями-запятыми для предоставления клиентам CORS.
MaxAgeInSeconds	Количество секунд, в течение которых клиент или браузер должны кэшировать предварительный ответ.
AllowedHeaders	Разделенный запятыми список заголовков, которые могут быть частью запроса между источниками.
AllowedMethods	Список методов HTTP с разделителями-запятыми, которые разрешено выполнять источником. Для службы хранилища Azure допустимыми методами являются DELETE, GET, HEAD, MERGE, POST, OPTIONS или PUT.

Авторизация

Эту операцию может вызвать только владелец учетной записи хранилища.

Пример запроса и ответа

Следующий пример URI применяется для выполнения запроса на получение свойств службы очередей для вымышленной учетной записи хранилища с именем myaccount:

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

Запрос отправляется со следующими заголовками:

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

После отправки запроса возвращается следующий ответ:

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

Текст ответа подобен следующему:

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

См. также раздел

Аналитика службы хранилища
Поддержка CORS для служб хранилища Azure
Спецификация CORS HTTP