Weather - Get Air Quality Daily Forecasts

Ссылка

Служба:: Maps

Версия API:: 1.1

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

Get Air Quality Daily Forecasts API — это HTTP-запросGET, который возвращает подробные сведения о концентрации загрязняющих веществ и общем состоянии прогнозируемого ежедневного качества воздуха. Служба может предоставить прогнозируемую ежедневную информацию о качестве воздуха на предстоящие 1-7 дней, включая уровни загрязнения, значения индекса качества воздуха, доминирующий загрязнитель, а также краткое заявление с обобщением уровня риска и предлагаемых мер предосторожности.

GET https://atlas.microsoft.com/weather/airQuality/forecasts/daily/json?api-version=1.1&query={query}

С использованием необязательных параметров:

GET https://atlas.microsoft.com/weather/airQuality/forecasts/daily/json?api-version=1.1&language={language}&query={query}&duration={duration}

Параметры URI

Имя	В	Обязательно	Тип	Описание
format	path	True	JsonFormat	Требуемый формат ответа. Поддерживается только формат `json`.
api-version	query	True	string	Номер версии API Azure Maps
query	query	True	number[]	Применимый запрос, указанный в виде строки, разделенной запятыми, состоящей из широты и долготы, например "47,641268,-122.125679".
duration	query		DailyDuration int32	Указывает, через сколько дней мы хотели бы узнать о качестве воздуха. Доступные значения: 1, 2, 3, 4, 5, 6 и 7. Значение по умолчанию — 1.
language	query		string	Язык, на котором должны возвращаться результаты поиска. Должен быть одним из поддерживаемых языковых тегов IETF без учета регистра. Если данные на указанном языке недоступны для определенного поля, используется язык по умолчанию. Дополнительные сведения см. в разделе Поддерживаемые языки .

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

Имя	Обязательно	Тип	Описание
x-ms-client-id		string	Указывает, какая учетная запись предназначена для использования в сочетании с моделью безопасности Microsoft Entra ID. Он представляет уникальный идентификатор для учетной записи Azure Maps и может быть получен из API учетной записи плоскости управления Azure Maps. Инструкции по использованию безопасности Microsoft Entra ID в Azure Maps см. в следующих статьях .

Ответы

Имя	Тип	Описание
200 OK	DailyAirQualityForecastResult	ОК
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-адреса, созданный с помощью операции List SAS в ресурсе Azure Maps через плоскость управления Azure с помощью портала Azure, PowerShell, CLI, пакетов SDK для Azure или REST API.

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

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

Тип: apiKey
В: header

Примеры

Get Daily Air Quality Forecasts

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

HTTP

GET https://atlas.microsoft.com/weather/airQuality/forecasts/daily/json?api-version=1.1&query=47.632346,-122.13887&duration=3

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

Код состояния:: 200

{
  "results": [
    {
      "dateTime": "2021-07-18T07:00:00+00:00",
      "index": 35.1,
      "globalIndex": 42.2,
      "dominantPollutant": "Ozone",
      "category": "Fair",
      "categoryColor": "#FFC300",
      "description": "The air quality is generally acceptable for most individuals. However, sensitive groups may experience minor to moderate symptoms from long-term exposure."
    },
    {
      "dateTime": "2021-07-19T07:00:00+00:00",
      "index": 31.6,
      "globalIndex": 37,
      "dominantPollutant": "Ozone",
      "category": "Fair",
      "categoryColor": "#FFC300",
      "description": "The air quality is generally acceptable for most individuals. However, sensitive groups may experience minor to moderate symptoms from long-term exposure."
    },
    {
      "dateTime": "2021-07-20T07:00:00+00:00",
      "index": 33.6,
      "globalIndex": 40,
      "dominantPollutant": "Ozone",
      "category": "Fair",
      "categoryColor": "#FFC300",
      "description": "The air quality is generally acceptable for most individuals. However, sensitive groups may experience minor to moderate symptoms from long-term exposure."
    }
  ]
}

Определения

Имя	Описание
DailyAirQuality	Сведения о качестве воздуха в определенном месте в определенное время.
DailyAirQualityForecastResult	Этот объект возвращается из успешного вызова Get Daily Air Quality Forecast.
DailyDuration	Указывает, через сколько дней мы хотели бы узнать о качестве воздуха. Доступные значения: 1, 2, 3, 4, 5, 6 и 7. Значение по умолчанию — 1.
DominantPollutant	Тип загрязняющего вещества. Обратите внимание, что в любое время можно добавить дополнительные сведения.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Сообщение об ошибке
JsonFormat	Требуемый формат ответа. Поддерживается только формат `json`.

DailyAirQuality

Сведения о качестве воздуха в определенном месте в определенное время.

Имя	Тип	Описание
category	string	Описание качества воздуха в одном слове на запрашиваемом языке. Например, "Отлично".
categoryColor	string	Уникальный цвет, соответствующий категории этого результата качества воздуха.
dateTime	string	Дата и время текущего наблюдения, отображаемого в формате ISO 8601, например 2019-10-27T19:39:57-08:00.
description	string	Текстовое объяснение этого качества воздуха приводится на запрашиваемом языке.
dominantPollutant	DominantPollutant	Загрязняющий вещества с наибольшей концентрацией.
globalIndex	number	Международно нормализованный рейтинг качества воздуха по шкале от 0 до 300 и выше, с более высокими цифрами, представляющими худшее качество воздуха.
index	number	Оценка качества воздуха по шкале, установленной местными регулирующими органами. Масштабы могут сильно различаться в зависимости от расположения. Дополнительные сведения см. в разделе Википедия .

DailyAirQualityForecastResult

Этот объект возвращается из успешного вызова Get Daily Air Quality Forecast.

Имя	Тип	Описание
nextLink	string	— это ссылка на следующую страницу возвращаемых функций. Если это последняя страница, это поле отсутствует.
results	DailyAirQuality[]	Список всех ежедневных прогнозов качества воздуха для запрашиваемого расположения.

DailyDuration

Указывает, через сколько дней мы хотели бы узнать о качестве воздуха. Доступные значения: 1, 2, 3, 4, 5, 6 и 7. Значение по умолчанию — 1.

Имя	Тип	Описание
1	string
2	string
3	string
4	string
5	string
6	string
7	string

DominantPollutant

Тип загрязняющего вещества. Обратите внимание, что в любое время можно добавить дополнительные сведения.

Имя	Тип	Описание
Carbon Monoxide	string	Угарный газ ("CO")
Nitrogen Dioxide	string	Двуокись азота ("NO2")
Ozone	string	Озон ("O3")
Particulate Matter 10	string	Твердые частицы 10 ("PM10")
Particulate Matter 2.5	string	Твердые частицы 2,5 ("PM2,5")
Sulfur Dioxide	string	Двуокись серы ("SO2")

ErrorAdditionalInfo

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

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Тип дополнительных сведений.

ErrorDetail

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

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

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

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

JsonFormat

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

Имя	Тип	Описание
json	string	Формат обмена данными нотации объектов JavaScript

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