Recuperar dados de uso de um provedor de recursos
Aplica-se a: Windows Azure Pack
Recupera dados de uso de um provedor de recursos.
Solicitação
Substitua <UsageEndpoint> pelo endereço do ponto de extremidade do Windows API REST de uso do Provedor de Recursos Personalizado do Azure Pack.
Método |
URI da solicitação |
Versão HTTP |
|---|---|---|
GET |
<https:// UsageEndpoint>/usage |
HTTP/1.1 |
Parâmetros de URI
A tabela a seguir descreve os parâmetros de URI.
Parâmetro do URI |
Descrição |
|---|---|
lastID |
A ID do último registro recebido pelo coletor de uso. O parâmetro lastID está vazio para a primeira solicitação. Essa é uma confirmação de que o coletor de uso reconhece os registros anteriores e, portanto, pode excluí-los. |
BatchSize |
O número de novos registros a serem enviados para o coletor de uso. Os novos registros são aqueles que seguem o registro identificado pelo parâmetro lastID . O provedor de recursos pode enviar um lote menor do que o solicitado, mas não um maior. |
Cabeçalhos de solicitação
A tabela a seguir descreve os cabeçalhos de solicitação obrigatórios e opcionais.
Cabeçalho da solicitação |
Descrição |
|---|---|
Autorização: Portador |
Obrigatórios. O token de portador de autorização. |
x-ms-principal-id |
Obrigatórios. O identificador principal. |
x-ms-client-request-id |
Opcional. O identificador de solicitação do cliente. |
x-ms-client-session-id |
Opcional. O identificador de sessão do cliente. |
x-ms-principal-liveid |
Opcional. O principal identificador ao vivo. |
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 Status e Códigos de Erro (Windows Gerenciamento de Serviços do Azure Pack).
Cabeçalhos de resposta
A resposta para essa operação inclui cabeçalhos HTTP padrão. Todos os cabeçalhos padrão estão em conformidade com a especificação do protocolo HTTP/1.1.
Corpo da resposta
A tabela a seguir descreve os principais elementos do corpo da resposta:
Nome do elemento |
Descrição |
|---|---|
EventId |
Obrigatórios. Um identificador exclusivo que representa cada registro de uso. Esse valor corresponderá ao do parâmetro URI lastID . |
ResourceId |
Opcional. Se o provedor de recursos tiver vários recursos para uma única assinatura e o uso estiver sendo agregado um recurso, esse campo poderá ser usado para especificar o nome do recurso. Se o uso estiver sendo agregado pela ID da assinatura, esse elemento não será usado. |
StartTime |
Obrigatórios. Indica quando a coleta de dados de uso foi iniciada. |
EndTime |
Obrigatórios. Indica quando a coleta de dados de uso terminou. |
ServiceType |
Obrigatórios. A camada de serviço consumida. |
SubscriptionId |
Obrigatórios. O identificador de assinatura para o qual os dados de uso foram coletados. (GUID). |
Propriedades |
Opcional. Um dicionário de pares nome-valor usado para passar informações adicionais sobre o uso. |
Recursos |
Obrigatórios. Um dicionário de pares nome-valor que representa os recursos alocados ou consumidos. Por exemplo, um provedor de recursos SQL pode ter espaço total e contagem de banco de dados como suas métricas. |
Comentários
Recuperar dados de uso de um provedor de recursos é chamado periodicamente pelo Coletor de Uso para coletar as informações de uso do provedor de recursos. Essas informações podem ser usadas para gerar custos de cobrança para o uso do provedor de recursos. Para obter mais informações, pontos de extremidade do provedor de recursos personalizados. Para obter mais informações sobre o Windows Serviço de Uso do Azure Pack, consulte Windows Serviço de Uso do Azure Pack.
Consulte Também
Windows referência da API REST de Uso do Provedor de Recursos Personalizado do Azure Pack