Partilhar via


Baselines - List

Lista os valores da linha de base métrica para um recurso.

GET https://management.azure.com/{resourceUri}/providers/Microsoft.Insights/metricBaselines?api-version=2019-03-01
GET https://management.azure.com/{resourceUri}/providers/Microsoft.Insights/metricBaselines?metricnames={metricnames}&metricnamespace={metricnamespace}&timespan={timespan}&interval={interval}&aggregation={aggregation}&sensitivities={sensitivities}&$filter={$filter}&resultType={resultType}&api-version=2019-03-01

Parâmetros do URI

Name Em Necessário Tipo Description
resourceUri
path True

string

O identificador do recurso.

api-version
query True

string

minLength: 1

A versão da API a ser usada para esta operação.

$filter
query

string

O $filter é usado para reduzir o conjunto de dados métricos retornados. Exemplo: A métrica contém metadados A, B e C. - Retornar todas as séries temporais de C onde A = a1 e B = b1 ou b2 $filter=A eq 'a1' e B eq 'b1' ou B eq 'b2' e C eq '*' - Variante inválida: $filter=A eq 'a1' e B eq 'b1' e C eq '*' ou B = 'b2' Isso é inválido porque o lógico ou operador não pode separar dois nomes de metadados diferentes. - Retornar todas as séries temporais onde A = a1, B = b1 e C = c1: $filter=A eq 'a1' e B eq 'b1' e C eq 'c1' - Retornar todas as séries temporais onde A = a1 $filter=A eq 'a1' e B eq '' e C eq ''. Caso especial: Quando o nome da dimensão ou o valor da dimensão usa colchetes redondos. Por exemplo: Quando o nome da dimensão é dim (teste) 1 Em vez de usar $filter= "dim (teste) 1 eq '' " use **$filter= "dim %2528test%2529 1 eq '' "** Quando o nome da dimensão é dim (teste) 3 e o valor da dimensão é dim3 (teste) val Em vez de usar $filter= "dim (teste) 3 eq 'dim3 (teste) val' " use $filter= "dim %2528test%2529 3 eq 'dim3 %2528test%2529 val' "

aggregation
query

string

A lista de tipos de agregação (separados por vírgula) a serem recuperados.

interval
query

string (duration)

O intervalo (ou seja, timegrain) da consulta.

metricnames
query

string

Os nomes das métricas (separadas por vírgula) a serem recuperadas. Caso especial: Se um nome métrico em si tiver uma vírgula, use %2 para indicá-lo. Por exemplo: 'Metric,Name1' deve ser 'Metric%2Name1'

metricnamespace
query

string

Namespace de métrica que contém os nomes de métricas solicitados.

resultType
query

ResultType

Permite recuperar apenas metadados da linha de base. Na solicitação de dados, todas as informações são recuperadas.

sensitivities
query

string

A lista de sensibilidades (separadas por vírgula) a recuperar.

timespan
query

string

O período de tempo da consulta. É uma string com o seguinte formato 'startDateTime_ISO/endDateTime_ISO'.

Respostas

Name Tipo Description
200 OK

MetricBaselinesResponse

Solicitação bem-sucedida para obter a lista de valores de linha de base métrica.

Other Status Codes

ErrorResponse

Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

Get metric baselines

Pedido de amostra

GET https://management.azure.com/subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourceGroups/vms/providers/Microsoft.Compute/virtualMachines/vm1/providers/Microsoft.Insights/metricBaselines?timespan=2019-03-12T11:00:00.000Z/2019-03-12T12:00:00.000Z&interval=PT1H&aggregation=average&sensitivities=Low,Medium&api-version=2019-03-01

Resposta da amostra

{
  "value": [
    {
      "id": "/subscriptions/11aeb0ed-456b-4ca0-8df5-b9fbdc63d0d3/resourceGroups/SmartAnalytics-DEV-VM/providers/Microsoft.Compute/virtualMachines/DemoVM1/providers/microsoft.insights/metricBaselines/Percentage CPU",
      "type": "microsoft.insights/metricBaselines",
      "name": "Percentage CPU",
      "properties": {
        "interval": "PT1H",
        "timespan": "2019-03-12T11:00:00.000Z/2019-03-12T12:00:00.000Z",
        "namespace": "microsoft.compute/virtualmachines",
        "baselines": [
          {
            "aggregation": "average",
            "dimensions": [],
            "metadataValues": [
              {
                "name": "ErrorType",
                "value": "TooManyAnomalies"
              },
              {
                "name": "SeasonalityFrequency",
                "value": "288"
              }
            ],
            "timestamps": [
              "2019-03-12T11:00:00.000Z",
              "2019-03-12T12:00:00.000Z"
            ],
            "data": [
              {
                "sensitivity": "Low",
                "lowThresholds": [
                  30,
                  31.1
                ],
                "highThresholds": [
                  90.3453,
                  91.3453
                ]
              },
              {
                "sensitivity": "Medium",
                "lowThresholds": [
                  50,
                  51.1
                ],
                "highThresholds": [
                  70.3453,
                  71.3453
                ]
              }
            ]
          }
        ]
      }
    }
  ]
}

Definições

Name Description
AdditionalInfo

Uma matriz de objetos com propriedades 'type' e 'info'. O esquema de 'info' é específico do serviço e depende da cadeia de caracteres 'type'.

BaselineMetadata

Representa um valor de metadados da linha de base.

BaselineSensitivity

a sensibilidade dos valores basais.

Error
ErrorDetail

Descreve os detalhes de uma resposta de erro.

ErrorResponse

Descreve o formato de Resposta de erro.

MetricBaselinesResponse

Uma lista de linhas de base métricas.

MetricSingleDimension

O nome e o valor da dimensão métrica.

ResultType

Permite recuperar apenas metadados da linha de base. Na solicitação de dados, todas as informações são recuperadas.

SingleBaseline

Os valores basais para um único valor de sensibilidade.

SingleMetricBaseline

Os resultados da linha de base de uma única métrica.

TimeSeriesBaseline

Os valores de base para uma única série temporal.

AdditionalInfo

Uma matriz de objetos com propriedades 'type' e 'info'. O esquema de 'info' é específico do serviço e depende da cadeia de caracteres 'type'.

Name Tipo Description
info

object

As informações adicionais específicas do tipo.

type

string

O tipo de informação adicional.

BaselineMetadata

Representa um valor de metadados da linha de base.

Name Tipo Description
name

string

Nome dos metadados da linha de base.

value

string

Valor dos metadados da linha de base.

BaselineSensitivity

a sensibilidade dos valores basais.

Valor Description
Low
Medium
High

Error

Name Tipo Description
additionalInfo

AdditionalInfo[]

Uma matriz de objetos com propriedades 'type' e 'info'. O esquema de 'info' é específico do serviço e depende da cadeia de caracteres 'type'.

code

string

String não localizada que pode ser usada para identificar programaticamente o erro.

details

ErrorDetail[]

Uma matriz de objetos adicionais aninhados de informações de resposta de erro, conforme descrito por este contrato.

message

string

Descreve o erro em detalhes e fornece informações de depuração. Se Accept-Language estiver definido na solicitação, ela deverá ser localizada para esse idioma.

target

string

O destino do erro específico (por exemplo, o nome da propriedade em erro).

ErrorDetail

Descreve os detalhes de uma resposta de erro.

Name Tipo Description
additionalInfo

AdditionalInfo[]

Uma matriz de objetos com propriedades 'type' e 'info'. O esquema de 'info' é específico do serviço e depende da cadeia de caracteres 'type'.

code

string

String não localizada que pode ser usada para identificar programaticamente o erro.

message

string

Descreve o erro em detalhes e fornece informações de depuração.

target

string

O destino do erro específico (por exemplo, o nome da propriedade em erro).

ErrorResponse

Descreve o formato de Resposta de erro.

Name Tipo Description
error

Error

MetricBaselinesResponse

Uma lista de linhas de base métricas.

Name Tipo Description
value

SingleMetricBaseline[]

A lista de linhas de base métricas.

MetricSingleDimension

O nome e o valor da dimensão métrica.

Name Tipo Description
name

string

Nome da dimensão.

value

string

Valor da dimensão.

ResultType

Permite recuperar apenas metadados da linha de base. Na solicitação de dados, todas as informações são recuperadas.

Valor Description
Data
Metadata

SingleBaseline

Os valores basais para um único valor de sensibilidade.

Name Tipo Description
highThresholds

number[] (double)

Os limiares elevados da linha de base.

lowThresholds

number[] (double)

Os limiares baixos da linha de base.

sensitivity

BaselineSensitivity

a sensibilidade dos valores basais.

SingleMetricBaseline

Os resultados da linha de base de uma única métrica.

Name Tipo Description
id

string

A métrica Id da linha de base.

name

string

O nome da métrica para a qual as linhas de base foram recuperadas.

properties.baselines

TimeSeriesBaseline[]

A linha de base para cada série temporal consultada.

properties.interval

string (duration)

O intervalo (tamanho da janela) para o qual os dados métricos foram retornados. Este poderá ser ajustado no futuro e devolvido do que foi inicialmente solicitado. Isso não está presente se uma solicitação de metadados foi feita.

properties.namespace

string

O namespace das métricas foi consultado.

properties.timespan

string

O período de tempo para o qual os dados foram recuperados. O seu valor consiste em duas datas/hora concatenadas, separadas por '/'. Este poderá ser ajustado no futuro e devolvido do que foi inicialmente solicitado.

type

string

O tipo de recurso do recurso de linha de base métrica.

TimeSeriesBaseline

Os valores de base para uma única série temporal.

Name Tipo Description
aggregation

string

O tipo de agregação da métrica.

data

SingleBaseline[]

Os valores basais para cada sensibilidade.

dimensions

MetricSingleDimension[]

As dimensões desta série temporal.

metadataValues

BaselineMetadata[]

Os valores dos metadados da linha de base.

timestamps

string[] (date-time)

A lista de carimbos de data/hora das linhas de base.