你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
获取队列服务属性
该Get Queue Service Properties
操作获取 Azure 队列存储帐户的属性,包括存储分析和跨域资源共享的属性, (CORS) 规则。
有关跨域资源共享 (CORS) 规则和评估逻辑的详细信息,请参阅 Azure 存储服务的 CORS 支持。
请求
可以按以下方式指定 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-kibite (KiB) 配置日志记录时记录在日志中的字符限制。 强烈建议使用此标头将客户端活动与服务器接收的请求相关联。 有关详细信息,请参阅 监视 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 并且该值包含的可见 ASCII 字符不超过 1,024 个,则此标头的值等于标头的值。
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>
下表描述了响应正文的元素:
元素名称 | 说明 |
---|---|
日志记录 | 对存储分析日志记录设置进行分组。 |
度量值 | 对存储分析指标设置进行分组。 Metrics 设置汇总了队列的每小时聚合中按 API 分组的请求统计信息。 |
HourMetrics | 对 存储分析 HourMetrics 设置进行分组。 HourMetrics 设置汇总了队列的每小时聚合中按 API 分组的请求统计信息。 |
MinuteMetrics | 对 存储分析 MinuteMetrics* 设置进行分组。 MinuteMetrics 设置提供了队列每分钟的请求统计信息。 |
版本 | 当前正在使用的 存储分析 版本。 |
删除 | 仅适用于日志记录配置。 指示是否将记录删除请求。 |
读取 | 仅适用于日志记录配置。 指示是否将记录读取请求。 |
写入 | 仅适用于日志记录配置。 指示是否将记录写入请求。 |
已启用 | 指示是否为 Azure 队列存储启用指标。 如果启用了读访问的地域冗余复制,则同时收集主度量值和辅助度量值。 如果未启用读访问的地域冗余复制,则仅收集主度量值。 |
IncludeAPIs | 仅适用于度量值配置。 指示度量值是否为调用的 API 操作生成汇总统计信息。 |
RetentionPolicy/Enabled | 指示是否为存储服务启用保留策略。 |
RetentionPolicy/Days | 指示保留度量值或日志记录数据的天数。 将删除早于该值的所有数据。 |
Cors | 对所有 CORS 规则进行分组。 |
CorsRule | 对 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>