Obter estatísticas de compartilhamento (API FileREST) – Arquivos do Azure

Artigo
07/19/2023

A Get Share Stats solicitação recupera estatísticas relacionadas ao compartilhamento. Embora essa API tenha suporte total, ela é uma API de gerenciamento herdada. Por esse motivo, recomendamos que você use Compartilhamentos de Arquivos – Get, que é fornecido pelo provedor de recursos de armazenamento (Microsoft.Storage).

Para saber mais sobre como interagir programaticamente com FileShare recursos usando o provedor de recursos de armazenamento, consulte Operações em compartilhamentos de Arquivos do Azure.

Disponibilidade do protocolo

Protocolo de compartilhamento de arquivos habilitado	Disponível
SMB
NFS

Solicitação

A solicitação Get Share Stats pode ser criada da seguinte maneira. Recomendamos que você use HTTPS. Substitua myaccount pelo nome da sua conta de armazenamento e substitua myshare pelo nome do seu compartilhamento.

Método	URI da solicitação	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 de solicitação:

Parâmetro	Descrição
`timeout`	Opcional. O parâmetro timeout é expresso em segundos. Para obter mais informações, consulte Definir tempos limite para operações de Arquivos do Azure.

Cabeçalhos da solicitação

Os cabeçalhos de solicitação obrigatórios e opcionais são descritos na tabela a seguir:

Cabeçalho da solicitação	Descrição
`Authorization`	Obrigatórios. Especifica o esquema de autorização, o nome da conta e a assinatura. Para saber mais, confira Autorizar solicitações para o Armazenamento do Azure.
`Date` ou `x-ms-date`	Obrigatórios. Especifica o UTC (Tempo Universal Coordenado) para a solicitação. Para saber mais, confira Autorizar solicitações para o Armazenamento do Azure.
`x-ms-version`	Necessário para todas as solicitações autorizadas. Versão 2015-02-21 e posterior. Especifica a versão da operação a ser usada para esta solicitação. Para obter mais informações, consulte Controle de versão para os Serviços de Armazenamento do Azure.
`x-ms-client-request-id`	Opcional. Fornece um valor opaco gerado pelo cliente com um limite de caracteres kib (1 kibibyte) que é registrado nos logs quando o registro em log é configurado. É altamente recomendável que você use esse cabeçalho para correlacionar atividades do lado do cliente com solicitações recebidas pelo servidor. Para obter mais informações, consulte Monitorar Arquivos do Azure.
`x-ms-lease-id:<ID>`	Opcional. Versão 2020-02-10 e posterior. Se o cabeçalho for especificado, a operação será executada somente se a concessão do compartilhamento de arquivos estiver ativa no momento e a ID de concessão especificada na solicitação corresponder à ID de concessão do compartilhamento de arquivo. Se não houver correspondência, a operação falhará com status código 412 (Falha na pré-condição).

Corpo da solicitação

Nenhum.

Resposta

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

Código de status

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

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

Cabeçalhos de resposta

A resposta para esta operação inclui os cabeçalhos a seguir. 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`	Retorna a data e a hora em que o compartilhamento foi modificado pela última vez. O formato da data segue RFC 1123. Para obter mais informações, consulte Representar valores de data/hora em cabeçalhos. Qualquer operação que modifique o compartilhamento ou suas propriedades atualiza a hora da última modificação. As operações nos arquivos não afetam a hora da última modificação do compartilhamento.
`ETag`	Contém um valor que você pode usar para executar operações condicionalmente. O valor é colocado entre aspas.
`x-ms-request-id`	Identifica exclusivamente a solicitação que foi feita e pode ser usada para solucionar problemas da solicitação. Para obter mais informações, consulte Solucionar problemas de operações de API.
`x-ms-version`	Indica a versão Arquivos do Azure que foi usada para executar a solicitação.
`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 usado para solucionar problemas de solicitações e suas respostas correspondentes. O valor desse cabeçalho será igual ao valor do `x-ms-client-request-id` cabeçalho se ele estiver presente na solicitação e o valor não contiver mais de 1.024 caracteres ASCII visíveis. Se o `x-ms-client-request-id` cabeçalho não estiver presente na solicitação, ele não estará presente na resposta.

Corpo da resposta

Formato do corpo da resposta:

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

Elemento	Descrição
`ShareUsageBytes`	O tamanho aproximado dos dados armazenados no compartilhamento. Observe que esse valor pode não incluir todos os arquivos recém-criados ou redimensionados recentemente.

Autorização

Somente o proprietário da conta pode chamar essa operação.

Comentários

As estatísticas de um compartilhamento instantâneo não podem ser recuperadas. Se for feita uma tentativa de recuperar o compartilhamento instantâneo estatísticas, o serviço retornará status código 400 (valor de parâmetro de consulta inválido).

A partir da versão 2018-11-09, o ShareUsage elemento de resposta foi substituído ShareUsageBytespor . ShareUsage é o tamanho aproximado dos dados armazenados no compartilhamento, arredondados para cima até o gibibyte mais próximo (GiB).

Confira também

Operações em compartilhamentos de arquivos do Azure

Compartilhar via