Weather - Get Daily Historical Actuals

Referência

Service:: Maps

API Version:: 1.1

Utilizado para obter dados de climatologia, como temperaturas observadas diárias passadas, precipitação, queda de neve e profundidade da neve.

A Get Daily Historical Actuals API é um pedido HTTP GET que devolve dados de climatologia, como temperaturas observadas diárias passadas, precipitação, queda de neve, profundidade da neve e informações do dia do grau de arrefecimento/aquecimento, para o dia numa determinada localização coordenada. Os dados são pedidos para um intervalo de datas especificado, até 31 dias num único pedido de API. Geralmente, os dados históricos podem estar disponíveis desde os ú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}

With optional parameters:

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 pretendido da resposta. Apenas `json` o formato é suportado.
api-version	query	True	string	Número da versão da API Azure Maps.
endDate	query	True	string date	Data de fim no formato ISO 8601, por exemplo, 2019-10-28. O intervalo de datas suportado é de 1 a 31 dias de calendário, por isso certifique-se de que especifica um 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 separada por vírgulas composta por latitude seguida de longitude, por exemplo, "47.641268,-122.125679".
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 de calendário, por isso certifique-se de que especifica um 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 devolver os dados em unidades métricas ou unidades imperiais. O valor predefinido é métrica.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
x-ms-client-id		string	Especifica a conta que se destina à utilização em conjunto com o modelo de segurança Microsoft Entra ID. Representa um ID exclusivo para a conta Azure Maps e pode ser obtido a partir da API de Conta do plano de gestão Azure Maps. Para utilizar Microsoft Entra ID segurança no Azure Maps consulte os seguintes artigos para obter orientações.

Respostas

Name	Tipo	Description
200 OK	DailyHistoricalActualsResult	OK
Other Status Codes	ErrorResponse	Ocorreu um erro inesperado.

Segurança

AADToken

Estes são os fluxos Microsoft Entra OAuth 2.0. Quando emparelhado com o controlo de acesso baseado em funções do Azure, pode ser utilizado para controlar o acesso às APIs REST Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais Azure Maps conta de recursos ou sub-recursos. Qualquer utilizador, grupo ou principal de serviço pode ter acesso através de uma função incorporada ou de uma função personalizada composta por uma ou mais permissões para Azure Maps APIs REST.

Para implementar cenários, recomendamos que veja os conceitos de autenticação. Em resumo, esta definição de segurança fornece uma solução para modelar aplicações através de objetos com capacidade de controlo de acesso em APIs e âmbitos específicos.

Notas

Esta definição de segurança requer a utilização do x-ms-client-id cabeçalho para indicar a que recurso Azure Maps a aplicação está a pedir acesso. Isto pode ser adquirido a partir da API de gestão do Maps .

O Authorization URL é específico da instância da cloud pública do Azure. As clouds soberanas têm URLs de Autorização exclusivos e configurações de Microsoft Entra ID. * O controlo de acesso baseado em funções do Azure está configurado a partir do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * A utilização do SDK Web Azure Maps permite a configuração baseada na configuração de uma aplicação para vários casos de utilização.

Para obter mais informações sobre plataforma de identidades da Microsoft, consulte plataforma de identidades da Microsoft descrição geral.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

subscription-key

Esta é uma chave partilhada que é aprovisionada quando Create uma conta Azure Maps no portal do Azure ou com o PowerShell, a CLI, os SDKs do Azure ou a API REST.

Com esta chave, qualquer aplicação pode aceder a toda a API REST. Por outras palavras, esta chave pode ser utilizada como uma chave mestra na conta na qual são emitidas.

Para aplicações expostas publicamente, a nossa recomendação é utilizar a abordagem de aplicações cliente confidenciais para aceder Azure Maps APIs REST para que a sua chave possa ser armazenada de forma segura.

Type: apiKey
In: query

SAS Token

Este é um token de assinatura de acesso partilhado criado a partir da operação Listar SAS no recurso Azure Maps através do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com este token, qualquer aplicação está autorizada a aceder com controlos de acesso baseados em funções do Azure e controlo detalhado para a expiração, taxa e regiões de utilização para o token específico. Por outras palavras, o Token de SAS pode ser utilizado para permitir que as aplicações controlem o acesso de uma forma mais segura do que a chave partilhada.

Para aplicações expostas publicamente, a nossa recomendação é configurar uma lista específica de origens permitidas no recurso da conta de Mapa para limitar o abuso de composição e renovar regularmente o Token de SAS.

Type: apiKey
In: header

Exemplos

Successful Daily Historical Actuals Request

Sample Request

HTTP

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

Sample Response

Status code:: 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	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta a erros
JsonFormat	Formato pretendido da resposta. Apenas `json` o formato é suportado.
UnitType	Valor de ID numérico associado ao tipo de unidade que está a ser apresentada. Pode ser utilizado para tradução de unidades. Veja Serviços de meteorologia no Azure Maps para obter detalhes.
WeatherDataUnit	Especifica para devolver os dados em unidades métricas ou unidades imperiais. O valor predefinido é métrica.
WeatherUnit	Valor específico de uma determinada unidade relacionada com a meteorologia.
WeatherUnitMaxMinAvg	Valores de temperatura devolvidos.

DailyHistoricalActuals

Name	Tipo	Description
date	string	Data e hora da observação atual apresentada no formato ISO 8601, por exemplo, 2019-10-27T19:39:57-08:00.
degreeDaySummary	DegreeDaySummary	Resumo das informações diárias do dia do aquecimento ou refrigeração. Os dias de grau são medidas de quão frio ou quente é um local. Um dia de grau compara a média (a média das temperaturas altas e baixas) ao ar livre registadas para uma localização 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	É a ligação para a página seguinte das funcionalidades devolvidas. Se for a última página, não este campo.
results	DailyHistoricalActuals[]	Valores reais históricos para cada dia pedido.

DegreeDaySummary

Name	Tipo	Description
cooling	WeatherUnit	Número de graus que a temperatura média é superior a 65 graus F/ 18 graus C.
heating	WeatherUnit	Número de graus que a temperatura média é inferior a 65 graus F/ 18 graus C.

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informações adicionais.

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
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 a erros

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

JsonFormat

Formato pretendido da resposta. Apenas json o formato é suportado.

Name	Tipo	Description
json	string	Formato JavaScript Object Notation Data Interchange

UnitType

Valor de ID numérico associado ao tipo de unidade que está a ser apresentada. Pode ser utilizado para tradução de unidades. Veja Serviços de meteorologia 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 devolver os dados em unidades métricas ou unidades imperiais. O valor predefinido é métrica.

Name	Tipo	Description
imperial	string	Devolver dados em unidades imperiais. Algumas unidades de exemplo do sistema imperial são Fahrenheit e mile.
metric	string	Devolver dados em unidades métricas. Algumas unidades de exemplo do sistema de métricas são Celsius e km.

WeatherUnit

Valor específico de uma determinada unidade relacionada com a meteorologia.

Name	Tipo	Description
unit	string	Tipo de unidade para o valor devolvido.
unitType	UnitType	Valor de ID numérico associado ao tipo de unidade que está a ser apresentada. Pode ser utilizado para tradução de unidades. Veja Serviços de meteorologia no Azure Maps para obter detalhes.
value	number	Valor arredondado.

WeatherUnitMaxMinAvg

Valores de temperatura devolvidos.

Name	Tipo	Description
average	WeatherUnit	Temperatura média do 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.