Weather - Get Daily Historical Actuals

Referência

Serviço:: Maps

Versão da API:: 1.1

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

A Get Daily Historical Actuals API é uma solicitação HTTP GET que retorna dados de climatologia, como temperaturas observadas diárias diárias reais, precipitação, queda de neve, profundidade de neve e informações do dia do grau de resfriamento/aquecimento, para o dia em um determinado local de coordenadas. 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 de URI

Nome	Em	Obrigatório	Tipo	Description
format	path	True	JsonFormat	Formato desejado da resposta. Há suporte apenas para o formato `json`.
api-version	query	True	string	Número de versão da API de Mapas Azure.
endDate	query	True	string date	Data de término no formato ISO 8601, por exemplo, 2019-10-28. O intervalo de datas com suporte é de 1 a 31 dias de calendário, portanto, especifique 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 de caracteres separada por vírgulas composta por latitude seguida por 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 com suporte é de 1 a 31 dias de calendário, portanto, especifique 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 retornar os dados em unidades de métrica ou em unidades imperiais. O valor padrão é métrica.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-id		string	Especifica qual conta destina-se ao uso em conjunto com o modelo de segurança da ID do Microsoft Entra. Ele representa uma ID exclusiva para a conta do Azure Mapas e pode ser recuperado da API de Conta do plano de gerenciamento do Azure Mapas. Para usar a segurança do Microsoft Entra ID no Azure Mapas, confira os artigos a seguir para obter diretrizes .

Respostas

Nome	Tipo	Description
200 OK	DailyHistoricalActualsResult	OK
Other Status Codes	ErrorResponse	Erro inesperado.

Segurança

AADToken

Estes são os Fluxos do Microsoft Entra OAuth 2.0 . Quando emparelhado com o controle de acesso baseado em função do Azure , ele pode ser usado para controlar o acesso às APIs REST do Azure Mapas. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais sub-recursos ou conta de recurso do Azure Mapas. 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 Mapas.

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

Observações

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

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 no plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST. * O uso do SDK da Web do Azure Mapas permite a configuração baseada em configuração de um aplicativo para vários casos de uso.

Para obter mais informações sobre a plataforma de identidade da Microsoft, consulte Visão geral da plataforma de identidade da Microsoft.

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

Escopos

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

subscription-key

Essa é uma chave compartilhada provisionada quando você cria uma conta do Azure Mapas no portal do Azure ou usa o PowerShell, a CLI, os SDKs do Azure ou a API REST.

Com essa chave, qualquer aplicativo pode acessar toda a API REST. Em outras palavras, essa chave pode ser usada como uma chave mestra na conta em que elas são emitidas.

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

Tipo: apiKey
Em: query

SAS Token

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

Com esse token, qualquer aplicativo está autorizado a acessar com controles de acesso baseados em função do Azure e controle refinado à expiração, taxa e regiõ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 maneira mais segura do que a chave compartilhada.

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

Tipo: apiKey
Em: header

Exemplos

Successful Daily Historical Actuals Request

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 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

Nome	Description
DailyHistoricalActuals
DailyHistoricalActualsResult
DegreeDaySummary
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
JsonFormat	Formato desejado da resposta. Há suporte apenas para o formato `json`.
UnitType	Valor de ID numérica associado ao tipo de unidade que está sendo exibida. Pode ser usado para tradução de unidade. Consulte Serviços meteorológicos no Azure Mapas para obter detalhes.
WeatherDataUnit	Especifica para retornar os dados em unidades de métrica ou em unidades imperiais. O valor padrão é métrica.
WeatherUnit	Valor específico de uma determinada unidade relacionada ao clima.
WeatherUnitMaxMinAvg	Valores de temperatura retornados.

DailyHistoricalActuals

Nome	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 aquecimento ou do grau de resfriamento. 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 ao ar livre altas e baixas) 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 caiu.
snowDepth	WeatherUnit	Profundidade de neve.
snowfall	WeatherUnit	A quantidade de neve que caiu.
temperature	WeatherUnitMaxMinAvg	Valores de temperatura.

DailyHistoricalActualsResult

Nome	Tipo	Description
nextLink	string	O é o link para a próxima página dos recursos retornados. Se for a última página, não este campo.
results	DailyHistoricalActuals[]	Reais históricas para cada dia solicitado.

DegreeDaySummary

Nome	Tipo	Description
cooling	WeatherUnit	Número de graus que a temperatura média está acima de 65 graus F/ 18 graus C.
heating	WeatherUnit	Número de graus que a temperatura média está abaixo de 65 graus F/ 18 graus C.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Nome	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 de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

JsonFormat

Formato desejado da resposta. Há suporte apenas para o formato json.

Nome	Tipo	Description
json	string	O formato de intercâmbio de dados de notação de objeto JavaScript

UnitType

Valor de ID numérica associado ao tipo de unidade que está sendo exibida. Pode ser usado para tradução de unidade. Consulte Serviços meteorológicos no Azure Mapas para obter detalhes.

Nome	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 de métrica ou em unidades imperiais. O valor padrão é métrica.

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

WeatherUnit

Valor específico de uma determinada unidade relacionada ao clima.

Nome	Tipo	Description
unit	string	Tipo de unidade para o valor retornado.
unitType	UnitType	Valor de ID numérica associado ao tipo de unidade que está sendo exibida. Pode ser usado para tradução de unidade. Consulte Serviços meteorológicos no Azure Mapas para obter detalhes.
value	number	Valor arredondado.

WeatherUnitMaxMinAvg

Valores de temperatura retornados.

Nome	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.

Compartilhar via