Поделиться через


Weather - Get Daily Historical Actuals

Используется для получения климатических данных, таких как фактические наблюдаемые температуры за прошлые дни, осадки, снегопад и высота снега.

Get Daily Historical Actuals API представляет собой HTTP-запросGET, который возвращает климатологические данные, такие как прошлые ежедневные фактические наблюдаемые температуры, осадки, снегопады, высота снега и информация о днях охлаждения/нагревания, за день в заданном координатном местоположении. Данные запрашиваются за указанный диапазон дат, до 31 дня в одном запросе API. Как правило, исторические данные могут быть доступны за последние 5–40+ лет, в зависимости от местоположения.

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

Параметры URI

Имя В Обязательно Тип Описание
format
path True

JsonFormat

Требуемый формат ответа. Поддерживается только json формат.

api-version
query True

string

Номер версии API Azure Maps.

endDate
query True

string (date)

Дата окончания в формате ISO 8601, например, 2019-10-28. Поддерживаемый диапазон дат составляет от 1 до 31 календарного дня, поэтому обязательно укажите startDate и endDate, которые не превышают максимум 31 день (например: startDate=2012-01-01&endDate=2012-01-31).

query
query True

number[]

Применимый запрос, указанный как разделенная запятыми строка, состоящая из широты, за которой следует долгота, например "47.641268,-125679".

Информация о погоде обычно доступна для мест на суше, водоемов, окруженных сушей, и районов океана, которые находятся в пределах примерно 50 морских миль от береговой линии.

startDate
query True

string (date)

Дата начала в формате ISO 8601, например, 2019-10-27. Поддерживаемый диапазон дат составляет от 1 до 31 календарного дня, поэтому обязательно укажите startDate и endDate, которые не превышают максимум 31 день (например: startDate=2012-01-01&endDate=2012-01-31).

unit
query

WeatherDataUnit

Указывает, что данные возвращаются в метрических или британских единицах. Значение по умолчанию — metric.

Заголовок запроса

Имя Обязательно Тип Описание
x-ms-client-id

string

Указывает, какая учетная запись предназначена для использования в сочетании с моделью безопасности идентификатора Microsoft Entra. Он представляет уникальный идентификатор учетной записи Azure Maps и может быть получен из API учетной записи уровня управления Azure Maps. Сведения о том, как использовать безопасность идентификатора Microsoft Entra в Azure Maps, см. в следующих статьях .

Ответы

Имя Тип Описание
200 OK

DailyHistoricalActualsResult

ХОРОШО

Other Status Codes

ErrorResponse

Произошла непредвиденная ошибка.

Безопасность

AADToken

Это потоки Microsoft Entra OAuth 2.0. При паре с доступом на основе ролей Azure его можно использовать для управления доступом к REST API Azure Maps. Управление доступом на основе ролей Azure используется для назначения доступа к одной или нескольким учетным записям ресурсов Azure Maps или вложенным ресурсам. Доступ к любому пользователю, группе или субъекту-службе можно предоставить через встроенную роль или пользовательскую роль, состоящую из одного или нескольких разрешений для REST API Azure Maps.

Для реализации сценариев рекомендуется просматривать концепции проверки подлинности . В целом, это определение безопасности предоставляет решение для моделирования приложений через объекты, способные управлять доступом в определенных API и областях.

Примечания.

  • Для этого определения безопасности требуется использовать заголовок x-ms-client-id, чтобы указать, к какой ресурсу Azure Maps приложение запрашивает доступ. Это можно получить из API управления карт.

Authorization URL зависит от экземпляра общедоступного облака Azure. В национальных облаках есть уникальные URL-адреса авторизации и конфигурации идентификатора Microsoft Entra. * Управление доступом на основе ролей Azure настраивается с плоскости управления Azure с помощью портала Azure, PowerShell, CLI, пакетов SDK Azure или REST API. * Использование веб-пакета SDK Azure Maps позволяет настроить приложение на основе конфигурации для нескольких вариантов использования.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

Это общий ключ, подготовленный при создания учетной записи Azure Maps на портале Azure или с помощью PowerShell, CLI, пакетов SDK Azure или REST API.

С помощью этого ключа любой приложение может получить доступ ко всем REST API. Другими словами, этот ключ можно использовать в качестве главного ключа в учетной записи, в которую они выданы.

Для общедоступных приложений мы рекомендуем использовать конфиденциальные клиентские приложения, подход для доступа к REST API Azure Maps, чтобы ваш ключ можно было безопасно хранить.

Тип: apiKey
В: query

SAS Token

Это маркер подписанного URL-адреса создается из операции SAS списка на ресурсе Azure Maps через плоскость управления Azure с помощью портала Azure, PowerShell, CLI, пакетов SDK Azure или REST API.

С помощью этого маркера любой приложению разрешен доступ с помощью управления доступом на основе ролей Azure и точного управления сроком действия, скоростью и регионами, используемыми для конкретного маркера. Другими словами, маркер SAS можно использовать для разрешения приложений управлять доступом более защищенным способом, чем общий ключ.

Для общедоступных приложений мы рекомендуем настроить определенный список разрешенных источников в ресурсе учетной записи карты карты, чтобы ограничить злоупотребление отрисовкой и регулярно обновлять маркер SAS.

Тип: apiKey
В: header

Примеры

Successful Daily Historical Actuals Request

Образец запроса

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

Пример ответа

{
  "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
      }
    }
  ]
}

Определения

Имя Описание
DailyHistoricalActuals
DailyHistoricalActualsResult
DegreeDaySummary
ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

ErrorDetail

Сведения об ошибке.

ErrorResponse

Ответ на ошибку

JsonFormat

Требуемый формат ответа. Поддерживается только json формат.

UnitType

Числовое значение ID, связанное с типом отображаемой единицы измерения. Может использоваться для перевода единиц измерения. Дополнительные сведения см. в статье Службы погоды в Azure Maps .

WeatherDataUnit

Указывает, что данные возвращаются в метрических или британских единицах. Значение по умолчанию — metric.

WeatherUnit

Удельное значение данной единицы, связанное с погодой.

WeatherUnitMaxMinAvg

Возвращаемые значения температуры.

DailyHistoricalActuals

Имя Тип Описание
date

string (date-time)

Дата и время текущего наблюдения отображаются в формате ISO 8601, например, 2019-10-27T19:39:57-08:00.

degreeDaySummary

DegreeDaySummary

Сводка информации о днях нагрева или охлаждения. Градусо-дни — это показатели того, насколько холодно или тепло в месте. Градусо-день сравнивает среднюю (среднее значение высокой и низкой) температуру наружного воздуха, зарегистрированную для данного места, со стандартной температурой 65 градусов по Фаренгейту / 18 градусов по Цельсию.

precipitation

WeatherUnit

Количество выпавших осадков (в жидком эквиваленте).

snowDepth

WeatherUnit

Высота снежного покрова.

snowfall

WeatherUnit

Количество выпавшего снега.

temperature

WeatherUnitMaxMinAvg

Значения температуры.

DailyHistoricalActualsResult

Имя Тип Описание
nextLink

string

Ссылка на следующую страницу возвращаемых функций. Если это последняя страница, это поле не отображается.

results

DailyHistoricalActuals[]

Исторические факты за каждый запрашиваемый день.

DegreeDaySummary

Имя Тип Описание
cooling

WeatherUnit

Количество градусов, на которое средняя температура превышает 65 градусов по Фаренгейту / 18 градусов по Цельсию.

heating

WeatherUnit

Количество градусов, на которое средняя температура опускается ниже 65 градусов по Фаренгейту / 18 градусов по Цельсию.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя Тип Описание
info

object

Дополнительные сведения.

type

string

Дополнительный тип сведений.

ErrorDetail

Сведения об ошибке.

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.

code

string

Код ошибки.

details

ErrorDetail[]

Сведения об ошибке.

message

string

Сообщение об ошибке.

target

string

Целевой объект ошибки.

ErrorResponse

Ответ на ошибку

Имя Тип Описание
error

ErrorDetail

Объект ошибки.

JsonFormat

Требуемый формат ответа. Поддерживается только json формат.

Значение Описание
json

формат обмена данными для объектов JavaScript

UnitType

Числовое значение ID, связанное с типом отображаемой единицы измерения. Может использоваться для перевода единиц измерения. Дополнительные сведения см. в статье Службы погоды в Azure Maps .

Значение Описание
0

футы

1

дюймы

10

метры в секунду (м/с)

11

гектопаскали

12

дюймы ртутного столба

13

килопаскали

14

миллибары

15

миллиметры ртутного столба (мм рт. столба)

16

poundsPerSquareInch (фунт/кв. дюйм)

17

Цельсия

18

Фаренгейт

19

Кельвин

2

мили

20

процент

21

плавать

22

целое число

3

миллиметр

31

МикрограммКубический метр воздуха

4

сантиметр

5

метр

6

километр

7

километры в час (км/час)

8

узлы

9

миль в час

WeatherDataUnit

Указывает, что данные возвращаются в метрических или британских единицах. Значение по умолчанию — metric.

Значение Описание
imperial

Возвращайте данные в британских единицах. Некоторыми примерами единиц имперской системы являются Фаренгейт и миля.

metric

Возвращайте данные в метрических единицах. Некоторыми примерами единиц метрической системы являются Цельсий и километр.

WeatherUnit

Удельное значение данной единицы, связанное с погодой.

Имя Тип Описание
unit

string

Тип единицы измерения для возвращаемого значения.

unitType

UnitType (int32)

Числовое значение ID, связанное с типом отображаемой единицы измерения. Может использоваться для перевода единиц измерения. Дополнительные сведения см. в статье Службы погоды в Azure Maps .

value

number (float)

Округленное значение.

WeatherUnitMaxMinAvg

Возвращаемые значения температуры.

Имя Тип Описание
average

WeatherUnit

Средняя температура за определенный период времени.

maximum

WeatherUnit

Максимальная температура за определенный период времени.

minimum

WeatherUnit

Минимальная температура за временной промежуток.