Weather - Get Current Air Quality
Используйте для получения актуальной информации о качестве воздуха, которая включает в себя потенциальные риски и рекомендуемые меры предосторожности.
Get Current Air Quality
API представляет собой HTTP-запросGET
, который возвращает подробную информацию о концентрации загрязняющих веществ и общем состоянии текущего качества воздуха, включая уровни загрязнения, значения индекса качества воздуха, доминирующий загрязнитель, а также краткое заявление, обобщающее уровень риска и предлагаемые меры предосторожности.
GET https://atlas.microsoft.com/weather/airQuality/current/json?api-version=1.1&query={query}
GET https://atlas.microsoft.com/weather/airQuality/current/json?api-version=1.1&language={language}&query={query}&pollutants={pollutants}
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
format
|
path | True |
Требуемый формат ответа. Поддерживается только |
|
api-version
|
query | True |
string |
Номер версии API Azure Maps. |
query
|
query | True |
number[] |
Применимый запрос, указанный как разделенная запятыми строка, состоящая из широты, за которой следует долгота, например "47.641268,-125679". Информация о погоде обычно доступна для мест на суше, водоемов, окруженных сушей, и районов океана, которые находятся в пределах примерно 50 морских миль от береговой линии. |
language
|
query |
string |
Язык, в котором должны быть возвращены результаты поиска. Должен быть одним из поддерживаемых тегов языка IETF, не учитывает регистр. Если данные на указанном языке недоступны для определенного поля, используется язык по умолчанию. Дополнительные сведения см. в поддерживаемых языках. |
|
pollutants
|
query |
boolean |
Логическое значение, которое возвращает подробную информацию о каждом загрязнителе. По умолчанию установлено значение True. |
Заголовок запроса
Имя | Обязательно | Тип | Описание |
---|---|---|---|
x-ms-client-id |
string |
Указывает, какая учетная запись предназначена для использования в сочетании с моделью безопасности идентификатора Microsoft Entra. Он представляет уникальный идентификатор учетной записи Azure Maps и может быть получен из API учетной записи уровня управления Azure Maps. Сведения о том, как использовать безопасность идентификатора Microsoft Entra в Azure Maps, см. в следующих статьях |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
ХОРОШО |
|
Other Status Codes |
Произошла непредвиденная ошибка. |
Безопасность
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
Примеры
Get Current Air Quality
Образец запроса
GET https://atlas.microsoft.com/weather/airQuality/current/json?api-version=1.1&query=47.632346,-122.13887
Пример ответа
{
"results": [
{
"dateTime": "2021-07-19T02:00:00+00:00",
"index": 21.6,
"globalIndex": 22.1,
"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.",
"pollutants": [
{
"type": "NO2",
"name": "Nitrogen Dioxide",
"index": 6.7,
"globalIndex": 6.7,
"concentration": {
"value": 13.4,
"unit": "µg/m³",
"unitType": 31
}
},
{
"type": "O3",
"name": "Ozone",
"index": 21.6,
"globalIndex": 22.1,
"concentration": {
"value": 53.5,
"unit": "µg/m³",
"unitType": 31
}
},
{
"type": "PM10",
"name": "Particulate Matter 10",
"index": 11.3,
"globalIndex": 12.2,
"concentration": {
"value": 12.2,
"unit": "µg/m³",
"unitType": 31
}
},
{
"type": "PM2.5",
"name": "Particulate Matter 2.5",
"index": 13.5,
"globalIndex": 6.5,
"concentration": {
"value": 3.2,
"unit": "µg/m³",
"unitType": 31
}
},
{
"type": "CO",
"name": "Carbon Monoxide",
"index": 1.2,
"globalIndex": 0.6,
"concentration": {
"value": 118.4,
"unit": "µg/m³",
"unitType": 31
}
},
{
"type": "SO2",
"name": "Sulfur Dioxide",
"index": 0.6,
"globalIndex": 1.1,
"concentration": {
"value": 1.1,
"unit": "µg/m³",
"unitType": 31
}
}
]
}
]
}
Определения
Имя | Описание |
---|---|
Air |
Информация о качестве воздуха в конкретном месте в определенное время. |
Air |
Этот объект возвращается в результате успешного вызова Get Air Quality. |
Dominant |
Вид загрязняющего вещества. Обратите внимание, что в любое время могут быть добавлены дополнительные данные. |
Error |
Дополнительные сведения об ошибке управления ресурсами. |
Error |
Сведения об ошибке. |
Error |
Ответ на ошибку |
Json |
Требуемый формат ответа. Поддерживается только |
Pollutant |
Подробная информация об отдельном загрязнителе. Не возвращается, если |
Pollutant |
Вид загрязняющего вещества. Обратите внимание, что в любое время могут быть добавлены дополнительные данные. |
Unit |
Числовое значение ID, связанное с типом отображаемой единицы измерения. Может использоваться для перевода единиц измерения. Дополнительные сведения см. в статье Службы погоды в Azure Maps . |
Weather |
Удельное значение данной единицы, связанное с погодой. |
AirQuality
Информация о качестве воздуха в конкретном месте в определенное время.
Имя | Тип | Описание |
---|---|---|
category |
string |
Описание качества воздуха в одном слове на запрашиваемом языке. Например, «Отлично». |
categoryColor |
string |
Уникальный цвет, соответствующий категории данного результата по качеству воздуха. |
dateTime |
string (date-time) |
Дата и время текущего наблюдения отображаются в формате ISO 8601, например, 2019-10-27T19:39:57-08:00. |
description |
string |
Текстовое объяснение этого качества воздуха на требуемом языке. |
dominantPollutant |
Загрязнитель с самой высокой концентрацией. |
|
globalIndex |
number (float) |
Международно нормализованный рейтинг качества воздуха по шкале от 0 до 300 и выше, где более высокие цифры означают худшее качество воздуха. |
index |
number (float) |
Оценка качества воздуха по шкале, установленной местными регулирующими органами. Масштабы могут сильно различаться в зависимости от местоположения. Смотрите Википедию для получения дополнительной информации. |
pollutants |
Информация об отдельных загрязнителях. |
AirQualityResult
Этот объект возвращается в результате успешного вызова Get Air Quality.
Имя | Тип | Описание |
---|---|---|
nextLink |
string |
Ссылка на следующую страницу возвращаемых функций. Если это последняя страница, это поле не отображается. |
results |
Список всех результатов по качеству воздуха для запрашиваемого местоположения. |
DominantPollutant
Вид загрязняющего вещества. Обратите внимание, что в любое время могут быть добавлены дополнительные данные.
Значение | Описание |
---|---|
Carbon Monoxide |
Окись углерода («CO») |
Nitrogen Dioxide |
Диоксид азота («NO2») |
Ozone |
Озон («O3») |
Particulate Matter 10 |
Твердые частицы 10 ("PM10") |
Particulate Matter 2.5 |
Твердые частицы 2,5 ("PM2,5") |
Sulfur Dioxide |
Диоксид серы («SO2») |
ErrorAdditionalInfo
Дополнительные сведения об ошибке управления ресурсами.
Имя | Тип | Описание |
---|---|---|
info |
object |
Дополнительные сведения. |
type |
string |
Дополнительный тип сведений. |
ErrorDetail
Сведения об ошибке.
Имя | Тип | Описание |
---|---|---|
additionalInfo |
Дополнительные сведения об ошибке. |
|
code |
string |
Код ошибки. |
details |
Сведения об ошибке. |
|
message |
string |
Сообщение об ошибке. |
target |
string |
Целевой объект ошибки. |
ErrorResponse
Ответ на ошибку
Имя | Тип | Описание |
---|---|---|
error |
Объект ошибки. |
JsonFormat
Требуемый формат ответа. Поддерживается только json
формат.
Значение | Описание |
---|---|
json |
Pollutant
Подробная информация об отдельном загрязнителе. Не возвращается, если pollutants
=false.
Имя | Тип | Описание |
---|---|---|
concentration |
Объект, содержащий количество загрязняющих частиц на объем воздуха. |
|
globalIndex |
number (float) |
Международно нормализованный рейтинг качества воздуха по шкале от 0 до 300 и выше, где более высокие цифры означают худшее качество воздуха. |
index |
number (float) |
Оценка качества воздуха по шкале, установленной местными регулирующими органами. Масштабы могут сильно различаться в зависимости от местоположения. Смотрите Википедию для получения дополнительной информации. |
name |
string |
Название загрязнителя на английском языке. |
type |
Вид загрязняющего вещества. Обратите внимание, что в любое время могут быть добавлены дополнительные данные. |
PollutantType
Вид загрязняющего вещества. Обратите внимание, что в любое время могут быть добавлены дополнительные данные.
Значение | Описание |
---|---|
CO |
Окись углерода («CO») |
NO2 |
Диоксид азота («NO2») |
O3 |
Озон («O3») |
PM10 |
Твердые частицы 10 ("PM10") |
PM2.5 |
Твердые частицы 2,5 ("PM2,5") |
SO2 |
Диоксид серы («SO2») |
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 |
миль в час |
WeatherUnit
Удельное значение данной единицы, связанное с погодой.
Имя | Тип | Описание |
---|---|---|
unit |
string |
Тип единицы измерения для возвращаемого значения. |
unitType |
Unit |
Числовое значение ID, связанное с типом отображаемой единицы измерения. Может использоваться для перевода единиц измерения. Дополнительные сведения см. в статье Службы погоды в Azure Maps . |
value |
number (float) |
Округленное значение. |