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

Weather - Get Daily Historical Records

  • Ссылка
Служба:
Maps
Версия API:
1.1

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

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

GET https://atlas.microsoft.com/weather/historical/records/daily/json?api-version=1.1&query={query}&startDate={startDate}&endDate={endDate}
С использованием необязательных параметров: 
GET https://atlas.microsoft.com/weather/historical/records/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, например 28.10.2019. Поддерживаемый диапазон дат составляет от 1 до 31 календарных дней, поэтому не забудьте указать startDate и endDate, которые не превышают максимум 31 день (т. е. startDate=2012-01-01&endDate=2012-01-31).
query
 query True

number[]

Применимый запрос, указанный в виде строки, разделенной запятыми, состоящей из широты и долготы, например "47,641268,-122,125679".
startDate
 query True

string

date

Дата начала в формате ISO 8601, например 27.10.2019. Поддерживаемый диапазон дат составляет от 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 ID в Azure Maps см. в следующих статьях .

Ответы

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

DailyHistoricalRecordsResult

ОК
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, пакетов AZURE SDK или REST API.

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

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

Тип: apiKey
В: query

SAS Token

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

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

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

Тип: apiKey
В: header

Примеры

Successful Daily Historical Records Request

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

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

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

Код состояния:
200 
{
  "results": [
    {
      "date": "2012-01-20T00:00:00-04:00",
      "temperature": {
        "maximum": {
          "value": 18.3,
          "unit": "C",
          "unitType": 17,
          "year": 1951
        },
        "minimum": {
          "value": -19.4,
          "unit": "C",
          "unitType": 17,
          "year": 1984
        },
        "average": {
          "value": -0.6,
          "unit": "C",
          "unitType": 17
        }
      },
      "precipitation": {
        "maximum": {
          "value": 48,
          "unit": "mm",
          "unitType": 3,
          "year": 1978
        }
      },
      "snowfall": {
        "maximum": {
          "value": 12.19,
          "unit": "cm",
          "unitType": 4,
          "year": 1978
        }
      }
    },
    {
      "date": "2012-01-21T00:00:00-04:00",
      "temperature": {
        "maximum": {
          "value": 16.7,
          "unit": "C",
          "unitType": 17,
          "year": 1959
        },
        "minimum": {
          "value": -21.1,
          "unit": "C",
          "unitType": 17,
          "year": 1985
        },
        "average": {
          "value": -2.2,
          "unit": "C",
          "unitType": 17
        }
      },
      "precipitation": {
        "maximum": {
          "value": 33.5,
          "unit": "mm",
          "unitType": 3,
          "year": 1979
        }
      },
      "snowfall": {
        "maximum": {
          "value": 34.29,
          "unit": "cm",
          "unitType": 4,
          "year": 2014
        }
      }
    },
    {
      "date": "2012-01-22T00:00:00-04:00",
      "temperature": {
        "maximum": {
          "value": 21.1,
          "unit": "C",
          "unitType": 17,
          "year": 1906
        },
        "minimum": {
          "value": -21.7,
          "unit": "C",
          "unitType": 17,
          "year": 1984
        },
        "average": {
          "value": -0.3,
          "unit": "C",
          "unitType": 17
        }
      },
      "precipitation": {
        "maximum": {
          "value": 26.2,
          "unit": "mm",
          "unitType": 3,
          "year": 1987
        }
      },
      "snowfall": {
        "maximum": {
          "value": 22.35,
          "unit": "cm",
          "unitType": 4,
          "year": 1987
        }
      }
    }
  ]
}

Определения

Имя Описание
DailyHistoricalRecords
DailyHistoricalRecordsResult
ErrorAdditionalInfo

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

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

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

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

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

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

Конкретное значение заданной единицы измерения, связанное с погодой.
WeatherUnitYear
WeatherUnitYearMax

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

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

DailyHistoricalRecords

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

string

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

WeatherUnitYearMax

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

WeatherUnitYearMax

Максимальный снегопад.
temperature

WeatherUnitYearMaxMinAvg

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

DailyHistoricalRecordsResult

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

string

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

DailyHistoricalRecords[]

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

ErrorAdditionalInfo

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

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

object

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

string

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

ErrorDetail

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

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

ErrorAdditionalInfo[]

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

string

Код ошибки.
details

ErrorDetail[]

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

string

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

string

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

ErrorResponse

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

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

ErrorDetail

Объект error.

JsonFormat

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

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

string

Формат обмена данными нотации объектов JavaScript

UnitType

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

Имя Тип Описание
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

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

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

string

Возврат данных в имперских единицах. Некоторые примеры единиц имперской системы — это Fahrenheit и миля.
metric

string

Возвращает данные в единицах метрик. Примерами единиц метрики являются цельсия и километр.

WeatherUnit

Конкретное значение заданной единицы измерения, связанное с погодой.

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

string

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

UnitType

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

number

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

WeatherUnitYear

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

string

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

integer

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

number

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

integer

Год возникновения значения.

WeatherUnitYearMax

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

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

WeatherUnitYear

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

WeatherUnitYearMaxMinAvg

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

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

WeatherUnit

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

WeatherUnitYear

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

WeatherUnitYear

Минимальная температура для периода времени.