Obter as métricas de uso do Load Balancer usando a API REST do Azure

  • Artigo

Colete o número de bytes processados por um Standard Load Balancer em um intervalo de tempo usando a API REST do Azure.

A documentação de referência completa e mais exemplos da API REST estão disponíveis na referência REST do Azure Monitor.

Criar a solicitação

Use a seguinte solicitação GET para coletar a métrica ByteCount de um Standard Load Balancer.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/providers/microsoft.insights/metrics?api-version=2018-01-01&metricnames=ByteCount&timespan=2018-06-05T03:00:00Z/2018-06-07T03:00:00Z

Cabeçalhos da solicitação

Os cabeçalhos a seguir são necessários:

Cabeçalho da solicitação Descrição
Tipo de Conteúdo: Obrigatórios. Defina como application/json.
Autorização: Obrigatórios. Defina como um Bearertoken de acesso válido.

Parâmetros do URI

Nome Descrição
subscriptionId A ID de assinatura que identifica uma assinatura do Azure. Se você tiver várias assinaturas, consulte Trabalhando com várias assinaturas.
resourceGroupName O nome do grupo de recursos que contém o recurso. Você pode obter esse valor por meio da API do Azure Resource Manager, da CLI ou do portal.
loadBalancerName O nome do Azure Load Balancer.
nomes de métrica Lista separada por vírgulas de métricas válidas do Load Balancer.
api-version A versão da API a ser usada para a solicitação.

Este documento abrange a versão da API 2018-01-01, incluída na URL acima.
TimeSpan O período de tempo da consulta. É uma cadeia de caracteres com o seguinte formato startDateTime_ISO/endDateTime_ISO. Este parâmetro opcional está configurado para retornar dados de um dia no exemplo.
   

Corpo da solicitação

Nenhum corpo de solicitação é necessário para esta operação.

Tratar da resposta

O código de status 200 é retornado quando a lista de valores da métrica é retornada com êxito. Uma lista completa de códigos de erro está disponível na documentação de referência.

Exemplo de resposta

{
    "cost": 0,
    "timespan": "2018-06-05T03:00:00Z/2018-06-07T03:00:00Z",
    "interval": "PT1M",
    "value": [
        {
            "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/providers/Microsoft.Insights/metrics/ByteCount",
            "type": "Microsoft.Insights/metrics",
            "name": {
                "value": "ByteCount",
                "localizedValue": "Byte Count"
            },
            "unit": "Count",
            "timeseries": [
                {
                    "metadatavalues": [],
                    "data": [
                        {
                            "timeStamp": "2018-06-06T17:24:00Z",
                            "total": 1067921034.0
                        },
                        {
                            "timeStamp": "2018-06-06T17:25:00Z",
                            "total": 0.0
                        },
                        {
                            "timeStamp": "2018-06-06T17:26:00Z",
                            "total": 3781344.0
                        },
                    ]
                }
            ]
        }
    ],
    "namespace": "Microsoft.Network/loadBalancers",
    "resourceregion": "eastus"
}