Weather - Get Current Air Quality
Służy do uzyskiwania aktualnych informacji o jakości powietrza, które obejmują potencjalne zagrożenia i sugerowane środki ostrożności.
Interfejs Get Current Air Quality API to żądanie HTTP GET , które zwraca szczegółowe informacje o stężeniu zanieczyszczeń i ogólnym stanie bieżącej jakości powietrza, w tym poziomy zanieczyszczeń, wartości indeksu jakości powietrza, dominujące zanieczyszczenie oraz krótkie oświadczenie podsumowujące poziom ryzyka i sugerowane środki ostrożności.
GET {endpoint}/weather/airQuality/current/json?api-version=1.1&query={query}
GET {endpoint}/weather/airQuality/current/json?api-version=1.1&language={language}&query={query}&pollutants={pollutants}
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Nazwa hosta usługi Azure Maps. Użyj |
|
format
|
path | True |
Żądany format odpowiedzi. Obsługiwany jest tylko format |
|
|
api-version
|
query | True |
string minLength: 1 |
Wersja interfejsu API do użycia dla tej operacji. |
|
query
|
query | True |
number[] |
Odpowiednie zapytanie określone jako ciąg rozdzielony przecinkami składające się z szerokości geograficznej, po której następuje długość geograficzna, np. "47.641268,-122.125679". Informacje o pogodzie są ogólnie dostępne dla lokalizacji na lądzie, zbiorników wodnych otoczonych lądem oraz obszarów oceanu, które znajdują się w odległości około 50 mil morskich od linii brzegowej. |
|
language
|
query |
string |
Język, w którym powinny być zwracane wyniki wyszukiwania. Powinien być jednym z obsługiwanych tagów języka IETF, bez uwzględniania wielkości liter. Jeśli dane w określonym języku nie są dostępne dla określonego pola, używany jest język domyślny. Aby uzyskać szczegółowe informacje, zobacz Obsługiwane języki. |
|
|
pollutants
|
query |
boolean |
Wartość logiczna, która zwraca szczegółowe informacje o każdym zanieczyszczeniu. Domyślnie ma wartość True. |
Nagłówek żądania
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| x-ms-client-id |
string |
Wskazuje konto przeznaczone do użycia z modelem bezpieczeństwa Microsoft Entra ID. Ten unikalny identyfikator konta Azure Maps można uzyskać z API Azure Maps Account API na płaszczyźnie zarządzania. Więcej informacji na temat korzystania z Microsoft Entra ID zabezpieczeń w Azure Maps można znaleźć w Manage authentication in Azure Maps. |
Odpowiedzi
| Nazwa | Typ | Opis |
|---|---|---|
| 200 OK |
Żądanie zakończyło się pomyślnie. |
|
| Other Status Codes |
Nieoczekiwana odpowiedź na błąd. |
Zabezpieczenia
AadToken
Są to przepływy Microsoft Entra OAuth 2.0. W połączeniu z Azure zarządzaniem dostępem opartym na rolach może być używany do kontroli dostępu do Azure Maps API REST. Kontrola dostępu oparta na rolach Azure służy do wyznaczania dostępu do jednego lub więcej kont zasobów lub podzasobów Azure Maps. Każdy użytkownik, grupa lub jednostka usługi mogą mieć dostęp za pośrednictwem wbudowanej roli lub roli niestandardowej składającej się z co najmniej jednego uprawnienia do interfejsów API REST usługi Azure Maps.
Aby zaimplementować scenariusze, zalecamy wyświetlenie koncepcji uwierzytelniania . Podsumowując, ta definicja zabezpieczeń zawiera rozwiązanie do modelowania aplikacji za pośrednictwem obiektów, które mogą kontrolować dostęp do określonych interfejsów API i zakresów.
Note
- Ta definicja zabezpieczeń wymaga użycia nagłówka
x-ms-client-idw celu wskazania, do którego zasobu usługi Azure Maps aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania usługami Maps. -
Authorization URLjest specyficzna dla wystąpienia chmury publicznej platformy Azure. Suwerenne chmury mają unikalne adresy URL autoryzacji oraz konfiguracje Microsoft Entra ID. - Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana na podstawie płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST.
- Użycie zestawu Web SDK usługi Azure Maps umożliwia skonfigurowanie aplikacji na podstawie konfiguracji dla wielu przypadków użycia.
- Aby uzyskać więcej informacji na temat platformy tożsamości firmy Microsoft, zobacz Platforma tożsamości Microsoft overview.
Typ:
oauth2
Flow:
implicit
Adres URL autoryzacji:
https://login.microsoftonline.com/common/oauth2/authorize
Zakresy
| Nazwa | Opis |
|---|---|
| https://atlas.microsoft.com/.default |
subscription-key
Jest to klucz wspólny aprowizowany podczas tworzenie konta usługi Azure Maps w witrynie Azure Portal lub przy użyciu programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsu API REST.
Za pomocą tego klucza każda aplikacja może uzyskiwać dostęp do całego interfejsu API REST. Innymi słowy, ten klucz może służyć jako klucz główny na koncie, w którym są wystawiane.
W przypadku publicznie uwidocznionych aplikacji zalecamy użycie poufnych aplikacji klienckich podejście do uzyskiwania dostępu do interfejsów API REST usługi Azure Maps, aby klucz mógł być bezpiecznie przechowywany.
Typ:
apiKey
W:
header
SAS Token
Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji List SAS na zasobie usługi Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST.
Dzięki temu tokenowi każda aplikacja jest autoryzowana do uzyskiwania dostępu za pomocą kontroli dostępu opartej na rolach platformy Azure i szczegółowej kontroli wygaśnięcia, szybkości i regionów użycia dla określonego tokenu. Innymi słowy, token SAS może służyć do umożliwienia aplikacjom kontrolowania dostępu w sposób bardziej zabezpieczony niż klucz wspólny.
W przypadku publicznie uwidocznionych aplikacji zalecamy skonfigurowanie określonej listy dozwolonych źródeł w zasobie Mapowanie konta w celu ograniczenia nadużyć renderowania i regularnego odnawiania tokenu SAS.
Typ:
apiKey
W:
header
Przykłady
Get Current Air Quality
Przykładowe żądanie
GET https://atlas.microsoft.com/weather/airQuality/current/json?api-version=1.1&query=47.632346,-122.13887
Przykładowa odpowiedź
{
"results": [
{
"description": "The air quality is generally acceptable for most individuals. However, sensitive groups may experience minor to moderate symptoms from long-term exposure.",
"category": "Fair",
"categoryColor": "#FFC300",
"dateTime": "2021-07-19T02:00:00+00:00",
"dominantPollutant": "Ozone",
"globalIndex": 22.1,
"index": 21.6,
"pollutants": [
{
"name": "Nitrogen Dioxide",
"type": "NO2",
"concentration": {
"unit": "µg/m³",
"unitType": 31,
"value": 13.4
},
"globalIndex": 6.7,
"index": 6.7
},
{
"name": "Ozone",
"type": "O3",
"concentration": {
"unit": "µg/m³",
"unitType": 31,
"value": 53.5
},
"globalIndex": 22.1,
"index": 21.6
},
{
"name": "Particulate Matter 10",
"type": "PM10",
"concentration": {
"unit": "µg/m³",
"unitType": 31,
"value": 12.2
},
"globalIndex": 12.2,
"index": 11.3
},
{
"name": "Particulate Matter 2.5",
"type": "PM2.5",
"concentration": {
"unit": "µg/m³",
"unitType": 31,
"value": 3.2
},
"globalIndex": 6.5,
"index": 13.5
},
{
"name": "Carbon Monoxide",
"type": "CO",
"concentration": {
"unit": "µg/m³",
"unitType": 31,
"value": 118.4
},
"globalIndex": 0.6,
"index": 1.2
},
{
"name": "Sulfur Dioxide",
"type": "SO2",
"concentration": {
"unit": "µg/m³",
"unitType": 31,
"value": 1.1
},
"globalIndex": 1.1,
"index": 0.6
}
]
}
]
}
Definicje
| Nazwa | Opis |
|---|---|
|
Air |
Aktualny odczyt jakości powietrza w jednym miejscu zwrócił się jako wpis w |
|
Air |
Odpowiedź otrzymała operacja Get Current Air Quality, która podała aktualne warunki jakości powietrza w określonym miejscu. Tablica |
|
Dominant |
Identyfikuje zanieczyszczenie o najwyższym stężeniu. |
|
Error |
Dodatkowe informacje o błędzie zarządzania zasobami. |
|
Error |
Szczegóły błędu. |
|
Error |
Wspólna odpowiedź na błędy dla wszystkich API Azure Resource Manager zwraca szczegóły błędów dla nieudanych operacji. (Jest to również zgodne z formatem odpowiedzi na błąd OData). |
|
Json |
Żądany format odpowiedzi. Obsługiwany jest tylko format |
| Pollutant |
Pojedynczy zanieczyszczenie zmierzony w zapytanej lokalizacji zwracał jako jeden wpis w |
|
Pollutant |
Opis sześciu typów zanieczyszczeń śledzonych przez usługę pogodową Azure Maps. |
|
Unit |
Wartość całkowita przypisana do typu wyświetlanej jednostki. Na przykład 17 dla stopni Celsjusza, 18 dla stopni Fahrenheita. Może być używany do przeliczania jednostek. Więcej informacji można znaleźć w Usługi pogodowe w Azure Maps. |
|
Weather |
Wartości dla wskaźników związanych z pogodą, takich jak temperatura, punkt rosy i prędkość wiatru, przedstawione w jednostkach metrycznych lub imperialnych, zgodnie z parametrem jednostkowym URI. Więcej informacji można znaleźć w artykule Typy jednostek w artykule Weather services in Azure Maps. |
AirQuality
Aktualny odczyt jakości powietrza w jednym miejscu zwrócił się jako wpis w AirQualityResult.results. Łączy indeks jakości powietrza raportowany przez lokalny organ regulacyjny (index) z międzynarodowo znormalizowanym indeksem (globalIndex), identyfikuje czynnik dominantPollutant wyniku, a następnie łączy je z lokalnym jakościowym category wskaźnikiem oraz dopasowaniem categoryColor odpowiednim do kolorowego interfejsu. Krótka wersja description wyjaśnia, co odczyt oznacza dla codziennych czynności i wszelkich środków ostrożności zdrowotnych, a gdy żąda się szczegółów dotyczących zanieczyszczeń, tablica pollutants zawiera rozkład na poszczególne zanieczyszczenia.
| Nazwa | Typ | Opis | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| category |
string |
Krótkie, jakościowe podsumowanie aktualnej jakości powietrza, zwrócone w języku określonym w żądaniu. Typowe wartości to Dobre, Średnie, Umiarkowane, Słabe i Niebezpieczne; dokładny zestaw zależy od organu regulującego dla zapytania. |
||||||||||||||
| categoryColor |
string |
Szesnastkowy kod kolorów dopasowujący |
||||||||||||||
| dateTime |
string (date-time) |
Data i godzina pomiaru jakości powietrza dotyczą w formacie ISO 8601 (yyyy-mm-ddThh:mm:mm+hh:mm). Na przykład 2021-07-19T02:00:00+00:00. |
||||||||||||||
| description |
string |
Jedno lub dwa zdania w swobodnej formie wyjaśniające obecną jakość powietrza oraz wszelkie środki ostrożności, które powinny rozważyć grupy wrażliwe, zwrócone w języku określonym w prośbie. Na przykład jakość powietrza jest zazwyczaj akceptowalna dla większości osób. Jednak grupy wrażliwe mogą doświadczać łagodnych do umiarkowanych objawów wynikających z długotrwałej ekspozycji. |
||||||||||||||
| dominantPollutant |
Zanieczyszczenie napędza prąd |
|||||||||||||||
| globalIndex |
number (float) |
Znormalizowany wskaźnik jakości powietrza zaprojektowany tak, aby był porównywalny w różnych lokalizacjach, niezależnie od lokalnej skali AQI. Wartość ta jest najwyższym indywidualnym podindeksem wśród sześciu mierzonych zanieczyszczeń (PM2.5, PM10, NO2, SO2, CO, O3); zanieczyszczenie generujące to maksimum jest zwracane w . Zasięg i kategorie:
Na przykład, dla podindeksów CO 0,6, SO2 1,1, PM2,5 6,5, NO2 6,7, PM10 12,2, O3 22,1, |
||||||||||||||
| index |
number (float) |
Indeks jakości powietrza (AQI) na skali ustalonej przez lokalny organ regulacyjny dla zapytania. Skale AQI różnią się znacznie między krajami i regionami, więc ta sama wartość liczbowa może oznaczać różne rzeczy w różnych lokalizacjach – używaj |
||||||||||||||
| pollutants |
Szczegóły dotyczące zanieczyszczeń za ogólnym odczytem, z jednym |
AirQualityResult
Odpowiedź otrzymała operacja Get Current Air Quality, która podała aktualne warunki jakości powietrza w określonym miejscu. Tablica results zawiera pojedynczy AirQuality wpis podsumowujący lokalne i globalnie znormalizowane wskaźniki jakości powietrza, dominujący zanieczyszczenia, kategorię jakościową i pasujący kolor, krótki opis implikacji zdrowotnych oraz (na żądanie) szczegóły dotyczące poszczególnych zanieczyszczeń.
| Nazwa | Typ | Opis |
|---|---|---|
| nextLink |
string |
URL do pobrania następnej strony wyników po stronicowaniu odpowiedzi, odpowiedni do nawigacji przez zbiory wyników zbyt duże, by zwrócić je w jednym wywołaniu. Pusty, gdy nie ma już stron. |
| results |
Aktualny odczyt jakości powietrza w tym miejscu zwrócił się jako matryca jednoelementowa. Wpis podaje lokalny indeks jakości powietrza ( |
DominantPollutant
Identyfikuje zanieczyszczenie o najwyższym stężeniu.
| Wartość | Opis |
|---|---|
| Carbon Monoxide |
Tlenek węgla (CO) to bezbarwny, bezwonny i bezsmakowy gaz powstający w wyniku niepełnego spalania paliw zawierających węgiel. Typowe źródła to spaliny samochodowe, kuchenki gazowe, piece i pożary drewna. |
| Nitrogen Dioxide |
Dwutlenek azotu (NO2) jest istotnym zanieczyszczeniem atmosfery. Jest regulowany i podlega zalecanym wytycznym dotyczącym limitów określonym przez Światową Organizację Zdrowia (WHO). |
| Ozone |
Ozon (O3) jest kluczowym składnikiem fotochemicznego smogu, czyli brązowej, szkodliwej mgły otaczającej wiele dużych miast, powstałej w wyniku reakcji fotochemicznej między światłem słonecznym a niektórymi specyficznymi zanieczyszczeniami. |
| Particulate Matter 2.5 |
Cząstki 2,5 (PM2,5) to drobne cząstki o średnicach zwykle 2,5 mikrometra lub mniejszych. Te cząstki są ponad 100 razy cieńsze niż ludzki włos i mogą pozostawać zawieszone w powietrzu przez dłuższy czas. |
| Particulate Matter 10 |
Cząstki 10 (PM10) to cząstki o średnicach zazwyczaj 10 mikrometrów lub mniejszych. Cząsteczki te mogą obejmować kurz, pyłki, sadzę, dym i kropelki cieczy. |
| Sulfur Dioxide |
Dwutlenek siarki (SO2) to ciężki, bezbarwny gaz nieorganiczny o ostrym, drażniącym zapachu. Powstaje głównie w wyniku spalania paliw kopalnych w elektrowniach i obiektach przemysłowych, ale może być również emitowany ze źródeł naturalnych, takich jak wulkany. |
ErrorAdditionalInfo
Dodatkowe informacje o błędzie zarządzania zasobami.
| Nazwa | Typ | Opis |
|---|---|---|
| info |
Dodatkowe informacje. |
|
| type |
string |
Dodatkowy typ informacji. |
ErrorDetail
Szczegóły błędu.
| Nazwa | Typ | Opis |
|---|---|---|
| additionalInfo |
Dodatkowe informacje o błędzie. |
|
| code |
string |
Kod błędu. |
| details |
Szczegóły błędu. |
|
| message |
string |
Komunikat o błędzie. |
| target |
string |
Element docelowy błędu. |
ErrorResponse
Wspólna odpowiedź na błędy dla wszystkich API Azure Resource Manager zwraca szczegóły błędów dla nieudanych operacji. (Jest to również zgodne z formatem odpowiedzi na błąd OData).
| Nazwa | Typ | Opis |
|---|---|---|
| error |
Obiekt błędu. |
JsonFormat
Żądany format odpowiedzi. Obsługiwany jest tylko format json.
| Wartość | Opis |
|---|---|
| json |
Pollutant
Pojedynczy zanieczyszczenie zmierzony w zapytanej lokalizacji zwracał jako jeden wpis w AirQuality.pollutants. Każdy wpis identyfikuje zanieczyszczenie (kodem i nazwą angielską), raportuje jego pomiar concentration w powietrzu oraz podaje indywidualny wkład zanieczyszczenia do lokalnego AQI (index) i międzynarodowo znormalizowanego indeksu (globalIndex) – tych samych dwóch skal raportowanych przy ogólnym odczytie na , AirQualityale ograniczonych do tego zanieczyszczenia. Typowy odczyt jakości powietrza zawiera jeden wpis na każdy zanieczyszczenie – dwutlenek azotu, ozon, cząstki 10, cząstki 2.5, tlenek węgla i dwutlenek siarki – dzięki czemu dzwoniący mogą zobaczyć, które substancje są obecne i ile każda z nich wnosi.
| Nazwa | Typ | Opis |
|---|---|---|
| concentration |
Stężenie zanieczyszczenia w powietrzu w mikrogramach na metr sześcienny (μg/m³) dla NO2, O3, PM10, PM2,5, CO2,5 i SO2 – na przykład 53,5 μg/m³ dla ozonu lub 13,4 μg/m³ dla dwutlenku azotu – lub w częściach na milion (ppm) w przypadku raportowania w tej jednostce. Stężenie to surowa miara zasilająca i |
|
| globalIndex |
number (float) |
Wkład tego zanieczyszczenia w międzynarodowo znormalizowany indeks jakości powietrza, w tej samej skali od 0 do 300+, co taki, |
| index |
number (float) |
Wkład tego zanieczyszczenia w ogólny wskaźnik jakości powietrza (AQI) na skali ustalonej przez lokalny organ regulacyjny dla zapytania. Używa tej samej lokalnej skali co |
| name |
string |
Angielska nazwa zanieczyszczenia łączy się na przykład z |
| type |
Kod zanieczyszczający, używany jako stabilny, niezależny od języka identyfikator – jedna z |
PollutantType
Opis sześciu typów zanieczyszczeń śledzonych przez usługę pogodową Azure Maps.
| Wartość | Opis |
|---|---|
| CO |
Średnie stężenie tlenku węgla (CO) w mikrogramach na metr sześcienny (μg/m³) w ciągu ostatniej godziny. CO to bezbarwny, bezwonny i bezsmakowy gaz, powstający w wyniku niepełnego spalania paliw zawierających węgiel. Typowe źródła to spaliny samochodowe, kuchenki gazowe, piece i pożary drewna. |
| NO2 |
Średnie stężenie dwutlenku azotu (NO2) w mikrogramach na metr sześcienny (μg/m³) w ciągu ostatniej godziny. NO2 jest znaczącym zanieczyszczeniem atmosfery. Jest regulowany i podlega zalecanym wytycznym dotyczącym limitów określonym przez Światową Organizację Zdrowia (WHO). |
| O3 |
Średnie stężenie ozonu (O3) w mikrogramach na metr sześcienny (μg/m³) w ciągu ostatniej godziny. O3 jest kluczowym składnikiem fotochemicznego smogu, czyli brązowej, szkodliwej mgły otaczającej wiele dużych miast, powstałej w wyniku reakcji fotochemicznej między światłem słonecznym a konkretnymi zanieczyszczeniami. |
| PM2.5 |
Średnie stężenie cząstek o średnicy mniejszej niż 2,5 mikrona, mierzone w mikrogramach na metr sześcienny (μg/m³), w ciągu ostatniej godziny. PM2.5, znany również jako aerozole, składa się z drobnego pyłu i drobnych kropelek cieczy zawieszonych w powietrzu. |
| PM10 |
Średnie stężenie cząstek o średnicach od 2,5 do 10 mikronów, mierzone w mikrogramach na metr sześcienny (μg/m³) w ciągu ostatniej godziny. Cząstki 10 (PM10), znane również jako aerozole, składają się z drobnego pyłu i drobnych kropelek cieczy zawieszonych w powietrzu. |
| SO2 |
Średnie stężenie dwutlenku siarki (SO2) w mikrogramach na metr sześcienny (μg/m³) w ciągu ostatniej godziny. SO2 to gęsty, bezbarwny gaz nieorganiczny o ostrym, drażniącym zapachu. Jest przede wszystkim produkowany przez spalanie paliw kopalnych w elektrowniach i zakładach przemysłowych, ale może być także emitowany ze źródeł naturalnych, takich jak wulkany. |
UnitType
Wartość całkowita przypisana do typu wyświetlanej jednostki. Na przykład 17 dla stopni Celsjusza, 18 dla stopni Fahrenheita. Może być używany do przeliczania jednostek. Więcej informacji można znaleźć w Usługi pogodowe w Azure Maps.
| Wartość | Opis |
|---|---|
| 0 |
feet |
| 1 |
inches |
| 2 |
miles |
| 3 |
millimeter |
| 4 |
centimeter |
| 5 |
miernik |
| 6 |
kilometer |
| 7 |
kilometersPerHour |
| 8 |
knots |
| 9 |
milesPerHour |
| 10 |
metersPerSecond |
| 11 |
hectoPascals |
| 12 |
inchesOfMercury |
| 13 |
kiloPascals |
| 14 |
millibars |
| 15 |
millimetersOfMercury |
| 16 |
poundsPerSquareInch |
| 17 |
Stopnie Celsjusza |
| 18 |
Fahrenheit |
| 19 |
kelvin |
| 20 |
percent |
| 21 |
float |
| 22 |
liczba całkowita |
| 31 |
MicrogramsPerCubicMeterOfAir |
WeatherValue
Wartości dla wskaźników związanych z pogodą, takich jak temperatura, punkt rosy i prędkość wiatru, przedstawione w jednostkach metrycznych lub imperialnych, zgodnie z parametrem jednostkowym URI. Więcej informacji można znaleźć w artykule Typy jednostek w artykule Weather services in Azure Maps.
| Nazwa | Typ | Opis |
|---|---|---|
| unit |
string |
Jednostka miary używana w wartości zwrotu, taka jak "C" dla Celsjusza, "F" dla Fahrenheita. |
| unitType |
Liczba całkowita reprezentująca typ jednostki. Na przykład 0 dla stóp, 1 dla cali, 2 dla mil. Pełną listę można znaleźć w artykule Typy jednostek w artykule Weather services in Azure Maps. |
|
| value |
number (float) |
Wartość zmierzona wyrażona w określonej jednostce. |