Partilhar via

Weather - Get Daily Historical Actuals

  • Referência
Serviço:
Maps
Versão da API:
1.1

Use para obter dados de climatologia, como temperaturas reais observadas diariamente, precipitação, queda de neve e profundidade da neve.

A API Get Daily Historical Actuals é uma solicitação de GET HTTP que retorna dados de climatologia, como temperaturas reais observadas diariamente, precipitação, queda de neve, profundidade da neve e informações do dia do grau de resfriamento/aquecimento, para o dia em um determinado local coordenado. Os dados são solicitados para um intervalo de datas especificado, até 31 dias em uma única solicitação de API. Geralmente, os dados históricos podem estar disponíveis nos últimos 5 a 40+ anos, dependendo da localização.

GET https://atlas.microsoft.com/weather/historical/actuals/daily/json?api-version=1.1&query={query}&startDate={startDate}&endDate={endDate}
Com parâmetros opcionais: 
GET https://atlas.microsoft.com/weather/historical/actuals/daily/json?api-version=1.1&query={query}&startDate={startDate}&endDate={endDate}&unit={unit}

Parâmetros do URI

Name Em Necessário Tipo Description
format
 path True

JsonFormat

Formato desejado da resposta. Apenas json formato é suportado.
api-version
 query True

string

Número da versão da API do Azure Maps.
endDate
 query True

string

date

Data de término no formato ISO 8601, por exemplo, 2019-10-28. O intervalo de datas suportado é de 1 a 31 dias corridos, portanto, certifique-se de especificar uma startDate e endDate que não exceda um máximo de 31 dias (ou seja: startDate=2012-01-01&endDate=2012-01-31).
query
 query True

number[]

A consulta aplicável especificada como uma cadeia de caracteres separada por vírgulas composta por latitude seguida de longitude, por exemplo, "47.641268,-122.125679".

As informações meteorológicas estão geralmente disponíveis para locais em terra, corpos de água cercados por terra e áreas do oceano que estão a aproximadamente 50 milhas náuticas de uma costa.
startDate
 query True

string

date

Data de início no formato ISO 8601, por exemplo, 2019-10-27. O intervalo de datas suportado é de 1 a 31 dias corridos, portanto, certifique-se de especificar uma startDate e endDate que não exceda um máximo de 31 dias (ou seja: startDate=2012-01-01&endDate=2012-01-31).
unit
 query

WeatherDataUnit

Especifica para retornar os dados em unidades métricas ou unidades imperiais. O valor padrão é métrico.

Cabeçalho do Pedido

Name Necessário Tipo Description
x-ms-client-id

string

Especifica qual conta deve ser usada em conjunto com o modelo de segurança do Microsoft Entra ID. Ele representa uma ID exclusiva para a conta do Azure Maps e pode ser recuperado da API de Conta do plano de gerenciamento do Azure Maps. Para usar a segurança do Microsoft Entra ID no Azure Maps, consulte os seguintes artigos para obter orientação.

Respostas

Name Tipo Description
200 OK

DailyHistoricalActualsResult

OK
Other Status Codes

ErrorResponse

Ocorreu um erro inesperado.

Segurança

AADToken

Estes são os Microsoft Entra OAuth 2.0 Flows. Quando emparelhado com controle de de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso às APIs REST do Azure Maps. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais contas de recursos ou subrecursos do Azure Maps. Qualquer usuário, grupo ou entidade de serviço pode receber acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para APIs REST do Azure Maps.

Para implementar cenários, recomendamos a visualização conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos(s) por meio de objetos capazes de controle de acesso em APIs e escopos específicos.

Observações

  • Essa definição de segurança requer o uso do cabeçalho x-ms-client-id para indicar a qual recurso do Azure Maps o aplicativo está solicitando acesso. Isso pode ser adquirido na API de gerenciamento de do Maps.

O Authorization URL é específico para a instância de nuvem pública do Azure. As nuvens soberanas têm URLs de autorização exclusivas e configurações de ID do Microsoft Entra. * O controle de acesso baseado em função do Azure é configurado a partir do plano de gerenciamento do Azure por meio do portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * O uso do SDK da Web do Azure Maps permite a configuração baseada em configuração de um aplicativo para vários casos de uso.

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

Âmbitos

Name Description
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

Esta é uma chave compartilhada que é provisionada quando você Criar uma conta do Azure Maps no portal do Azure ou usando PowerShell, CLI, SDKs do Azure ou API REST.

Com essa chave, qualquer aplicativo pode acessar todas as APIs REST. Em outras palavras, essa chave pode ser usada como uma chave mestra na conta em que eles são emitidos.

Para aplicativos expostos publicamente, nossa recomendação é usar a abordagem de de aplicativos cliente confidenciais para acessar APIs REST do Azure Maps para que sua chave possa ser armazenada com segurança.

Tipo: apiKey
Em: query

SAS Token

Este é um token de assinatura de acesso compartilhado criado a partir da operação Listar SAS no de recursos do Azure Maps por meio do plano de gerenciamento do Azure por meio do portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com esse token, qualquer aplicativo é autorizado a acessar com controles de acesso baseados em função do Azure e controle de grão fino para a expiração, taxa e região(ões) de uso para o token específico. Em outras palavras, o Token SAS pode ser usado para permitir que os aplicativos controlem o acesso de forma mais segura do que a chave compartilhada.

Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no de recursos da conta do Map para limitar o abuso de renderização e renovar regularmente o Token SAS.

Tipo: apiKey
Em: header

Exemplos

Successful Daily Historical Actuals Request

Pedido de amostra

GET https://atlas.microsoft.com/weather/historical/actuals/daily/json?api-version=1.1&query=40.78,-77.89&startDate=2012-01-20&endDate=2012-01-22

Resposta da amostra

Código de estado:
200 
{
  "results": [
    {
      "date": "2012-01-20T00:00:00-04:00",
      "temperature": {
        "maximum": {
          "value": -6.1,
          "unit": "C",
          "unitType": 17
        },
        "minimum": {
          "value": -11.1,
          "unit": "C",
          "unitType": 17
        },
        "average": {
          "value": -8.6,
          "unit": "C",
          "unitType": 17
        }
      },
      "degreeDaySummary": {
        "heating": {
          "value": 27,
          "unit": "C",
          "unitType": 17
        },
        "cooling": {
          "value": 0,
          "unit": "C",
          "unitType": 17
        }
      },
      "precipitation": {
        "value": 10.9,
        "unit": "mm",
        "unitType": 3
      },
      "snowfall": {
        "value": 12.19,
        "unit": "cm",
        "unitType": 4
      },
      "snowDepth": {
        "value": 15.2,
        "unit": "cm",
        "unitType": 4
      }
    },
    {
      "date": "2012-01-21T00:00:00-04:00",
      "temperature": {
        "maximum": {
          "value": -1.7,
          "unit": "C",
          "unitType": 17
        },
        "minimum": {
          "value": -8.9,
          "unit": "C",
          "unitType": 17
        },
        "average": {
          "value": -5.3,
          "unit": "C",
          "unitType": 17
        }
      },
      "degreeDaySummary": {
        "heating": {
          "value": 24,
          "unit": "C",
          "unitType": 17
        },
        "cooling": {
          "value": 0,
          "unit": "C",
          "unitType": 17
        }
      },
      "precipitation": {
        "value": 0,
        "unit": "mm",
        "unitType": 3
      },
      "snowfall": {
        "value": 0.51,
        "unit": "cm",
        "unitType": 4
      },
      "snowDepth": {
        "value": 12.7,
        "unit": "cm",
        "unitType": 4
      }
    },
    {
      "date": "2012-01-22T00:00:00-04:00",
      "temperature": {
        "maximum": {
          "value": 0,
          "unit": "C",
          "unitType": 17
        },
        "minimum": {
          "value": -7.2,
          "unit": "C",
          "unitType": 17
        },
        "average": {
          "value": -3.6,
          "unit": "C",
          "unitType": 17
        }
      },
      "degreeDaySummary": {
        "heating": {
          "value": 22,
          "unit": "C",
          "unitType": 17
        },
        "cooling": {
          "value": 0,
          "unit": "C",
          "unitType": 17
        }
      },
      "precipitation": {
        "value": 0,
        "unit": "mm",
        "unitType": 3
      },
      "snowfall": {
        "value": 0,
        "unit": "cm",
        "unitType": 4
      },
      "snowDepth": {
        "value": 10.2,
        "unit": "cm",
        "unitType": 4
      }
    }
  ]
}

Definições

Name Description
DailyHistoricalActuals
DailyHistoricalActualsResult
DegreeDaySummary
ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.
ErrorDetail

O detalhe do erro.
ErrorResponse

Resposta de erro
JsonFormat

Formato desejado da resposta. Apenas json formato é suportado.
UnitType

Valor de ID numérico associado ao tipo de unidade que está sendo exibido. Pode ser usado para tradução de unidades. Consulte serviços meteorológicos no Azure Maps para obter detalhes.
WeatherDataUnit

Especifica para retornar os dados em unidades métricas ou unidades imperiais. O valor padrão é métrico.
WeatherUnit

Valor específico de uma dada unidade relacionado com o clima.
WeatherUnitMaxMinAvg

Valores de temperatura retornados.

DailyHistoricalActuals

Name Tipo Description
date

string

Data e hora da observação atual exibida no formato ISO 8601, por exemplo, 2019-10-27T19:39:57-08:00.
degreeDaySummary

DegreeDaySummary

Resumo das informações do dia do grau de aquecimento ou arrefecimento. Os graus-dias são medidas de quão frio ou quente é um local. Um grau-dia compara a média (a média das altas e baixas) temperaturas externas registradas para um local com uma temperatura padrão de 65 graus F / 18 graus C.
precipitation

WeatherUnit

A quantidade de precipitação (equivalente líquido) que diminuiu.
snowDepth

WeatherUnit

Profundidade da neve.
snowfall

WeatherUnit

A quantidade de neve que caiu.
temperature

WeatherUnitMaxMinAvg

Valores de temperatura.

DailyHistoricalActualsResult

Name Tipo Description
nextLink

string

O é o link para a próxima página dos recursos retornados. Se for a última página, não há este campo.
results

DailyHistoricalActuals[]

Histórico real para cada dia solicitado.

DegreeDaySummary

Name Tipo Description
cooling

WeatherUnit

Número de graus em que a temperatura média está acima de 65 graus F / 18 graus C.
heating

WeatherUnit

Número de graus em que a temperatura média está abaixo de 65 graus F / 18 graus C.

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

Name Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

O erro informações adicionais.
code

string

O código de erro.
details

ErrorDetail[]

Os detalhes do erro.
message

string

A mensagem de erro.
target

string

O destino do erro.

ErrorResponse

Resposta de erro

Name Tipo Description
error

ErrorDetail

O objeto de erro.

JsonFormat

Formato desejado da resposta. Apenas json formato é suportado.

Name Tipo Description
json

string

O formato de intercâmbio de dados de notação de objeto JavaScript

UnitType

Valor de ID numérico associado ao tipo de unidade que está sendo exibido. Pode ser usado para tradução de unidades. Consulte serviços meteorológicos no Azure Maps para obter detalhes.

Name Tipo Description
0

Integer

1

Integer

10

Integer

11

Integer

12

Integer

13

Integer

14

Integer

15

Integer

16

Integer

17

Integer

18

Integer

19

Integer

2

Integer

20

Integer

21

Integer

22

Integer

3

Integer

31

Integer

4

Integer

5

Integer

6

Integer

7

Integer

8

Integer

9

Integer

WeatherDataUnit

Especifica para retornar os dados em unidades métricas ou unidades imperiais. O valor padrão é métrico.

Name Tipo Description
imperial

string

Dados de retorno em unidades imperiais. Alguns exemplos de unidades do sistema imperial são Fahrenheit e milha.
metric

string

Retornar dados em unidades métricas. Alguns exemplos de unidades de sistema métrico são Celsius e quilômetro.

WeatherUnit

Valor específico de uma dada unidade relacionado com o clima.

Name Tipo Description
unit

string

Tipo de unidade para o valor retornado.
unitType

UnitType

Valor de ID numérico associado ao tipo de unidade que está sendo exibido. Pode ser usado para tradução de unidades. Consulte serviços meteorológicos no Azure Maps para obter detalhes.
value

number

Valor arredondado.

WeatherUnitMaxMinAvg

Valores de temperatura retornados.

Name Tipo Description
average

WeatherUnit

Temperatura média para o período de tempo.
maximum

WeatherUnit

Temperatura máxima para o período de tempo.
minimum

WeatherUnit

Temperatura mínima para o período de tempo.