Obter Estatísticas de Partilha (API FILEREST) - Ficheiros do Azure

Artigo
08/04/2023

O Get Share Stats pedido obtém estatísticas relacionadas com a partilha. Embora esta API seja totalmente suportada, é uma API de gestão legada. Por este motivo, recomendamos que utilize Partilhas de Ficheiros – Get, que é fornecido pelo fornecedor de recursos de armazenamento (Microsoft.Storage).

Para saber mais sobre como interagir programaticamente com recursos com FileShare o fornecedor de recursos de armazenamento, veja Operações em partilhas de Ficheiros do Azure.

Disponibilidade do protocolo

Protocolo de partilha de ficheiros ativado	Disponível
SMB
NFS

Pedir

O Get Share Stats pedido pode ser construído da seguinte forma. Recomendamos que utilize HTTPS. Substitua myaccount pelo nome da sua conta de armazenamento e substitua myshare pelo nome da sua partilha.

Método	URI do pedido	Versão HTTP
GET	`https://myaccount.file.core.windows.net/myshare?restype=share&comp=stats`	HTTP/1.1

Parâmetros do URI

Os seguintes parâmetros adicionais podem ser especificados no URI do pedido:

Parâmetro	Description
`timeout`	Opcional. O parâmetro de tempo limite é expresso em segundos. Para obter mais informações, veja Definir tempos limite para operações de Ficheiros do Azure.

Cabeçalhos do pedido

Os cabeçalhos de pedido obrigatórios e opcionais estão descritos na tabela seguinte:

Cabeçalho do pedido	Description
`Authorization`	Obrigatório. Especifica o esquema de autorização, o nome da conta e a assinatura. Para obter mais informações, veja Autorizar pedidos para o Armazenamento do Azure.
`Date` ou `x-ms-date`	Obrigatório. Especifica a Hora Universal Coordenada (UTC) do pedido. Para obter mais informações, veja Autorizar pedidos para o Armazenamento do Azure.
`x-ms-version`	Necessário para todos os pedidos autorizados. Versão 2015-02-21 e posterior. Especifica a versão da operação a utilizar para este pedido. Para obter mais informações, veja Controlo de versões dos serviços de Armazenamento do Azure.
`x-ms-client-request-id`	Opcional. Fornece um valor opaco gerado pelo cliente com um limite de carateres de 1 kibibyte (KiB) que é registado nos registos quando o registo é configurado. Recomendamos vivamente que utilize este cabeçalho para correlacionar as atividades do lado do cliente com os pedidos que o servidor recebe. Para obter mais informações, veja Monitorizar Ficheiros do Azure.
`x-ms-lease-id:<ID>`	Opcional. Versão 2020-02-10 e posterior. Se o cabeçalho for especificado, a operação só será efetuada se a concessão da partilha de ficheiros estiver atualmente ativa e o ID de concessão especificado no pedido corresponder ao ID de concessão da partilha de ficheiros. Se não houver correspondência, a operação falha com o código de estado 412 (Falha na Pré-condição).

Corpo do pedido

Nenhum.

Resposta

A resposta inclui código de estado HTTP, um conjunto de cabeçalhos de resposta e um corpo de resposta.

Código de estado

Uma operação bem-sucedida devolve o código de estado 200 (OK).

Para obter informações sobre códigos de estado, veja Códigos de estado e de erro.

Cabeçalhos de resposta

A resposta para esta operação inclui os seguintes cabeçalhos. A resposta também pode incluir cabeçalhos HTTP padrão adicionais. Todos os cabeçalhos padrão estão em conformidade com a especificação do protocolo HTTP/1.1.

Cabeçalho de resposta	Descrição
`Last-Modified`	Devolve a data e hora em que a partilha foi modificada pela última vez. O formato de data segue RFC 1123. Para obter mais informações, veja Representar valores de data/hora em cabeçalhos. Qualquer operação que modificou a partilha ou as respetivas propriedades atualiza a hora da última modificação. As operações nos ficheiros não afetam a hora da última modificação da partilha.
`ETag`	Contém um valor que pode utilizar para realizar operações condicionalmente. O valor está entre aspas.
`x-ms-request-id`	Identifica exclusivamente o pedido que foi feito e pode ser utilizado para resolver o pedido. Para obter mais informações, veja Resolver problemas de operações da API.
`x-ms-version`	Indica a versão Ficheiros do Azure que foi utilizada para executar o pedido.
`Date`	Um valor de data/hora UTC gerado pelo serviço, que indica a hora em que a resposta foi iniciada.
`x-ms-client-request-id`	Pode ser utilizado para resolver problemas de pedidos e respostas correspondentes. O valor deste cabeçalho é igual ao valor do `x-ms-client-request-id` cabeçalho se estiver presente no pedido e o valor não contiver mais de 1024 carateres ASCII visíveis. Se o `x-ms-client-request-id` cabeçalho não estiver presente no pedido, não estará presente na resposta.

Corpo da resposta

O formato do corpo da resposta é o seguinte:

<?xml version="1.0" encoding="utf-8"?>  
<ShareStats>  
   <ShareUsageBytes>8189134192</ShareUsageBytes>  
</ShareStats>

Elemento	Descrição
`ShareUsageBytes`	O tamanho aproximado dos dados armazenados na partilha. Tenha em atenção que este valor pode não incluir todos os ficheiros recentemente criados ou redimensionados recentemente.

Autorização

Apenas o proprietário da conta pode chamar esta operação.

Observações

Não é possível obter as estatísticas de um instantâneo de partilha. Se for feita uma tentativa para obter as estatísticas de instantâneo de partilha, o serviço devolve o código de estado 400 (Valor do Parâmetro de Consulta Inválido).

A partir da versão 2018-11-09, o ShareUsage elemento de resposta foi substituído por ShareUsageBytes. ShareUsage é o tamanho aproximado dos dados armazenados na partilha, arredondados até ao gibibyte (GiB) mais próximo.

Ver também

Operações em partilhas de ficheiros do Azure

Partilhar via