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

JsonFormat

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

api-version
query True

string

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

query
query True

number[]

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

language
query

string

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

Дополнительные сведения см. в разделе Поддерживаемые языки .

pollutants
query

boolean

Логическое значение, возвращающее подробные сведения о каждом загрязнителе. По умолчанию имеет значение True.

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

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

string

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

Ответы

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

AirQualityResult

ОК

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

Примеры

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

Определения

Имя Описание
AirQuality

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

AirQualityResult

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

DominantPollutant

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

ErrorAdditionalInfo

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

ErrorDetail

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

ErrorResponse

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

JsonFormat

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

Pollutant

Подробные сведения об отдельном загрязнителе. Не возвращается, если pollutants=false.

PollutantType

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

UnitType

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

WeatherUnit

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

AirQuality

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

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

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

pollutants

Pollutant[]

Сведения об отдельных загрязнителях.

AirQualityResult

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

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

string

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

results

AirQuality[]

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

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

Объект error.

JsonFormat

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

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

string

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

Pollutant

Подробные сведения об отдельном загрязнителе. Не возвращается, если pollutants=false.

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

WeatherUnit

Объект, содержащий количество частиц загрязнителей на объем воздуха.

globalIndex

number

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

index

number

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

name

string

Название загрязняющего вещества на английском языке.

type

PollutantType

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

PollutantType

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

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

string

Угарный газ (CO)

NO2

string

Двуокись азота ("NO2")

O3

string

Озон ("O3")

PM10

string

Твердые частицы 10 ("PM10")

PM2.5

string

Твердые частицы 2,5 ("PM2,5")

SO2

string

Двуокись серы ("SO2")

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

WeatherUnit

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

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

string

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

unitType

UnitType

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

value

number

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